Made Airbases private

2025-08-15 10:47:21 +00:00 · 2017-07-01 13:00:12 +02:00 · 2017-07-01 13:00:12 +02:00 · 8b1583df30
commit 8b1583df30
parent 083568d3fd
8 changed files with 64 additions and 37 deletions
--- a/Development/Moose/Functional/CleanUp.lua
+++ b/Development/Moose/Functional/CleanUp.lua
@ -10,11 +10,11 @@
 -- @module CleanUp

 --- @type CLEANUP.__
+-- @field #map<#string,Wrapper.Airbase#AIRBASE> Airbases Map of Airbases.
 -- @extends Core.Base#BASE

 --- @type CLEANUP
 -- @extends #CLEANUP.__
-- @field #map<#string,Wrapper.Airbase#AIRBASE> Airbases Map of Airbases.

 --- # CLEANUP, extends @{Base#BASE}
 -- 
@ -66,12 +66,14 @@ CLEANUP = {
 	ClassName = "CLEANUP",
 	TimeInterval = 0.2,
 	CleanUpList = {},
-	Airbases = {},
 }

 --- @field #CLEANUP.__
 CLEANUP.__ = {}

+--- @field #CLEANUP.__.Airbases
+CLEANUP.__.Airbases = {}
+
 --- Creates the main object which is handling the cleaning of the debris within the given Zone Names.
 -- @param #CLEANUP self
 -- @param #list<#string> AirbaseNames Is a table of airbase names where the debris should be cleaned. Also a single string can be passed with one airbase name.
@ -108,8 +110,8 @@ end
 -- @param #string AirbaseName
 -- @return #CLEANUP
 function CLEANUP:AddAirbase( AirbaseName )
-  self.Airbases[AirbaseName] = AIRBASE:FindByName( AirbaseName )
-  self:F({"Airbase:", AirbaseName, self.Airbases[AirbaseName]:GetDesc()})
+  self.__.Airbases[AirbaseName] = AIRBASE:FindByName( AirbaseName )
+  self:F({"Airbase:", AirbaseName, self.__.Airbases[AirbaseName]:GetDesc()})
  
  return self
 end
@ -119,7 +121,7 @@ end
 -- @param #string AirbaseName
 -- @return #CLEANUP
 function CLEANUP:RemoveAirbase( AirbaseName )
-  self.Airbases[AirbaseName] = nil
+  self.__.Airbases[AirbaseName] = nil
  return self
 end

@ -128,7 +130,7 @@ end
 function CLEANUP.__:IsInAirbase( Vec2 )

  local InAirbase = false
-  for AirbaseName, Airbase in pairs( self.Airbases ) do
+  for AirbaseName, Airbase in pairs( self.__.Airbases ) do
    local Airbase = Airbase -- Wrapper.Airbase#AIRBASE
    if Airbase:GetZone():IsVec2InZone( Vec2 ) then
      InAirbase = true
--- a/docs/Documentation/AI_A2A.html
+++ b/docs/Documentation/AI_A2A.html
@ -575,7 +575,6 @@
 		<dl class="function">
 <dt>

-		<em>#number</em>
 <a id="#(AI_A2A).IdleCount" >
 <strong>AI_A2A.IdleCount</strong>
 </a>
--- a/docs/Documentation/CleanUp.html
+++ b/docs/Documentation/CleanUp.html
@ -134,12 +134,6 @@
 			<h2><a id="#(CLEANUP)">Type <code>CLEANUP</code></a></h2>
 				<table class="function_list">
 		<tr>
-		<td class="name" nowrap="nowrap"><a href="##(CLEANUP).<">CLEANUP.<</a></td>
-		<td class="summary">
-<p>string,Wrapper.Airbase#AIRBASE> Airbases Map of Airbases.</p>
-</td>
-		</tr>
-		<tr>
 		<td class="name" nowrap="nowrap"><a href="##(CLEANUP).AddAirbase">CLEANUP:AddAirbase(AirbaseName)</a></td>
 		<td class="summary">
 <p>Adds an airbase to the airbase validation list.</p>
@ -174,9 +168,21 @@
 			<h2><a id="#(CLEANUP.__)">Type <code>CLEANUP.__</code></a></h2>
 				<table class="function_list">
 		<tr>
+		<td class="name" nowrap="nowrap"><a href="##(CLEANUP.__).<">CLEANUP.__.<</a></td>
+		<td class="summary">
+<p>string,Wrapper.Airbase#AIRBASE> Airbases Map of Airbases.</p>
+</td>
+		</tr>
+		<tr>
 		<td class="name" nowrap="nowrap"><a href="##(CLEANUP.__).AddForCleanUp">CLEANUP.__:AddForCleanUp(CleanUpUnit, CleanUpUnitName)</a></td>
 		<td class="summary">
 <p>Add the <a href="DCSWrapper.Unit.html##(Unit)">DCSWrapper.Unit#Unit</a> to the CleanUpList for CleanUp.</p>
