Tweaks for the settings system

- Player settings are located at the group level. Only the first player that joins the group will be able to configure the settings. - Default system settings are located at the group of the commend center. Thus, the COMMANDCENTER class will contain the default system settings menu. You need to join the command center unit (ALT-J) as a game master to be able to configure these settings.
2025-10-29 16:58:06 +00:00 · 2017-07-04 10:55:45 +02:00
parent c043eef5eb
commit ccfcca8f9a
17 changed files with 283 additions and 119 deletions
--- 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
@@ -3059,6 +3059,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/CleanUp.html
+++ b/docs/Documentation/CleanUp.html
@@ -149,6 +149,12 @@
 		<td class="name" nowrap="nowrap"><a href="##(CLEANUP).RemoveAirbase">CLEANUP:RemoveAirbase(AirbaseName)</a></td>
 		<td class="summary">
 <p>Removes an airbase from the airbase validation list.</p>
+</td>
+		</tr>
+		<tr>
+		<td class="name" nowrap="nowrap"><a href="##(CLEANUP).SetCleanMissiles">CLEANUP:SetCleanMissiles(CleanMissiles)</a></td>
+		<td class="summary">
+<p>Enables or disables the cleaning of missiles within the airbase zones.</p>
 </td>
 		</tr>
 		<tr>
@@ -229,8 +235,14 @@ But as a result, there is more CPU overload.</p>

 <h2>2. Add or Remove airbases</h2>

-<p>The method <a href="##(CLEANUP).AddAirbase">CLEANUP.AddAirbase</a> to add an airbase to the cleanup validation process.
-The method <a href="##(CLEANUP).RemoveAirbase">CLEANUP.RemoveAirbase</a> removes an airbase from the cleanup validation process.</p>
+<p>The method <a href="##(CLEANUP).AddAirbase">CLEANUP.AddAirbase</a>() to add an airbase to the cleanup validation process.
+The method <a href="##(CLEANUP).RemoveAirbase">CLEANUP.RemoveAirbase</a>() removes an airbase from the cleanup validation process.</p>
+
+<h2>3. Clean missiles and bombs within the airbase zone.</h2>
+
+<p>When missiles or bombs hit the runway, the airbase operations stop.
+Use the method <a href="##(CLEANUP).SetCleanMissiles">CLEANUP.SetCleanMissiles</a>() to control the cleaning of missiles, which will prevent airbases to stop.
+Note that this method will not allow anymore airbases to be attacked, so there is a trade-off here to do.</p>


 </dd>
@@ -328,6 +340,41 @@ CleanUpKutaisi = CLEANUP:New( AIRBASE.Caucasus.Kutaisi )</code></pre>
 <p><em><a href="##(CLEANUP)">#CLEANUP</a>:</em></p>


+</dd>
+</dl>
+		<dl class="function">
+<dt>
+
+<a id="#(CLEANUP).SetCleanMissiles" >
+<strong>CLEANUP:SetCleanMissiles(CleanMissiles)</strong>
+</a>
+</dt>
+<dd>
+	
+<p>Enables or disables the cleaning of missiles within the airbase zones.</p>
+
+	
+<p>Airbase operations stop when a missile or bomb is dropped at a runway.
+Note that when this method is used, the airbase operations won't stop if
+the missile or bomb was cleaned within the airbase zone, which is 8km from the center of the airbase.
+However, there is a trade-off to make. Attacks on airbases won't be possible anymore if this method is used.
+Note, one can also use the method <a href="##(CLEANUP).RemoveAirbase">CLEANUP.RemoveAirbase</a>() to remove the airbase from the control process as a whole,
+when an enemy unit is near. That is also an option...</p>
+
+		<h3>Parameter</h3>
+		<ul>
+				<li>
+				
+<p><code><em>#string CleanMissiles </em></code>: 
+(Default=true) If true, missiles fired are immediately destroyed. If false missiles are not controlled.</p>
+
+				</li>
+		</ul>
+		<h3>Return value</h3>
+				
+<p><em><a href="##(CLEANUP)">#CLEANUP</a>:</em></p>
+
+
 </dd>
 </dl>
 		<dl class="function">
--- a/docs/Documentation/Controllable.html
+++ b/docs/Documentation/Controllable.html
@@ -247,6 +247,12 @@
 		<td class="name" nowrap="nowrap"><a href="##(CONTROLLABLE).GetLife0">CONTROLLABLE:GetLife0()</a></td>
 		<td class="summary">
 <p>Returns the initial health.</p>
