From a2630670c0d2b10f29cf562a9814b64b6508ca53 Mon Sep 17 00:00:00 2001 From: FlightControl_Master Date: Mon, 24 Jul 2017 17:42:00 +0200 Subject: [PATCH] Docs --- .../Moose/AI/AI_A2A_Dispatcher.lua | 41 ++++++++++++----- docs/Documentation/AI_A2A_Dispatcher.html | 46 +++++++++++++------ docs/Documentation/Cargo.html | 1 - docs/Documentation/Fsm.html | 3 +- docs/Documentation/Point.html | 1 - docs/Documentation/Positionable.html | 1 - docs/Documentation/Spawn.html | 7 +-- docs/Usage_Guide.md | 8 +++- 8 files changed, 73 insertions(+), 35 deletions(-) diff --git a/Moose Development/Moose/AI/AI_A2A_Dispatcher.lua b/Moose Development/Moose/AI/AI_A2A_Dispatcher.lua index 99fa39a27..ad5834458 100644 --- a/Moose Development/Moose/AI/AI_A2A_Dispatcher.lua +++ b/Moose Development/Moose/AI/AI_A2A_Dispatcher.lua @@ -2115,9 +2115,11 @@ do -- -- # Demo Missions -- - -- ### [AI\_A2A\_GCICAP for mission designers](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/release-2-2-pre/AID%20-%20AI%20Dispatching/AID-200%20-%20AI_A2A%20-%20GCICAP%20Demonstration) + -- ### [AI\_A2A\_GCICAP for Caucasus](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/release-2-2-pre/AID%20-%20AI%20Dispatching/AID-200%20-%20AI_A2A%20-%20GCICAP%20Demonstration) + -- ### [AI\_A2A\_GCICAP for NTTR](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/release-2-2-pre/AID%20-%20AI%20Dispatching/AID-210%20-%20NTTR%20AI_A2A_GCICAP%20Demonstration) + -- ### [AI\_A2A\_GCICAP for Normandy](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/release-2-2-pre/AID%20-%20AI%20Dispatching/AID-220%20-%20NORMANDY%20AI_A2A_GCICAP%20Demonstration) -- - -- ### [AI\_A2A\_GCICAP for beta testers](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AID%20-%20AI%20Dispatching/AID-200%20-%20AI_A2A%20-%20GCICAP%20Demonstration) + -- ### [AI\_A2A\_GCICAP for beta testers](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AID%20-%20AI%20Dispatching) -- -- ==== -- @@ -2322,25 +2324,40 @@ do -- -- This is a good implementation, because maybe in the future, more coalitions may become available in DCS world. -- - -- ## 4) Coding example how to use the AI\_A2A\_GCICAP class: + -- ## 4) Coding examples how to use the AI\_A2A\_GCICAP class: + -- + -- ### 4.1) An easy setup: -- -- -- Setup the AI_A2A_GCICAP dispatcher for one coalition, and initialize it. -- GCI_Red = AI_A2A_GCICAP:New( "EWR CCCP", "SQUADRON CCCP", "CAP CCCP", 2 ) - -- - -- This will create a GCI/CAP system for the RED coalition, and stores the reference to the GCI/CAP system in the `GCI\_Red` variable! - -- In the mission editor, the following setup will have taken place: - -- - -- ![Banner Image](..\Presentations\AI_A2A_DISPATCHER\Dia5.JPG) - -- + -- -- -- The following parameters were given to the :New method of AI_A2A_GCICAP, and mean the following: -- - -- * `EWR CCCP`: Groups of the RED coalition are placed that define the EWR network. These groups start with the name `EWR CCCP`. - -- * `SQUADRON CCCP`: Late activated Groups objects of the RED coalition are placed above the relevant airbases that will contain these templates in the squadron. + -- * `"EWR CCCP"`: Groups of the blue coalition are placed that define the EWR network. These groups start with the name `EWR CCCP`. + -- * `"SQUADRON CCCP"`: Late activated Groups objects of the red coalition are placed above the relevant airbases that will contain these templates in the squadron. -- These late activated Groups start with the name `SQUADRON CCCP`. Each Group object contains only one Unit, and defines the weapon payload, skin and skill level. - -- * `CAP CCCP`: CAP Zones are defined using floating, late activated Helicopter Group objects, where the route points define the route of the polygon of the CAP Zone. + -- * `"CAP CCCP"`: CAP Zones are defined using floating, late activated Helicopter Group objects, where the route points define the route of the polygon of the CAP Zone. -- These Helicopter Group objects start with the name `CAP CCCP`, and will be the locations wherein CAP will be performed. -- * `2` Defines how many CAP airplanes are patrolling in each CAP zone defined simulateneously. -- + -- + -- ### 4.2) A more advanced setup: + -- + -- -- Setup the AI_A2A_GCICAP dispatcher for the blue coalition. + -- + -- A2A_GCICAP_Blue = AI_A2A_GCICAP:New( { "BLUE EWR" }, { "104th", "105th", "106th" }, { "104th CAP" }, 4 ) + -- + -- The following parameters for the :New method have the following meaning: + -- + -- * `{ "BLUE EWR" }`: An array of the group name prefixes of the groups of the blue coalition are placed that define the EWR network. These groups start with the name `BLUE EWR`. + -- * `{ "104th", "105th", "106th" } `: An array of the group name prefixes of the Late activated Groups objects of the blue coalition are + -- placed above the relevant airbases that will contain these templates in the squadron. + -- These late activated Groups start with the name `104th` or `105th` or `106th`. + -- * `{ "104th CAP" }`: An array of the names of the CAP zones are defined using floating, late activated helicopter group objects, + -- where the route points define the route of the polygon of the CAP Zone. + -- These Helicopter Group objects start with the name `104th CAP`, and will be the locations wherein CAP will be performed. + -- * `4` Defines how many CAP airplanes are patrolling in each CAP zone defined simulateneously. + -- -- @field #AI_A2A_GCICAP AI_A2A_GCICAP = { ClassName = "AI_A2A_GCICAP", diff --git a/docs/Documentation/AI_A2A_Dispatcher.html b/docs/Documentation/AI_A2A_Dispatcher.html index 4ff5cdc7e..6abf8452d 100644 --- a/docs/Documentation/AI_A2A_Dispatcher.html +++ b/docs/Documentation/AI_A2A_Dispatcher.html @@ -1202,9 +1202,11 @@ Therefore if F4s are wanted as a coalition’s CAP or GCI aircraft Germany will

