Documentation

2025-08-15 10:47:21 +00:00 · 2017-10-27 18:30:03 +02:00 · 2017-10-27 18:30:03 +02:00 · 6f0a254929
commit 6f0a254929
parent c495d0e5e9
12 changed files with 96 additions and 13 deletions
--- a/Development/Moose/Wrapper/Airbase.lua
+++ b/Development/Moose/Wrapper/Airbase.lua
@ -59,7 +59,7 @@ AIRBASE = {

 --- Enumeration to identify the airbases in the Caucasus region.
 -- 
-- These are all airbases:
+-- These are all airbases of Caucasus:
 -- 
 --   * AIRBASE.Caucasus.Gelendzhik
 --   * AIRBASE.Caucasus.Krasnodar_Pashkovsky
@ -109,6 +109,28 @@ AIRBASE.Caucasus = {
  }
  
 --- @field Nevada
+-- 
+-- These are all airbases of Nevada:
+-- 
+--   * AIRBASE.Nevada.Creech_AFB
+--   * AIRBASE.Nevada.Groom_Lake_AFB
+--   * AIRBASE.Nevada.McCarran_International_Airport
+--   * AIRBASE.Nevada.Nellis_AFB
+--   * AIRBASE.Nevada.Beatty_Airport
+--   * AIRBASE.Nevada.Boulder_City_Airport
+--   * AIRBASE.Nevada.Echo_Bay
+--   * AIRBASE.Nevada.Henderson_Executive_Airport
+--   * AIRBASE.Nevada.Jean_Airport
+--   * AIRBASE.Nevada.Laughlin_Airport
+--   * AIRBASE.Nevada.Lincoln_County
+--   * AIRBASE.Nevada.Mellan_Airstrip
+--   * AIRBASE.Nevada.Mesquite
+--   * AIRBASE.Nevada.Mina_Airport_3Q0
+--   * AIRBASE.Nevada.North_Las_Vegas
+--   * AIRBASE.Nevada.Pahute_Mesa_Airstrip
+--   * AIRBASE.Nevada.Tonopah_Airport
+--   * AIRBASE.Nevada.Tonopah_Test_Range_Airfield
+--   
 AIRBASE.Nevada = {
  ["Creech_AFB"] = "Creech AFB",
  ["Groom_Lake_AFB"] = "Groom Lake AFB",
@ -131,6 +153,40 @@ AIRBASE.Nevada = {
  }

 --- @field Normandy
+-- 
+-- These are all airbases of Normandy:
+-- 
+--   * AIRBASE.Normandy.Saint_Pierre_du_Mont
+--   * AIRBASE.Normandy.Lignerolles
+--   * AIRBASE.Normandy.Cretteville
+--   * AIRBASE.Normandy.Maupertus
+--   * AIRBASE.Normandy.Brucheville
+--   * AIRBASE.Normandy.Meautis
+--   * AIRBASE.Normandy.Cricqueville_en_Bessin
+--   * AIRBASE.Normandy.Lessay
+--   * AIRBASE.Normandy.Sainte_Laurent_sur_Mer
+--   * AIRBASE.Normandy.Biniville
+--   * AIRBASE.Normandy.Cardonville
+--   * AIRBASE.Normandy.Deux_Jumeaux
+--   * AIRBASE.Normandy.Chippelle
+--   * AIRBASE.Normandy.Beuzeville
+--   * AIRBASE.Normandy.Azeville
+--   * AIRBASE.Normandy.Picauville
+--   * AIRBASE.Normandy.Le_Molay
+--   * AIRBASE.Normandy.Longues_sur_Mer
+--   * AIRBASE.Normandy.Carpiquet
+--   * AIRBASE.Normandy.Bazenville
+--   * AIRBASE.Normandy.Sainte_Croix_sur_Mer
+--   * AIRBASE.Normandy.Beny_sur_Mer
+--   * AIRBASE.Normandy.Rucqueville
+--   * AIRBASE.Normandy.Sommervieu
+--   * AIRBASE.Normandy.Lantheuil
+--   * AIRBASE.Normandy.Evreux
+--   * AIRBASE.Normandy.Chailey
+--   * AIRBASE.Normandy.Needs_Oar_Point
+--   * AIRBASE.Normandy.Funtington
+--   * AIRBASE.Normandy.Tangmere
+--   * AIRBASE.Normandy.Ford
 AIRBASE.Normandy = {
  ["Saint_Pierre_du_Mont"] = "Saint Pierre du Mont",
  ["Lignerolles"] = "Lignerolles",
--- a/docs/Documentation/AI_A2A.html
+++ b/docs/Documentation/AI_A2A.html
@ -671,6 +671,7 @@
 		<dl class="function">
 <dt>

+		<em>#number</em>
 <a id="#(AI_A2A).IdleCount" >
 <strong>AI_A2A.IdleCount</strong>
 </a>
--- a/docs/Documentation/AI_Patrol.html
+++ b/docs/Documentation/AI_Patrol.html
@ -936,6 +936,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/Airbase.html
+++ b/docs/Documentation/Airbase.html
@ -268,7 +268,7 @@ is implemented in the AIRBASE class as <a href="##(AIRBASE).GetName">AIRBASE.Get

 	

-<p>These are all airbases:</p>
+<p>These are all airbases of Caucasus:</p>

 <ul>
    <li>AIRBASE.Caucasus.Gelendzhik</li>
--- a/docs/Documentation/Cargo.html
+++ b/docs/Documentation/Cargo.html
@ -2269,6 +2269,7 @@ The amount of seconds to delay the action.</p>
 		<dl class="function">
 <dt>

+		<em></em>
 <a id="#(CARGO_CRATE).CargoCarrier" >
 <strong>CARGO_CRATE.CargoCarrier</strong>
 </a>
@ -3804,6 +3805,7 @@ The range till cargo will board.</p>
 		<dl class="function">
 <dt>

+		<em>#number</em>
 <a id="#(CARGO_UNIT).RunCount" >
 <strong>CARGO_UNIT.RunCount</strong>
 </a>
--- a/docs/Documentation/Designate.html
+++ b/docs/Documentation/Designate.html
@ -1106,7 +1106,7 @@ function below will use the range 1-7 just in case</p>
 		<dl class="function">
 <dt>

-		<em>#number</em>
+		<em></em>
 <a id="#(DESIGNATE).LaseDuration" >
 <strong>DESIGNATE.LaseDuration</strong>
 </a>
--- a/docs/Documentation/Detection.html
+++ b/docs/Documentation/Detection.html
@ -4059,7 +4059,7 @@ Return false to cancel Transition.</p>
 		<dl class="function">
 <dt>

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

+		<em>#number</em>
 <a id="#(MOVEMENT).AliveUnits" >
 <strong>MOVEMENT.AliveUnits</strong>
 </a>
@ -245,6 +246,9 @@ 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
@ -3495,7 +3495,6 @@ The y coordinate.</p>
 		<dl class="function">
 <dt>

-		<em></em>
 <a id="#(POINT_VEC2).z" >
 <strong>POINT_VEC2.z</strong>
 </a>
--- a/docs/Documentation/Spawn.html
+++ b/docs/Documentation/Spawn.html
@ -848,6 +848,12 @@ and any spaces before and after the resulting name are removed.</p>
 		<td class="name" nowrap="nowrap"><a href="##(SPAWN)._TranslateRotate">SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle)</a></td>
 		<td class="summary">

+</td>
+		</tr>
+		<tr>
+		<td class="name" nowrap="nowrap"><a href="##(SPAWN).uncontrolled">SPAWN.uncontrolled</a></td>
+		<td class="summary">
+
 </td>
 		</tr>
 	</table>
@ -2997,6 +3003,9 @@ when nothing was spawned.</p>
 	


+	
+<p> By default, no InitLimit</p>
+
 </dd>
 </dl>
 		<dl class="function">
@ -3032,7 +3041,7 @@ when nothing was spawned.</p>
 		<dl class="function">
 <dt>

-		<em></em>
+		<em>#number</em>
 <a id="#(SPAWN).SpawnMaxGroups" >
 <strong>SPAWN.SpawnMaxGroups</strong>
 </a>
@ -3049,7 +3058,7 @@ when nothing was spawned.</p>
 		<dl class="function">
 <dt>

-		<em></em>
+		<em>#number</em>
 <a id="#(SPAWN).SpawnMaxUnitsAlive" >
 <strong>SPAWN.SpawnMaxUnitsAlive</strong>
 </a>
@ -3401,7 +3410,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )


 	
-<p> Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.</p>
+<p> When the first Spawn executes, all the Groups need to be made visible before start.</p>

 </dd>
 </dl>
@ -3981,6 +3990,20 @@ True = Continue Scheduler</p>

 				</li>
 		</ul>
+</dd>
+</dl>
+		<dl class="function">
+<dt>
+
+		<em></em>
+<a id="#(SPAWN).uncontrolled" >
+<strong>SPAWN.uncontrolled</strong>
+</a>
+</dt>
+<dd>
+	
+
+
 </dd>
 </dl>

--- a/docs/Documentation/Spot.html
+++ b/docs/Documentation/Spot.html
@ -775,7 +775,6 @@ true if it is lasing</p>
 		<dl class="function">
 <dt>

-		<em></em>
 <a id="#(SPOT).ScheduleID" >
 <strong>SPOT.ScheduleID</strong>
 </a>
@ -789,7 +788,6 @@ true if it is lasing</p>
 		<dl class="function">
 <dt>

-		<em></em>
 <a id="#(SPOT).SpotIR" >
 <strong>SPOT.SpotIR</strong>
 </a>
@ -803,7 +801,6 @@ true if it is lasing</p>
 		<dl class="function">
 <dt>

-		<em></em>
 <a id="#(SPOT).SpotLaser" >
 <strong>SPOT.SpotLaser</strong>
 </a>
@ -817,7 +814,6 @@ true if it is lasing</p>
 		<dl class="function">
 <dt>

-		<em></em>
 <a id="#(SPOT).Target" >
 <strong>SPOT.Target</strong>
 </a>
--- a/docs/Documentation/Task_Cargo.html
+++ b/docs/Documentation/Task_Cargo.html
@ -576,7 +576,6 @@ 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>