Documentation

2025-08-15 10:47:21 +00:00 · 2017-10-26 19:22:18 +02:00 · 2017-10-26 19:22:18 +02:00 · abf84e121f
commit abf84e121f
parent 212c674443
10 changed files with 146 additions and 19 deletions
--- 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/Cargo.html
+++ b/docs/Documentation/Cargo.html
@ -2269,7 +2269,6 @@ 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>
@ -3698,6 +3697,7 @@ 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/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></em>
+		<em>#number</em>
 <a id="#(DESIGNATE).LaseDuration" >
 <strong>DESIGNATE.LaseDuration</strong>
 </a>
@ -1160,7 +1160,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
@ -2482,7 +2482,6 @@ The index of the DetectedItem.</p>
 		<dl class="function">
 <dt>

-		<em>#number</em>
 <a id="#(DETECTION_BASE).DetectedItemMax" >
 <strong>DETECTION_BASE.DetectedItemMax</strong>
 </a>
@ -4060,7 +4059,7 @@ Return false to cancel Transition.</p>
 		<dl class="function">
 <dt>

-		<em>#number</em>
+		<em></em>
 <a id="#(DETECTION_BASE).RefreshTimeInterval" >
 <strong>DETECTION_BASE.RefreshTimeInterval</strong>
 </a>
--- a/docs/Documentation/Fsm.html
+++ b/docs/Documentation/Fsm.html
@ -1608,7 +1608,7 @@ A string defining the start state.</p>
 		<dl class="function">
 <dt>

-		<em></em>
+		<em>#string</em>
 <a id="#(FSM)._StartState" >
 <strong>FSM._StartState</strong>
 </a>
@ -1907,7 +1907,6 @@ A string defining the start state.</p>
 		<dl class="function">
 <dt>

-		<em></em>
 <a id="#(FSM).current" >
 <strong>FSM.current</strong>
 </a>
--- a/docs/Documentation/Positionable.html
+++ b/docs/Documentation/Positionable.html
@ -2017,7 +2017,6 @@ The height in meters to add to the altitude of the positionable.</p>
 		<dl class="function">
 <dt>

-		<em><a href="Core.Spot.html##(SPOT)">Core.Spot#SPOT</a></em>
 <a id="#(POSITIONABLE).Spot" >
 <strong>POSITIONABLE.Spot</strong>
 </a>
--- a/docs/Documentation/Spawn.html
+++ b/docs/Documentation/Spawn.html
@ -473,19 +473,19 @@ and any spaces before and after the resulting name are removed.</p>
 </td>
 		</tr>
 		<tr>
-		<td class="name" nowrap="nowrap"><a href="##(SPAWN).SpawnFromStatic">SPAWN:SpawnFromStatic(HostStatic, SpawnIndex)</a></td>
+		<td class="name" nowrap="nowrap"><a href="##(SPAWN).SpawnFromStatic">SPAWN:SpawnFromStatic(HostStatic, MinHeight, MaxHeight, SpawnIndex)</a></td>
 		<td class="summary">
 <p>Will spawn a group from a hosting static.</p>
 </td>
 		</tr>
 		<tr>
-		<td class="name" nowrap="nowrap"><a href="##(SPAWN).SpawnFromUnit">SPAWN:SpawnFromUnit(HostUnit, SpawnIndex)</a></td>
+		<td class="name" nowrap="nowrap"><a href="##(SPAWN).SpawnFromUnit">SPAWN:SpawnFromUnit(HostUnit, MinHeight, MaxHeight, SpawnIndex)</a></td>
 		<td class="summary">
 <p>Will spawn a group from a hosting unit.</p>
 </td>
 		</tr>
 		<tr>
-		<td class="name" nowrap="nowrap"><a href="##(SPAWN).SpawnFromVec2">SPAWN:SpawnFromVec2(Vec2, SpawnIndex)</a></td>
+		<td class="name" nowrap="nowrap"><a href="##(SPAWN).SpawnFromVec2">SPAWN:SpawnFromVec2(Vec2, MinHeight, MaxHeight, SpawnIndex)</a></td>
 		<td class="summary">
 <p>Will spawn a group from a Vec2 in 3D space.</p>
 </td>
@ -533,7 +533,7 @@ and any spaces before and after the resulting name are removed.</p>
 </td>
 		</tr>
 		<tr>