Demo Missions

-

AI_A2A_GCICAP for mission designers

+

AI_A2A_GCICAP for Caucasus

+

AI_A2A_GCICAP for NTTR

+

AI_A2A_GCICAP for Normandy

-

AI_A2A_GCICAP for beta testers

+

AI_A2A_GCICAP for beta testers

@@ -1423,29 +1425,47 @@ Each defense system needs its own EWR network setup, airplane templates and CAP

This is a good implementation, because maybe in the future, more coalitions may become available in DCS world.

-

4) Coding example how to use the AI_A2A_GCICAP class:

+

4) Coding examples how to use the AI_A2A_GCICAP class:

+ +

4.1) An easy setup:

 -- Setup the AI_A2A_GCICAP dispatcher for one coalition, and initialize it.
  GCI_Red = AI_A2A_GCICAP:New( "EWR CCCP", "SQUADRON CCCP", "CAP CCCP", 2 )
- -

This will create a GCI/CAP system for the RED coalition, and stores the reference to the GCI/CAP system in the GCI\_Red variable! -In the mission editor, the following setup will have taken place:

- -

Banner Image

- -

The following parameters were given to the :New method of AIA2AGCICAP, and mean the following:

+

-- +The following parameters were given to the :New method of AIA2AGCICAP, and mean the following:

+

4.2) A more advanced setup:

+ +
 -- Setup the AI_A2A_GCICAP dispatcher for the blue coalition.
+
+ A2A_GCICAP_Blue = AI_A2A_GCICAP:New( { "BLUE EWR" }, { "104th", "105th", "106th" }, { "104th CAP" }, 4 ) 
+
+ +