+</td>
+		</tr>
+		<tr>
+		<td class="name" nowrap="nowrap"><a href="##(CONTROLLABLE).GetSize">CONTROLLABLE:GetSize()</a></td>
+		<td class="summary">
+
 </td>
 		</tr>
 		<tr>
@@ -1526,6 +1532,19 @@ The controllable is not existing or alive.  </p>

 				</li>
 			</ol>
+</dd>
+</dl>
+		<dl class="function">
+<dt>
+
+<a id="#(CONTROLLABLE).GetSize" >
+<strong>CONTROLLABLE:GetSize()</strong>
+</a>
+</dt>
+<dd>
+	
+
+
 </dd>
 </dl>
 		<dl class="function">
--- a/docs/Documentation/Designate.html
+++ b/docs/Documentation/Designate.html
@@ -900,7 +900,6 @@ function below will use the range 1-7 just in case</p>
 		<dl class="function">
 <dt>

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

+		<em>#number</em>
 <a id="#(DETECTION_BASE).DetectedItemMax" >
 <strong>DETECTION_BASE.DetectedItemMax</strong>
 </a>
@@ -2563,7 +2564,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,9 +2194,6 @@ 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">
@@ -2746,9 +2743,6 @@ when nothing was spawned.</p>
 	


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

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

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

-		<em>#boolean</em>
+		<em></em>
 <a id="#(SPAWN).SpawnUnControlled" >
 <strong>SPAWN.SpawnUnControlled</strong>
 </a>
--- 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>
--- a/docs/Documentation/Task.html
+++ b/docs/Documentation/Task.html
@@ -552,7 +552,7 @@
 </td>
 		</tr>
 		<tr>
-		<td class="name" nowrap="nowrap"><a href="##(TASK).SetInfo">TASK:SetInfo(TaskInfo, TaskInfoText)</a></td>
+		<td class="name" nowrap="nowrap"><a href="##(TASK).SetInfo">TASK:SetInfo(TaskInfo, TaskInfoText, TaskInfoOrder)</a></td>
 		<td class="summary">
 <p>Sets the Information on the Task</p>
 </td>
@@ -687,6 +687,12 @@
 		<td class="name" nowrap="nowrap"><a href="##(TASK).TaskID">TASK.TaskID</a></td>
 		<td class="summary">

+</td>
+		</tr>
+		<tr>
+		<td class="name" nowrap="nowrap"><a href="##(TASK).TaskInfo">TASK.TaskInfo</a></td>
+		<td class="summary">
+
 </td>
 		</tr>
 		<tr>
@@ -2472,7 +2478,7 @@ self</p>
 <dt>

 <a id="#(TASK).SetInfo" >
-<strong>TASK:SetInfo(TaskInfo, TaskInfoText)</strong>
+<strong>TASK:SetInfo(TaskInfo, TaskInfoText, TaskInfoOrder)</strong>
 </a>
 </dt>
 <dd>
@@ -2483,12 +2489,20 @@ self</p>
 		<ul>
 				<li>
 				
-<p><code><em>#string TaskInfo </em></code>: </p>
+<p><code><em>#string TaskInfo </em></code>: 
+The key and title of the task information.</p>

 				</li>
 				<li>
 				
-<p><code><em> TaskInfoText </em></code>: </p>
+<p><code><em>#string TaskInfoText </em></code>: 
+The Task info text.</p>
+
+				</li>
+				<li>
+				
+<p><code><em>#number TaskInfoOrder </em></code>: 
+The ordering, a number between 0 and 99.</p>

 				</li>
 		</ul>
@@ -2978,6 +2992,19 @@ Fsm#FSM_PROCESS</p>
 	


+</dd>
+</dl>
+		<dl class="function">
+<dt>
+
+<a id="#(TASK).TaskInfo" >
+<strong>TASK.TaskInfo</strong>
+</a>
+</dt>
+<dd>
+	
+
+
 </dd>
 </dl>
 		<dl class="function">
--- a/docs/Documentation/Task_Cargo.html
+++ b/docs/Documentation/Task_Cargo.html
@@ -195,6 +195,12 @@ and various dedicated deployment zones.</p>
 		<td class="name" nowrap="nowrap"><a href="##(TASK_CARGO).GetDeployZones">TASK_CARGO:GetDeployZones()</a></td>
 		<td class="summary">