+</td>
+		</tr>
+		<tr>
+		<td class="name" nowrap="nowrap"><a href="##(CLEANUP.__).Airbases">CLEANUP.__.Airbases</a></td>
+		<td class="summary">
+
 </td>
 		</tr>
 		<tr>
@ -308,20 +314,6 @@ The method <a href="##(CLEANUP).RemoveAirbase">CLEANUP.RemoveAirbase</a> removes
 		<dl class="function">
 <dt>

-		<em><a href="##(map)">#map</a></em>
-<a id="#(CLEANUP).<" >
-<strong>CLEANUP.<</strong>
-</a>
-</dt>
-<dd>
-	
-<p>string,Wrapper.Airbase#AIRBASE> Airbases Map of Airbases.</p>
-
-</dd>
-</dl>
-		<dl class="function">
-<dt>
-
 <a id="#(CLEANUP).AddAirbase" >
 <strong>CLEANUP:AddAirbase(AirbaseName)</strong>
 </a>
@ -444,6 +436,20 @@ CleanUpKutaisi = CLEANUP:New( AIRBASE.Caucasus.Kutaisi )</code></pre>
 		<dl class="function">
 <dt>

+		<em><a href="##(map)">#map</a></em>
+<a id="#(CLEANUP.__).<" >
+<strong>CLEANUP.__.<</strong>
+</a>
+</dt>
+<dd>
+	
+<p>string,Wrapper.Airbase#AIRBASE> Airbases Map of Airbases.</p>
+
+</dd>
+</dl>
+		<dl class="function">
+<dt>
+
 <a id="#(CLEANUP.__).AddForCleanUp" >
 <strong>CLEANUP.__:AddForCleanUp(CleanUpUnit, CleanUpUnitName)</strong>
 </a>
@ -465,6 +471,20 @@ CleanUpKutaisi = CLEANUP:New( AIRBASE.Caucasus.Kutaisi )</code></pre>

 				</li>
 		</ul>
+</dd>
+</dl>
+		<dl class="function">
+<dt>
+
+		<em><a href="##(CLEANUP.__.Airbases)">#CLEANUP.__.Airbases</a></em>
+<a id="#(CLEANUP.__).Airbases" >
+<strong>CLEANUP.__.Airbases</strong>
+</a>
+</dt>
+<dd>
+	
+
+
 </dd>
 </dl>
 		<dl class="function">
@ -662,6 +682,8 @@ The object to be destroyed.</p>
 </dd>
 </dl>

+			<h2><a id="#(CLEANUP.__.Airbases)" >Type <code>CLEANUP.__.Airbases</code></a></h2>
+			
 			<h2><a id="#(list)" >Type <code>list</code></a></h2>
 			
 			<h2><a id="#(map)" >Type <code>map</code></a></h2>
--- a/docs/Documentation/Detection.html
+++ b/docs/Documentation/Detection.html
@ -2563,7 +2563,7 @@ The index of the DetectedItem.</p>
 		<dl class="function">
 <dt>

-		<em>#number</em>
+		<em></em>
 <a id="#(DETECTION_BASE).DetectionInterval" >
 <strong>DETECTION_BASE.DetectionInterval</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/Settings.html
+++ b/docs/Documentation/Settings.html
@ -1073,7 +1073,7 @@ true if metric.</p>
 		<dl class="function">
 <dt>

-		<em>#boolean</em>
+		<em></em>
 <a id="#(SETTINGS).Metric" >
 <strong>SETTINGS.Metric</strong>
 </a>
--- a/docs/Documentation/Spawn.html
+++ b/docs/Documentation/Spawn.html
@ -2194,6 +2194,9 @@ The group that was spawned. You can use this group for further actions.</p>
 	


+	
+<p> Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.</p>
+
 </dd>
 </dl>
 		<dl class="function">
@ -2726,6 +2729,9 @@ when nothing was spawned.</p>
 	


+	
+<p> Overwrite unit names by default with group name.</p>
+
 </dd>
 </dl>
 		<dl class="function">
@ -2740,6 +2746,9 @@ when nothing was spawned.</p>
 	


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

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

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


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

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

-		<em>#number</em>
 <a id="#(SPAWNSTATIC).SpawnIndex" >
 <strong>SPAWNSTATIC.SpawnIndex</strong>
 </a>