-		<td class="name" nowrap="nowrap"><a href="##(SPAWN).SpawnInZone">SPAWN:SpawnInZone(Zone, RandomizeGroup, SpawnIndex)</a></td>
+		<td class="name" nowrap="nowrap"><a href="##(SPAWN).SpawnInZone">SPAWN:SpawnInZone(Zone, RandomizeGroup, MinHeight, MaxHeight, SpawnIndex)</a></td>
 		<td class="summary">
 <p>Will spawn a Group within a given <a href="Zone.html">Zone</a>.</p>
 </td>
@ -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>
@ -2512,7 +2518,7 @@ Nothing was spawned.</p>
 <dt>

 <a id="#(SPAWN).SpawnFromStatic" >
-<strong>SPAWN:SpawnFromStatic(HostStatic, SpawnIndex)</strong>
+<strong>SPAWN:SpawnFromStatic(HostStatic, MinHeight, MaxHeight, SpawnIndex)</strong>
 </a>
 </dt>
 <dd>
@ -2533,6 +2539,18 @@ The static dropping or unloading the group.</p>
 				</li>
 				<li>
 				
+<p><code><em>#number MinHeight </em></code>: 
+(optional) The minimum height to spawn an airborne group into the zone.</p>
+
+				</li>
+				<li>
+				
+<p><code><em>#number MaxHeight </em></code>: 
+(optional) The maximum height to spawn an airborne group into the zone.</p>
+
+				</li>
+				<li>
+				
 <p><code><em>#number SpawnIndex </em></code>: 
 (optional) The index which group to spawn within the given zone.</p>

@ -2553,13 +2571,24 @@ Nothing was spawned.</p>

 				</li>
 			</ol>
+			<h3>Usage:</h3>
+		<pre class="example"><code>
+  local SpawnStatic = STATIC:FindByName( StaticName )
+
+  -- Spawn from the static position at the height specified in the ME of the group template!
+  SpawnAirplanes:SpawnFromStatic( SpawnStatic )  
+  
+  -- Spawn from the static position at the height randomized between 2000 and 4000 meters.
+  SpawnAirplanes:SpawnFromStatic( SpawnStatic, 2000, 4000 )  
+</code></pre>
+
 </dd>
 </dl>
 		<dl class="function">
 <dt>

 <a id="#(SPAWN).SpawnFromUnit" >
-<strong>SPAWN:SpawnFromUnit(HostUnit, SpawnIndex)</strong>
+<strong>SPAWN:SpawnFromUnit(HostUnit, MinHeight, MaxHeight, SpawnIndex)</strong>
 </a>
 </dt>
 <dd>
@ -2581,6 +2610,18 @@ The air or ground unit dropping or unloading the group.</p>
 				</li>
 				<li>
 				
+<p><code><em>#number MinHeight </em></code>: 
+(optional) The minimum height to spawn an airborne group into the zone.</p>
+
+				</li>
+				<li>
+				
+<p><code><em>#number MaxHeight </em></code>: 
+(optional) The maximum height to spawn an airborne group into the zone.</p>
+
+				</li>
+				<li>
+				
 <p><code><em>#number SpawnIndex </em></code>: 
 (optional) The index which group to spawn within the given zone.</p>

@ -2601,13 +2642,24 @@ Nothing was spawned.</p>

 				</li>
 			</ol>
+			<h3>Usage:</h3>
+		<pre class="example"><code>
+  local SpawnStatic = STATIC:FindByName( StaticName )
+
+  -- Spawn from the static position at the height specified in the ME of the group template!
+  SpawnAirplanes:SpawnFromUnit( SpawnStatic )  
+  
+  -- Spawn from the static position at the height randomized between 2000 and 4000 meters.
+  SpawnAirplanes:SpawnFromUnit( SpawnStatic, 2000, 4000 )  
+</code></pre>
+
 </dd>
 </dl>
 		<dl class="function">
 <dt>

 <a id="#(SPAWN).SpawnFromVec2" >
-<strong>SPAWN:SpawnFromVec2(Vec2, SpawnIndex)</strong>
+<strong>SPAWN:SpawnFromVec2(Vec2, MinHeight, MaxHeight, SpawnIndex)</strong>
 </a>
 </dt>
 <dd>
@ -2629,6 +2681,18 @@ The Vec2 coordinates where to spawn the group.</p>
 				</li>
 				<li>
 				
