From bdf5c1e9604b5966d13dfa63da86ae5a0f8d4d92 Mon Sep 17 00:00:00 2001 From: FlightControl_Master Date: Fri, 27 Oct 2017 07:00:40 +0200 Subject: [PATCH] Documentation --- Moose Development/Moose/Wrapper/Airbase.lua | 25 +++++++++++++++++++++ docs/Documentation/AI_Patrol.html | 3 +++ docs/Documentation/Cargo.html | 1 + docs/Documentation/Movement.html | 4 ++++ docs/Documentation/Settings.html | 2 +- docs/Documentation/Spawn.html | 8 ++++++- docs/Documentation/Task_Cargo.html | 5 +++-- docs/Documentation/ZoneGoal.html | 4 ---- docs/README.md | 13 +++++++---- 9 files changed, 53 insertions(+), 12 deletions(-) diff --git a/Moose Development/Moose/Wrapper/Airbase.lua b/Moose Development/Moose/Wrapper/Airbase.lua index d34ac6a85..ba2af2050 100644 --- a/Moose Development/Moose/Wrapper/Airbase.lua +++ b/Moose Development/Moose/Wrapper/Airbase.lua @@ -58,6 +58,31 @@ AIRBASE = { } --- @field Caucasus +-- +-- These are the airbase names that can be specified with AIRBASE.Caucasus: +-- +-- * AIRBASE.Caucasus.Gelendzhik +-- * AIRBASE.Caucasus.Krasnodar_Pashkovsky +-- * AIRBASE.Caucasus.Sukhumi_Babushara +-- * AIRBASE.Caucasus.Gudauta +-- * AIRBASE.Caucasus.Batumi +-- * AIRBASE.Caucasus.Senaki_Kolkhi +-- * AIRBASE.Caucasus.Kobuleti +-- * AIRBASE.Caucasus.Kutaisi +-- * AIRBASE.Caucasus.Tbilisi_Lochini +-- * AIRBASE.Caucasus.Soganlug +-- * AIRBASE.Caucasus.Vaziani +-- * AIRBASE.Caucasus.Anapa_Vityazevo +-- * AIRBASE.Caucasus.Krasnodar_Center +-- * AIRBASE.Caucasus.Novorossiysk +-- * AIRBASE.Caucasus.Krymsk +-- * AIRBASE.Caucasus.Maykop_Khanskaya +-- * AIRBASE.Caucasus.Sochi_Adler +-- * AIRBASE.Caucasus.Mineralnye_Vody +-- * AIRBASE.Caucasus.Nalchik +-- * AIRBASE.Caucasus.Mozdok +-- * AIRBASE.Caucasus.Beslan +-- AIRBASE.Caucasus = { ["Gelendzhik"] = "Gelendzhik", ["Krasnodar_Pashkovsky"] = "Krasnodar-Pashkovsky", diff --git a/docs/Documentation/AI_Patrol.html b/docs/Documentation/AI_Patrol.html index 004acc069..45a2143e2 100644 --- a/docs/Documentation/AI_Patrol.html +++ b/docs/Documentation/AI_Patrol.html @@ -936,6 +936,9 @@ Use the method AIPATROLZONE.M + +

This table contains the targets detected during patrol.

+
diff --git a/docs/Documentation/Cargo.html b/docs/Documentation/Cargo.html index f5bf973b2..b937e23ad 100644 --- a/docs/Documentation/Cargo.html +++ b/docs/Documentation/Cargo.html @@ -2269,6 +2269,7 @@ The amount of seconds to delay the action.

+ CARGO_CRATE.CargoCarrier diff --git a/docs/Documentation/Movement.html b/docs/Documentation/Movement.html index 8126af2b9..0615a2d0a 100644 --- a/docs/Documentation/Movement.html +++ b/docs/Documentation/Movement.html @@ -237,6 +237,7 @@ on defined intervals (currently every minute).

+ #number MOVEMENT.AliveUnits @@ -245,6 +246,9 @@ on defined intervals (currently every minute).

+ +

Contains the counter how many units are currently alive

+
diff --git a/docs/Documentation/Settings.html b/docs/Documentation/Settings.html index 159a358e6..9b4a8bcab 100644 --- a/docs/Documentation/Settings.html +++ b/docs/Documentation/Settings.html @@ -1250,7 +1250,7 @@ true if metric.

- #boolean + SETTINGS.Metric diff --git a/docs/Documentation/Spawn.html b/docs/Documentation/Spawn.html index afcd0739c..531258788 100644 --- a/docs/Documentation/Spawn.html +++ b/docs/Documentation/Spawn.html @@ -2314,6 +2314,9 @@ The group that was spawned. You can use this group for further actions.

+ +

Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.

+
@@ -2989,6 +2992,9 @@ when nothing was spawned.

+ +

Overwrite unit names by default with group name.

+
@@ -3410,7 +3416,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 ) -