The following parameters for the :New method have the following meaning:

+ + + +

Type AI_A2A_Dispatcher

diff --git a/docs/Documentation/Cargo.html b/docs/Documentation/Cargo.html index a11fd4dba..9f6098452 100644 --- a/docs/Documentation/Cargo.html +++ b/docs/Documentation/Cargo.html @@ -3417,7 +3417,6 @@ The range till cargo will board.

- CARGO_UNIT.CargoCarrier diff --git a/docs/Documentation/Fsm.html b/docs/Documentation/Fsm.html index 177f34281..e0276d335 100644 --- a/docs/Documentation/Fsm.html +++ b/docs/Documentation/Fsm.html @@ -1598,7 +1598,7 @@ A string defining the start state.

- #string + FSM._StartState @@ -1897,6 +1897,7 @@ A string defining the start state.

+ FSM.current diff --git a/docs/Documentation/Point.html b/docs/Documentation/Point.html index f561df108..864921e2a 100644 --- a/docs/Documentation/Point.html +++ b/docs/Documentation/Point.html @@ -2829,7 +2829,6 @@ The y coordinate.

- POINT_VEC2.z diff --git a/docs/Documentation/Positionable.html b/docs/Documentation/Positionable.html index 82d94f58f..78befb2bf 100644 --- a/docs/Documentation/Positionable.html +++ b/docs/Documentation/Positionable.html @@ -1838,7 +1838,6 @@ self

- Core.Spot#SPOT POSITIONABLE.Spot diff --git a/docs/Documentation/Spawn.html b/docs/Documentation/Spawn.html index 0f27003d1..6c440cb38 100644 --- a/docs/Documentation/Spawn.html +++ b/docs/Documentation/Spawn.html @@ -2746,9 +2746,6 @@ when nothing was spawned.

- -

By default, no InitLimit

-
@@ -2784,7 +2781,7 @@ when nothing was spawned.

- #number + SPAWN.SpawnMaxGroups @@ -2801,7 +2798,7 @@ when nothing was spawned.

- #number + SPAWN.SpawnMaxUnitsAlive diff --git a/docs/Usage_Guide.md b/docs/Usage_Guide.md index 5e936f4f3..dba4e3368 100644 --- a/docs/Usage_Guide.md +++ b/docs/Usage_Guide.md @@ -11,15 +11,21 @@ It is free for download and usage, since it is released under the GNU 3.0 open s Although the MOOSE contributors and tester are using the GitHub service to enforces a structured approval process, release and change management, and a communicative distribution and deployment, you, as a mission designer, don't need to mess with it. Still, if you are interrested intesting the latest features of MOOSE of in adding your own, you can read the [relevant](http://flightcontrol-master.github.io/MOOSE/Beta_Test_Guide.html) [guides](http://flightcontrol-master.github.io/MOOSE/Contribution_Guide.html) and/or contact FlightControl The MOOSE framework development is an open source project, and as such, contributors are welcome and encouraged to contribute on the development.Some key users have already started with this process. +## 1.2) MOOSE using a normal editor + +You can use the MOOSE framework with a normal editor. This is perfectly okay. +But you won't have IntelliSense enabled, which allows you to quickly search for the correct methods per class. ## 1.2) Eclipse LDT -MOOSE utilizes the Eclipse Lua Development Tools. As a result, the MOOSE framework is documented using the luadocumentor standard. +The LDT environment or "Eclipse Lua Development Tools" is a fully integrated development environment for LUA developers. +It is recommended to use the LDT as your mission design editor using MOOSE. The MOOSE framework is documented using the luadocumentor standard. Every class, method and variable is documented within the source, and mission designers can write mission script lua code that is **intellisense**(-ed) ... What that means is that while you are coding your mission, your object and variables (derived from MOOSE classes) will list the methods and properties of that class interactively while coding ... ![Intellisense](Usage/Intellisense.JPG) +This highly increases the quality and the speed of your scripting. ## 1.3) LUA training