+<p><code><em>#number MinHeight </em></code>: 
+(optional) The minimum height to spawn an airborne group into the zone.</p>
+
+				</li>
+				<li>
+				
+<p><code><em>#number MaxHeight </em></code>: 
+(optional) The maximum height to spawn an airborne group into the zone.</p>
+
+				</li>
+				<li>
+				
 <p><code><em>#number SpawnIndex </em></code>: 
 (optional) The index which group to spawn within the given zone.</p>

@ -2649,6 +2713,17 @@ Nothing was spawned.</p>

 				</li>
 			</ol>
+			<h3>Usage:</h3>
+		<pre class="example"><code>
+  local SpawnVec2 = ZONE:New( ZoneName ):GetVec2()
+
+  -- Spawn at the zone center position at the height specified in the ME of the group template!
+  SpawnAirplanes:SpawnFromVec2( SpawnVec2 )  
+  
+  -- Spawn from the static position at the height randomized between 2000 and 4000 meters.
+  SpawnAirplanes:SpawnFromVec2( SpawnVec2, 2000, 4000 )  
+</code></pre>
+
 </dd>
 </dl>
 		<dl class="function">
@ -2806,7 +2881,7 @@ SpawnGroupName</p>
 <dt>

 <a id="#(SPAWN).SpawnInZone" >
-<strong>SPAWN:SpawnInZone(Zone, RandomizeGroup, SpawnIndex)</strong>
+<strong>SPAWN:SpawnInZone(Zone, RandomizeGroup, MinHeight, MaxHeight, SpawnIndex)</strong>
 </a>
 </dt>
 <dd>
@ -2834,6 +2909,18 @@ The zone where the group is to be spawned.</p>
 				</li>
 				<li>
 				
+<p><code><em>#number MinHeight </em></code>: 
+(optional) The minimum height to spawn an airborne group into the zone.</p>
+
+				</li>
+				<li>
+				
+<p><code><em>#number MaxHeight </em></code>: 
+(optional) The maximum height to spawn an airborne group into the zone.</p>
+
+				</li>
+				<li>
+				
 <p><code><em>#number SpawnIndex </em></code>: 
 (optional) The index which group to spawn within the given zone.</p>

@ -2854,6 +2941,26 @@ when nothing was spawned.</p>

 				</li>
 			</ol>
+			<h3>Usage:</h3>
+		<pre class="example"><code>
+  local SpawnZone = ZONE:New( ZoneName )
+
+  -- Spawn at the zone center position at the height specified in the ME of the group template!
+  SpawnAirplanes:SpawnFromZone( SpawnZone )  
+  
+  -- Spawn in the zone at a random position at the height specified in the Me of the group template.
+  SpawnAirplanes:SpawnFromZone( SpawnZone, true )  
+  
+  -- Spawn in the zone at a random position at the height randomized between 2000 and 4000 meters.
+  SpawnAirplanes:SpawnFromUnit( SpawnZone, true, 2000, 4000 )  
+
+  -- Spawn at the zone center position at the height randomized between 2000 and 4000 meters.
+  SpawnAirplanes:SpawnFromUnit( SpawnZone, false, 2000, 4000 )  
+  
+  -- Spawn at the zone center position at the height randomized between 2000 and 4000 meters.
+  SpawnAirplanes:SpawnFromUnit( SpawnZone, nil, 2000, 4000 )  
+  </code></pre>
+
 </dd>
 </dl>
 		<dl class="function">
@ -3276,7 +3383,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>
@ -3880,6 +3987,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,6 +775,7 @@ true if it is lasing</p>
 		<dl class="function">
 <dt>

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

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

+		<em></em>
 <a id="#(SPOT).SpotLaser" >
 <strong>SPOT.SpotLaser</strong>
 </a>
@ -814,6 +817,7 @@ 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
@ -562,7 +562,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>
@ -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>
--- a/docs/Documentation/ZoneGoal.html
+++ b/docs/Documentation/ZoneGoal.html
@ -489,6 +489,7 @@ The name of the player.</p>
 		<dl class="function">
 <dt>

+		<em></em>
 <a id="#(ZONE_GOAL).SmokeTime" >
 <strong>ZONE_GOAL.SmokeTime</strong>
 </a>
@ -497,6 +498,9 @@ The name of the player.</p>
 	


+	
+<p>self.SmokeColor = nil</p>
+
 </dd>
 </dl>
 		<dl class="function">