When the first Spawn executes, all the Groups need to be made visible before start.

+

Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.

diff --git a/docs/Documentation/Task_Cargo.html b/docs/Documentation/Task_Cargo.html index 119956c02..370a1360b 100644 --- a/docs/Documentation/Task_Cargo.html +++ b/docs/Documentation/Task_Cargo.html @@ -562,7 +562,7 @@ based on the tasking capabilities defined in Task#TA
- Core.Cargo#CARGO + Core.Cargo#CARGO_GROUP FSM_PROCESS.Cargo @@ -576,6 +576,7 @@ based on the tasking capabilities defined in Task#TA
+ FSM_PROCESS.DeployZone @@ -640,7 +641,7 @@ based on the tasking capabilities defined in Task#TA
- + #number TASK_CARGO.CargoLimit diff --git a/docs/Documentation/ZoneGoal.html b/docs/Documentation/ZoneGoal.html index cd85537f6..8120d650d 100644 --- a/docs/Documentation/ZoneGoal.html +++ b/docs/Documentation/ZoneGoal.html @@ -489,7 +489,6 @@ The name of the player.

- ZONE_GOAL.SmokeTime @@ -498,9 +497,6 @@ The name of the player.

- -

self.SmokeColor = nil

-
diff --git a/docs/README.md b/docs/README.md index 8ed35a606..8fa3218bf 100644 --- a/docs/README.md +++ b/docs/README.md @@ -100,8 +100,6 @@ These AI Controlling Classes are based on FSM (Finite State Machine) Classes, an MOOSE Functional Classes provide various functions that are useful in mission design. -* [SPAWN](Documentation/Spawn.html): Spawn new groups (and units) during mission execution. - * [ESCORT](Documentation/Escort.html): Makes groups consisting of helicopters, airplanes, ground troops or ships within a mission joining your flight. You can control these groups through the ratio menu during your flight. Available commands are around: Navigation, Position Hold, Reporting (Target Detection), Attacking, Assisted Attacks, ROE, Evasion, Mission Execution and more ... * [MISSILETRAINER](Documentation/MissileTrainer.html): Missile trainer, it destroys missiles when they are within a certain range of player airplanes, displays tracking and alert messages of missile launches; approach; destruction, and configure with radio menu commands. Various APIs available to configure the trainer. @@ -120,6 +118,11 @@ MOOSE Functional Classes provide various functions that are useful in mission de * [RAT](Documentation/Rat.html): Random Air Traffic engine developed by FunkyFranky, use the available airspace! +* [ATC_GROUND](Documentation/ATC_Ground.html): Monitor players on the airbase and make them behave and provide instructions. + * [ATC_GROUND](Documentation/ATC_Ground.html#ATC_GROUND_CAUCASUS): ATC Ground operations for Caucasus. + * [ATC_GROUND](Documentation/ATC_Ground.html#ATC_GROUND_NEVADA): ATC Ground operations for Nevada. + * [ATC_GROUND](Documentation/ATC_Ground.html#ATC_GROUND_NORMANDY): ATC Ground operations for Normandy. + ## 2.4. MOOSE Wrapper Classes MOOSE Wrapper Classes provide an object oriented hierarchical mechanism to manage the DCS objects within the simulator. @@ -156,6 +159,10 @@ These classes define the base building blocks of the MOOSE framework. These clas * [SCHEDULER](Documentation/Scheduler.html): This class implements a timer scheduler that will call at optional specified intervals repeatedly or just one time a scheduled function. +* [SPAWN](Documentation/Spawn.html#SPAWN): Spawn new groups (and units) during mission execution. + +* [SPAWNSTATIC](Documentation/SpawnStatic.html#SPAWNSTATIC): Spawn Static objects using a predefined "template". + * [Finite State Machines](Documentation/Fsm.html): Finite State Machine provides a process management or state machine capability for various scenarios. * [FSM](Documentation/Fsm.html#FSM): The main FSM class can be used to build a generic Finite State Machine. * [FSM\_CONTROLLABLE](Documentation/Fsm.html#FSM_CONTROLLABLE): An FSM class to control a Controllable. A controllable is a group or unit that can be controlled. @@ -190,8 +197,6 @@ These classes define the base building blocks of the MOOSE framework. These clas * [CARGO](Documentation/Cargo.html): Manage Cargo in the simulation. * [CARGO\_GROUP](Documentation/Cargo.html#CARGO_GROUP): Manage Cargo that is defined as a GROUP object within the simulation. -* [SPAWNSTATIC](Documentation/SpawnStatic.html#SPAWNSTATIC): Spawn Static objects using a predefined "template". - * [BEACON](Documentation/Radio.html): Create beacons. * [RADIO](Documentation/Radio.html): Create radio communication.