From 2f8b881186872f3f32e6fd219cb72348449811ae Mon Sep 17 00:00:00 2001 From: FlightControl Date: Wed, 14 Jun 2017 11:17:20 +0200 Subject: [PATCH] Documentation --- .../Moose/AI/AI_A2A_Dispatcher.lua | 37 +++++++++++++++++ docs/Documentation/AI_A2A_Dispatcher.html | 41 +++++++++++++++++++ docs/Documentation/AI_Patrol.html | 3 ++ docs/Documentation/Cargo.html | 1 - docs/Documentation/Detection.html | 1 - docs/Documentation/Movement.html | 4 -- docs/Documentation/Point.html | 1 + docs/Documentation/SpawnStatic.html | 1 + docs/Documentation/Task_Cargo.html | 3 +- 9 files changed, 85 insertions(+), 7 deletions(-) diff --git a/Moose Development/Moose/AI/AI_A2A_Dispatcher.lua b/Moose Development/Moose/AI/AI_A2A_Dispatcher.lua index 14aea951f..d078de903 100644 --- a/Moose Development/Moose/AI/AI_A2A_Dispatcher.lua +++ b/Moose Development/Moose/AI/AI_A2A_Dispatcher.lua @@ -958,6 +958,21 @@ do -- AI_A2A_DISPATCHER -- @param #number EngageMaxSpeed The maximum speed at which the engage can be executed. -- @param #number AltType The altitude type, which is a string "BARO" defining Barometric or "RADIO" defining radio controlled altitude. -- @return #AI_A2A_DISPATCHER + -- @usage + -- + -- -- CAP Squadron execution. + -- CAPZoneEast = ZONE_POLYGON:New( "CAP Zone East", GROUP:FindByName( "CAP Zone East" ) ) + -- A2ADispatcher:SetSquadronCap( "Mineralnye", CAPZoneEast, 4000, 10000, 500, 600, 800, 900 ) + -- A2ADispatcher:SetSquadronCapInterval( "Mineralnye", 2, 30, 60, 1 ) + -- + -- CAPZoneWest = ZONE_POLYGON:New( "CAP Zone West", GROUP:FindByName( "CAP Zone West" ) ) + -- A2ADispatcher:SetSquadronCap( "Sochi", CAPZoneWest, 4000, 8000, 600, 800, 800, 1200, "BARO" ) + -- A2ADispatcher:SetSquadronCapInterval( "Sochi", 2, 30, 120, 1 ) + -- + -- CAPZoneMiddle = ZONE:New( "CAP Zone Middle") + -- A2ADispatcher:SetSquadronCap( "Maykop", CAPZoneMiddle, 4000, 8000, 600, 800, 800, 1200, "RADIO" ) + -- A2ADispatcher:SetSquadronCapInterval( "Sochi", 2, 30, 120, 1 ) + -- function AI_A2A_DISPATCHER:SetSquadronCap( SquadronName, Zone, FloorAltitude, CeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, EngageMinSpeed, EngageMaxSpeed, AltType ) self.DefenderSquadrons[SquadronName] = self.DefenderSquadrons[SquadronName] or {} @@ -985,6 +1000,21 @@ do -- AI_A2A_DISPATCHER -- @param #AI_A2A_DISPATCHER self -- @param #string SquadronName The squadron name. -- @return #AI_A2A_DISPATCHER + -- @usage + -- + -- -- CAP Squadron execution. + -- CAPZoneEast = ZONE_POLYGON:New( "CAP Zone East", GROUP:FindByName( "CAP Zone East" ) ) + -- A2ADispatcher:SetSquadronCap( "Mineralnye", CAPZoneEast, 4000, 10000, 500, 600, 800, 900 ) + -- A2ADispatcher:SetSquadronCapInterval( "Mineralnye", 2, 30, 60, 1 ) + -- + -- CAPZoneWest = ZONE_POLYGON:New( "CAP Zone West", GROUP:FindByName( "CAP Zone West" ) ) + -- A2ADispatcher:SetSquadronCap( "Sochi", CAPZoneWest, 4000, 8000, 600, 800, 800, 1200, "BARO" ) + -- A2ADispatcher:SetSquadronCapInterval( "Sochi", 2, 30, 120, 1 ) + -- + -- CAPZoneMiddle = ZONE:New( "CAP Zone Middle") + -- A2ADispatcher:SetSquadronCap( "Maykop", CAPZoneMiddle, 4000, 8000, 600, 800, 800, 1200, "RADIO" ) + -- A2ADispatcher:SetSquadronCapInterval( "Sochi", 2, 30, 120, 1 ) + -- function AI_A2A_DISPATCHER:SetSquadronCapInterval( SquadronName, CapLimit, LowInterval, HighInterval, Probability ) self.DefenderSquadrons[SquadronName] = self.DefenderSquadrons[SquadronName] or {} @@ -1085,6 +1115,13 @@ do -- AI_A2A_DISPATCHER -- @param #string SquadronName The squadron name. -- @param #number EngageMinSpeed The minimum speed at which the gci can be executed. -- @param #number EngageMaxSpeed The maximum speed at which the gci can be executed. + -- @usage + -- + -- -- GCI Squadron execution. + -- A2ADispatcher:SetSquadronGci( "Mozdok", 900, 1200 ) + -- A2ADispatcher:SetSquadronGci( "Novo", 900, 2100 ) + -- A2ADispatcher:SetSquadronGci( "Maykop", 900, 1200 ) + -- -- @return #AI_A2A_DISPATCHER function AI_A2A_DISPATCHER:SetSquadronGci( SquadronName, EngageMinSpeed, EngageMaxSpeed ) diff --git a/docs/Documentation/AI_A2A_Dispatcher.html b/docs/Documentation/AI_A2A_Dispatcher.html index 62c2c7011..3694b3389 100644 --- a/docs/Documentation/AI_A2A_Dispatcher.html +++ b/docs/Documentation/AI_A2A_Dispatcher.html @@ -2558,6 +2558,22 @@ The altitude type, which is a string "BARO" defining Barometric or "RADIO" defin

