Documentation

2025-10-29 16:58:06 +00:00 · 2017-06-14 11:17:20 +02:00 · 2017-06-14 11:17:20 +02:00 · 2f8b881186
commit 2f8b881186
parent 385dba63d9
9 changed files with 85 additions and 7 deletions
--- a/Development/Moose/AI/AI_A2A_Dispatcher.lua
+++ b/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 )
  
--- 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
 <p><em><a href="##(AI_A2A_DISPATCHER)">#AI<em>A2A</em>DISPATCHER</a>:</em></p>


+			<h3>Usage:</h3>
+		<pre class="example"><code>
+       -- 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 )
+</code></pre>
+
 </dd>
 </dl>
 		<dl class="function">
@ -2605,6 +2621,22 @@ The squadron name.</p>
 <p><em><a href="##(AI_A2A_DISPATCHER)">#AI<em>A2A</em>DISPATCHER</a>:</em></p>


+			<h3>Usage:</h3>
+		<pre class="example"><code>
+       -- 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 )
+</code></pre>
+
 </dd>
 </dl>
 		<dl class="function">
@ -2644,6 +2676,15 @@ The maximum speed at which the gci can be executed.</p>
 <p><em><a href="##(AI_A2A_DISPATCHER)">#AI<em>A2A</em>DISPATCHER</a>:</em></p>


+			<h3>Usage:</h3>
+		<pre class="example"><code>
+
+       -- GCI Squadron execution.
+       A2ADispatcher:SetSquadronGci( "Mozdok", 900, 1200 )
+       A2ADispatcher:SetSquadronGci( "Novo", 900, 2100 )
+       A2ADispatcher:SetSquadronGci( "Maykop", 900, 1200 )
+</code></pre>
+
 </dd>
 </dl>
 		<dl class="function">
--- a/docs/Documentation/AI_Patrol.html
+++ b/docs/Documentation/AI_Patrol.html
@ -926,6 +926,9 @@ Use the method <a href="##(AI_PATROL_ZONE).ManageDamage">AI<em>PATROL</em>ZONE.M
 	


+	
+<p> This table contains the targets detected during patrol.</p>
+
 </dd>
 </dl>
 		<dl class="function">
--- a/docs/Documentation/Cargo.html
+++ b/docs/Documentation/Cargo.html
@ -2934,7 +2934,6 @@ The range till cargo will board.</p>
 		<dl class="function">
 <dt>

-		<em></em>
 <a id="#(CARGO_UNIT).CargoCarrier" >
 <strong>CARGO_UNIT.CargoCarrier</strong>
 </a>
--- a/docs/Documentation/Detection.html
+++ b/docs/Documentation/Detection.html
@ -2387,7 +2387,6 @@ The index of the DetectedItem.</p>
 		<dl class="function">
 <dt>

-		<em>#number</em>
 <a id="#(DETECTION_BASE).DetectedItemCount" >
 <strong>DETECTION_BASE.DetectedItemCount</strong>
 </a>
--- a/docs/Documentation/Movement.html
+++ b/docs/Documentation/Movement.html
@ -227,7 +227,6 @@ on defined intervals (currently every minute).</p>
 		<dl class="function">
 <dt>

-		<em>#number</em>
 <a id="#(MOVEMENT).AliveUnits" >
 <strong>MOVEMENT.AliveUnits</strong>
 </a>
@ -236,9 +235,6 @@ on defined intervals (currently every minute).</p>
 	


-	
-<p> Contains the counter how many units are currently alive</p>
-
 </dd>
 </dl>
 		<dl class="function">
--- a/docs/Documentation/Point.html
+++ b/docs/Documentation/Point.html
@ -2799,6 +2799,7 @@ The y coordinate.</p>
 		<dl class="function">
 <dt>

+		<em></em>
 <a id="#(POINT_VEC2).z" >
 <strong>POINT_VEC2.z</strong>
 </a>
--- a/docs/Documentation/SpawnStatic.html
+++ b/docs/Documentation/SpawnStatic.html
@ -436,6 +436,7 @@ ptional) The name of the new static.</p>
 		<dl class="function">
 <dt>

+		<em>#number</em>
 <a id="#(SPAWNSTATIC).SpawnIndex" >
 <strong>SPAWNSTATIC.SpawnIndex</strong>
 </a>
--- a/docs/Documentation/Task_Cargo.html
+++ b/docs/Documentation/Task_Cargo.html
@ -510,7 +510,7 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
 		<dl class="function">
 <dt>

-		<em><a href="Core.Cargo.html##(CARGO)">Core.Cargo#CARGO</a></em>
+		<em></em>
 <a id="#(FSM_PROCESS).Cargo" >
 <strong>FSM_PROCESS.Cargo</strong>
 </a>
@ -524,6 +524,7 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
 		<dl class="function">
 <dt>

+		<em></em>
 <a id="#(FSM_PROCESS).DeployZone" >
 <strong>FSM_PROCESS.DeployZone</strong>
 </a>