+</td>
+		</tr>
+		<tr>
+		<td class="name" nowrap="nowrap"><a href="##(TASK_CARGO).GetGoalTotal">TASK_CARGO:GetGoalTotal()</a></td>
+		<td class="summary">
+
 </td>
 		</tr>
 		<tr>
@@ -249,6 +255,12 @@ and various dedicated deployment zones.</p>
 		<td class="name" nowrap="nowrap"><a href="##(TASK_CARGO).SetDeployZones">TASK_CARGO:SetDeployZones(@, TaskUnit, DeployZones)</a></td>
 		<td class="summary">

+</td>
+		</tr>
+		<tr>
+		<td class="name" nowrap="nowrap"><a href="##(TASK_CARGO).SetGoalTotal">TASK_CARGO:SetGoalTotal()</a></td>
+		<td class="summary">
+
 </td>
 		</tr>
 		<tr>
@@ -355,6 +367,12 @@ and various dedicated deployment zones.</p>
 		<td class="name" nowrap="nowrap"><a href="##(TASK_CARGO_TRANSPORT).__CargoPickedUp">TASK_CARGO_TRANSPORT:__CargoPickedUp(Delay, TaskUnit, Cargo)</a></td>
 		<td class="summary">
 <p>Asynchronous Event Trigger for Event CargoPickedUp.</p>
+</td>
+		</tr>
+		<tr>
+		<td class="name" nowrap="nowrap"><a href="##(TASK_CARGO_TRANSPORT).onafterGoal">TASK_CARGO_TRANSPORT:onafterGoal(TaskUnit, From, Event, To)</a></td>
+		<td class="summary">
+
 </td>
 		</tr>
 	</table>
@@ -510,7 +528,7 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
 		<dl class="function">
 <dt>

-		<em></em>
+		<em><a href="Core.Cargo.html##(CARGO_GROUP)">Core.Cargo#CARGO_GROUP</a></em>
 <a id="#(FSM_PROCESS).Cargo" >
 <strong>FSM_PROCESS.Cargo</strong>
 </a>
@@ -524,6 +542,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>
@@ -619,6 +638,19 @@ The Cargo Set.</p>
 <p><em><a href="##(list)">#list</a>:</em>
 Core.Zone#ZONE_BASE> The Deployment Zones.</p>

+</dd>
+</dl>
+		<dl class="function">
+<dt>
+
+<a id="#(TASK_CARGO).GetGoalTotal" >
+<strong>TASK_CARGO:GetGoalTotal()</strong>
+</a>
+</dt>
+<dd>
+	
+
+
 </dd>
 </dl>
 		<dl class="function">
@@ -875,6 +907,19 @@ ist<Core.Zone#ZONE> DeployZones</p>
 <p><em><a href="##(TASK_CARGO)">#TASK_CARGO</a>:</em></p>


+</dd>
+</dl>
+		<dl class="function">
+<dt>
+
+<a id="#(TASK_CARGO).SetGoalTotal" >
+<strong>TASK_CARGO:SetGoalTotal()</strong>
+</a>
+</dt>
+<dd>
+	
+
+
 </dd>
 </dl>
 		<dl class="function">
@@ -1480,6 +1525,42 @@ The Cargo that got PickedUp by the TaskUnit. You can use this to check Cargo Sta
 				</li>
 		</ul>
 </dd>
+</dl>
+		<dl class="function">
+<dt>
+
+<a id="#(TASK_CARGO_TRANSPORT).onafterGoal" >
+<strong>TASK_CARGO_TRANSPORT:onafterGoal(TaskUnit, From, Event, To)</strong>
+</a>
+</dt>
+<dd>
+	
+
+
+		<h3>Parameters</h3>
+		<ul>
+				<li>
+				
+<p><code><em> TaskUnit </em></code>: </p>
+
+				</li>
+				<li>
+				
+<p><code><em> From </em></code>: </p>
+
+				</li>
+				<li>
+				
+<p><code><em> Event </em></code>: </p>
+
+				</li>
+				<li>
+				
+<p><code><em> To </em></code>: </p>
+
+				</li>
+		</ul>
+</dd>
 </dl>

 			<h2><a id="#(list)" >Type <code>list</code></a></h2>