#AIA2ADISPATCHER:

+

Usage:

+ 

+       -- CAP Squadron execution.
+       CAPZoneEast = ZONE_POLYGON:New( "CAP Zone East", GROUP:FindByName( "CAP Zone East" ) )
+       A2ADispatcher:SetSquadronCap( "Mineralnye", CAPZoneEast, 4000, 10000, 500, 600, 800, 900 )
+       A2ADispatcher:SetSquadronCapInterval( "Mineralnye", 2, 30, 60, 1 )
+       
+       CAPZoneWest = ZONE_POLYGON:New( "CAP Zone West", GROUP:FindByName( "CAP Zone West" ) )
+       A2ADispatcher:SetSquadronCap( "Sochi", CAPZoneWest, 4000, 8000, 600, 800, 800, 1200, "BARO" )
+       A2ADispatcher:SetSquadronCapInterval( "Sochi", 2, 30, 120, 1 )
+       
+       CAPZoneMiddle = ZONE:New( "CAP Zone Middle")
+       A2ADispatcher:SetSquadronCap( "Maykop", CAPZoneMiddle, 4000, 8000, 600, 800, 800, 1200, "RADIO" )
+       A2ADispatcher:SetSquadronCapInterval( "Sochi", 2, 30, 120, 1 )
+
+
@@ -2605,6 +2621,22 @@ The squadron name.

#AIA2ADISPATCHER:

+

Usage:

+ 

+       -- CAP Squadron execution.
+       CAPZoneEast = ZONE_POLYGON:New( "CAP Zone East", GROUP:FindByName( "CAP Zone East" ) )
+       A2ADispatcher:SetSquadronCap( "Mineralnye", CAPZoneEast, 4000, 10000, 500, 600, 800, 900 )
+       A2ADispatcher:SetSquadronCapInterval( "Mineralnye", 2, 30, 60, 1 )
+       
+       CAPZoneWest = ZONE_POLYGON:New( "CAP Zone West", GROUP:FindByName( "CAP Zone West" ) )
+       A2ADispatcher:SetSquadronCap( "Sochi", CAPZoneWest, 4000, 8000, 600, 800, 800, 1200, "BARO" )
+       A2ADispatcher:SetSquadronCapInterval( "Sochi", 2, 30, 120, 1 )
+       
+       CAPZoneMiddle = ZONE:New( "CAP Zone Middle")
+       A2ADispatcher:SetSquadronCap( "Maykop", CAPZoneMiddle, 4000, 8000, 600, 800, 800, 1200, "RADIO" )
+       A2ADispatcher:SetSquadronCapInterval( "Sochi", 2, 30, 120, 1 )
+
+
@@ -2644,6 +2676,15 @@ The maximum speed at which the gci can be executed.

#AIA2ADISPATCHER:

+

Usage:

+ 

+
+       -- GCI Squadron execution.
+       A2ADispatcher:SetSquadronGci( "Mozdok", 900, 1200 )
+       A2ADispatcher:SetSquadronGci( "Novo", 900, 2100 )
+       A2ADispatcher:SetSquadronGci( "Maykop", 900, 1200 )
+
+
diff --git a/docs/Documentation/AI_Patrol.html b/docs/Documentation/AI_Patrol.html index 93a9f8ce6..43392b308 100644 --- a/docs/Documentation/AI_Patrol.html +++ b/docs/Documentation/AI_Patrol.html @@ -926,6 +926,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 0f74ec2a0..262969991 100644 --- a/docs/Documentation/Cargo.html +++ b/docs/Documentation/Cargo.html @@ -2934,7 +2934,6 @@ The range till cargo will board.

- CARGO_UNIT.CargoCarrier diff --git a/docs/Documentation/Detection.html b/docs/Documentation/Detection.html index 254e68018..6e5b46606 100644 --- a/docs/Documentation/Detection.html +++ b/docs/Documentation/Detection.html @@ -2387,7 +2387,6 @@ The index of the DetectedItem.

- #number DETECTION_BASE.DetectedItemCount diff --git a/docs/Documentation/Movement.html b/docs/Documentation/Movement.html index be5ce073c..4307c3aaa 100644 --- a/docs/Documentation/Movement.html +++ b/docs/Documentation/Movement.html @@ -227,7 +227,6 @@ on defined intervals (currently every minute).

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

- -

Contains the counter how many units are currently alive

-
diff --git a/docs/Documentation/Point.html b/docs/Documentation/Point.html index f204d56d9..74e7fcb9a 100644 --- a/docs/Documentation/Point.html +++ b/docs/Documentation/Point.html @@ -2799,6 +2799,7 @@ The y coordinate.

+ POINT_VEC2.z diff --git a/docs/Documentation/SpawnStatic.html b/docs/Documentation/SpawnStatic.html index bc91b9624..d8aa5e633 100644 --- a/docs/Documentation/SpawnStatic.html +++ b/docs/Documentation/SpawnStatic.html @@ -436,6 +436,7 @@ ptional) The name of the new static.

+ #number SPAWNSTATIC.SpawnIndex diff --git a/docs/Documentation/Task_Cargo.html b/docs/Documentation/Task_Cargo.html index 463fdae49..1c2148207 100644 --- a/docs/Documentation/Task_Cargo.html +++ b/docs/Documentation/Task_Cargo.html @@ -510,7 +510,7 @@ based on the tasking capabilities defined in Task#TA
- Core.Cargo#CARGO + FSM_PROCESS.Cargo @@ -524,6 +524,7 @@ based on the tasking capabilities defined in Task#TA
+ FSM_PROCESS.DeployZone