Progress, changed and reworked protocols

2016-08-14 - Changed Spawn APIs to express Group position and Unit position randomization. - Changed the API protocol of SpawnInZone() method. -- Removed OuterRadius and InnerRadius parameters !!! - Changed the API protocol of SpawnFromUnit() method. -- Removed OuterRadius and InnerRadius parameters !!! - Added InitRandomizeUnits() method, taking 3 parameters: -- RandomizeUnits given the value true, will randomize the units upon spawning, false (default) will not randomize the untis. -- OuterRadius is the outer radius of the band where the units will be spawned, if RandomizeUnits is true. -- InnerRadius is the inner radius of the band where the units will not be spawned, if RandomizeUnits is true. - Removed SpawnFunction() method. - Added OnSpawnGroup() method as the new official CallBack function method to catch when a new function will be called. -- Documented OnSpawnGroup() method. - Renamed Limit() method to InitLimit() method. - Renamed Array() method to InitArray() method. - Renamed RandomizeRoute() method to InitRandomizeRoute() method. - Renamed RandomizeTemplate() method to InitRandomizeTemplate() method. - Reviewed all test missions for the changes executed and made adaptions where necessary + re-tests.
2025-10-29 16:58:06 +00:00 · 2016-08-14 21:37:11 +02:00
parent 58124c0709
commit c000675471
152 changed files with 6358 additions and 60766 deletions
--- a/Training/Documentation/Positionable.html
+++ b/Training/Documentation/Positionable.html
@@ -21,7 +21,7 @@
 					<li><a href="Airbase.html">Airbase</a></li>
 					<li><a href="AirbasePolice.html">AirbasePolice</a></li>
 					<li><a href="Base.html">Base</a></li>
-					<li><a href="CARGO.html">CARGO</a></li>
+					<li><a href="Cargo.html">Cargo</a></li>
 					<li><a href="CleanUp.html">CleanUp</a></li>
 					<li><a href="Client.html">Client</a></li>
 					<li><a href="Controllable.html">Controllable</a></li>
@@ -65,6 +65,7 @@
 					<li><a href="Process.html">Process</a></li>
 					<li><a href="Process_Destroy.html">Process_Destroy</a></li>
 					<li><a href="Process_JTAC.html">Process_JTAC</a></li>
+					<li><a href="Process_Pickup.html">Process_Pickup</a></li>
 					<li><a href="Process_Smoke.html">Process_Smoke</a></li>
 					<li><a href="ROUTETASK.html">ROUTETASK</a></li>
 					<li><a href="STAGE.html">STAGE</a></li>
@@ -80,6 +81,7 @@
 					<li><a href="Task_A2G.html">Task_A2G</a></li>
 					<li><a href="Task_Assign.html">Task_Assign</a></li>
 					<li><a href="Task_Client_Menu.html">Task_Client_Menu</a></li>
+					<li><a href="Task_PICKUP.html">Task_PICKUP</a></li>
 					<li><a href="Task_Route.html">Task_Route</a></li>
 					<li><a href="Task_SEAD.html">Task_SEAD</a></li>
 					<li><a href="Unit.html">Unit</a></li>
@@ -97,12 +99,12 @@
   

 <h1>1) <a href="Positionable.html##(POSITIONABLE)">Positionable#POSITIONABLE</a> class, extends <a href="Identifiable.html##(IDENTIFIABLE)">Identifiable#IDENTIFIABLE</a></h1>
-<p>The <a href="Positionable.html##(POSITIONABLE)">Positionable#POSITIONABLE</a> class is a wrapper class to handle the DCS Positionable objects:</p>
+<p>The <a href="Positionable.html##(POSITIONABLE)">Positionable#POSITIONABLE</a> class is a wrapper class to handle the POSITIONABLE objects:</p>

 <ul>
-    <li>Support all DCS Positionable APIs.</li>
-    <li>Enhance with Positionable specific APIs not in the DCS Positionable API set.</li>
-    <li>Manage the "state" of the DCS Positionable.</li>
+    <li>Support all DCS APIs.</li>
+    <li>Enhance with POSITIONABLE specific APIs not in the DCS API set.</li>
+    <li>Manage the "state" of the POSITIONABLE.</li>
 </ul>

 <h2>1.1) POSITIONABLE constructor:</h2>
@@ -153,55 +155,61 @@
 		<tr>
 		<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetAltitude">POSITIONABLE:GetAltitude()</a></td>
 		<td class="summary">
-<p>Returns the altitude of the DCS Positionable.</p>
+<p>Returns the altitude of the POSITIONABLE.</p>
 </td>
 		</tr>
 		<tr>
 		<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetHeading">POSITIONABLE:GetHeading()</a></td>
 		<td class="summary">
-<p>Returns the DCS Positionable heading.</p>
+<p>Returns the POSITIONABLE heading in degrees.</p>
 </td>
 		</tr>
 		<tr>
-		<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetPointVec3">POSITIONABLE:GetPointVec3()</a></td>
+		<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetPointVec2">POSITIONABLE:GetPointVec2()</a></td>
 		<td class="summary">
-<p>Returns the <a href="DCSTypes.html##(Vec3)">DCSTypes#Vec3</a> vector indicating the point in 3D of the DCS Positionable within the mission.</p>
+<p>Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.</p>
 </td>
 		</tr>
 		<tr>
 		<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetPositionVec3">POSITIONABLE:GetPositionVec3()</a></td>
 		<td class="summary">
-<p>Returns the <a href="DCSTypes.html##(Position3)">DCSTypes#Position3</a> position vectors indicating the point and direction vectors in 3D of the DCS Positionable within the mission.</p>
+<p>Returns the <a href="DCSTypes.html##(Position3)">DCSTypes#Position3</a> position vectors indicating the point and direction vectors in 3D of the POSITIONABLE within the mission.</p>
 </td>
 		</tr>
 		<tr>
-		<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetRandomPointVec3">POSITIONABLE:GetRandomPointVec3(Radius)</a></td>
+		<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetRandomVec3">POSITIONABLE:GetRandomVec3(Radius)</a></td>
 		<td class="summary">
-<p>Returns a random <a href="DCSTypes.html##(Vec3)">DCSTypes#Vec3</a> vector within a range, indicating the point in 3D of the DCS Positionable within the mission.</p>
+<p>Returns a random <a href="DCSTypes.html##(Vec3)">DCSTypes#Vec3</a> vector within a range, indicating the point in 3D of the POSITIONABLE within the mission.</p>
 </td>
 		</tr>
 		<tr>
 		<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetVec2">POSITIONABLE:GetVec2()</a></td>
 		<td class="summary">
-<p>Returns the <a href="DCSTypes.html##(Vec2)">DCSTypes#Vec2</a> vector indicating the point in 2D of the DCS Positionable within the mission.</p>
+<p>Returns the <a href="DCSTypes.html##(Vec2)">DCSTypes#Vec2</a> vector indicating the point in 2D of the POSITIONABLE within the mission.</p>
+</td>
+		</tr>
+		<tr>
+		<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetVec3">POSITIONABLE:GetVec3()</a></td>
+		<td class="summary">
+<p>Returns the <a href="DCSTypes.html##(Vec3)">DCSTypes#Vec3</a> vector indicating the 3D vector of the POSITIONABLE within the mission.</p>
 </td>
 		</tr>
 		<tr>
 		<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetVelocity">POSITIONABLE:GetVelocity()</a></td>
 		<td class="summary">
-<p>Returns the DCS Positionable velocity vector.</p>
+<p>Returns the POSITIONABLE velocity vector.</p>
 </td>
 		</tr>
 		<tr>
 		<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetVelocityKMH">POSITIONABLE:GetVelocityKMH()</a></td>
 		<td class="summary">
-<p>Returns the <a href="Unit.html##(UNIT)">Unit#UNIT</a> velocity in km/h.</p>
+<p>Returns the POSITIONABLE velocity in km/h.</p>
 </td>
 		</tr>
 		<tr>
 		<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).InAir">POSITIONABLE:InAir()</a></td>
 		<td class="summary">
-<p>Returns true if the DCS Positionable is in the air.</p>
+<p>Returns true if the POSITIONABLE is in the air.</p>
 </td>
 		</tr>
 		<tr>
@@ -288,20 +296,20 @@
 </dt>
 <dd>
 	
-<p>Returns the altitude of the DCS Positionable.</p>
+<p>Returns the altitude of the POSITIONABLE.</p>

 		<h3>Return values</h3>
 			<ol>
 				<li>
 				
 <p><em><a href="DCSTypes.html##(Distance)">DCSTypes#Distance</a>:</em>
-The altitude of the DCS Positionable.</p>
+The altitude of the POSITIONABLE.</p>

 				</li>
 				<li>
 				
 <p><em>#nil:</em>
-The DCS Positionable is not existing or alive.  </p>
+The POSITIONABLE is not existing or alive.  </p>

 				</li>
 			</ol>
@@ -316,38 +324,38 @@ The DCS Positionable is not existing or alive.  </p>
 </dt>
 <dd>
 	
-<p>Returns the DCS Positionable heading.</p>
+<p>Returns the POSITIONABLE heading in degrees.</p>

 		<h3>Return value</h3>
 				
 <p><em>#number:</em>
-The DCS Positionable heading</p>
+The POSTIONABLE heading</p>

 </dd>
 </dl>
 		<dl class="function">
 <dt>

-<a id="#(POSITIONABLE).GetPointVec3" >
-<strong>POSITIONABLE:GetPointVec3()</strong>
+<a id="#(POSITIONABLE).GetPointVec2" >
+<strong>POSITIONABLE:GetPointVec2()</strong>
 </a>
 </dt>
 <dd>
 	
-<p>Returns the <a href="DCSTypes.html##(Vec3)">DCSTypes#Vec3</a> vector indicating the point in 3D of the DCS Positionable within the mission.</p>
+<p>Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.</p>

 		<h3>Return values</h3>
 			<ol>
 				<li>
 				
-<p><em><a href="DCSTypes.html##(Vec3)">DCSTypes#Vec3</a>:</em>
-The 3D point vector of the DCS Positionable.</p>
+<p><em><a href="Point.html##(POINT_VEC2)">Point#POINT_VEC2</a>:</em>
+The 2D point vector of the POSITIONABLE.</p>

 				</li>
 				<li>
 				
 <p><em>#nil:</em>
-The DCS Positionable is not existing or alive.  </p>
+The POSITIONABLE is not existing or alive.  </p>

 				</li>
 			</ol>
@@ -362,20 +370,20 @@ The DCS Positionable is not existing or alive.  </p>
 </dt>
 <dd>
 	
-<p>Returns the <a href="DCSTypes.html##(Position3)">DCSTypes#Position3</a> position vectors indicating the point and direction vectors in 3D of the DCS Positionable within the mission.</p>
+<p>Returns the <a href="DCSTypes.html##(Position3)">DCSTypes#Position3</a> position vectors indicating the point and direction vectors in 3D of the POSITIONABLE within the mission.</p>

 		<h3>Return values</h3>
 			<ol>
 				<li>
 				
 <p><em><a href="DCSTypes.html##(Position)">DCSTypes#Position</a>:</em>
-The 3D position vectors of the DCS Positionable.</p>
+The 3D position vectors of the POSITIONABLE.</p>

 				</li>
 				<li>
 				
 <p><em>#nil:</em>
-The DCS Positionable is not existing or alive.  </p>
+The POSITIONABLE is not existing or alive.  </p>

 				</li>
 			</ol>
@@ -384,13 +392,13 @@ The DCS Positionable is not existing or alive.  </p>
 		<dl class="function">
 <dt>

-<a id="#(POSITIONABLE).GetRandomPointVec3" >
-<strong>POSITIONABLE:GetRandomPointVec3(Radius)</strong>
+<a id="#(POSITIONABLE).GetRandomVec3" >
+<strong>POSITIONABLE:GetRandomVec3(Radius)</strong>
 </a>
 </dt>
 <dd>
 	
-<p>Returns a random <a href="DCSTypes.html##(Vec3)">DCSTypes#Vec3</a> vector within a range, indicating the point in 3D of the DCS Positionable within the mission.</p>
+<p>Returns a random <a href="DCSTypes.html##(Vec3)">DCSTypes#Vec3</a> vector within a range, indicating the point in 3D of the POSITIONABLE within the mission.</p>

 		<h3>Parameter</h3>
 		<ul>
@@ -405,13 +413,13 @@ The DCS Positionable is not existing or alive.  </p>
 				<li>
 				
 <p><em><a href="DCSTypes.html##(Vec3)">DCSTypes#Vec3</a>:</em>
-The 3D point vector of the DCS Positionable.</p>
+The 3D point vector of the POSITIONABLE.</p>

 				</li>
 				<li>
 				
 <p><em>#nil:</em>
-The DCS Positionable is not existing or alive.  </p>
+The POSITIONABLE is not existing or alive.  </p>

 				</li>
 			</ol>
@@ -426,20 +434,48 @@ The DCS Positionable is not existing or alive.  </p>
 </dt>
 <dd>
 	
-<p>Returns the <a href="DCSTypes.html##(Vec2)">DCSTypes#Vec2</a> vector indicating the point in 2D of the DCS Positionable within the mission.</p>
+<p>Returns the <a href="DCSTypes.html##(Vec2)">DCSTypes#Vec2</a> vector indicating the point in 2D of the POSITIONABLE within the mission.</p>

 		<h3>Return values</h3>
 			<ol>
 				<li>
 				
 <p><em><a href="DCSTypes.html##(Vec2)">DCSTypes#Vec2</a>:</em>
-The 2D point vector of the DCS Positionable.</p>
+The 2D point vector of the POSITIONABLE.</p>

 				</li>
 				<li>
 				
 <p><em>#nil:</em>
-The DCS Positionable is not existing or alive.  </p>
+The POSITIONABLE is not existing or alive.  </p>
+
+				</li>
+			</ol>
+</dd>
+</dl>
+		<dl class="function">
+<dt>
+
+<a id="#(POSITIONABLE).GetVec3" >
+<strong>POSITIONABLE:GetVec3()</strong>
+</a>
+</dt>
+<dd>
+	
+<p>Returns the <a href="DCSTypes.html##(Vec3)">DCSTypes#Vec3</a> vector indicating the 3D vector of the POSITIONABLE within the mission.</p>
+
+		<h3>Return values</h3>
+			<ol>
+				<li>
+				
+<p><em><a href="DCSTypes.html##(Vec3)">DCSTypes#Vec3</a>:</em>
+The 3D point vector of the POSITIONABLE.</p>
+
+				</li>
+				<li>
+				
+<p><em>#nil:</em>
+The POSITIONABLE is not existing or alive.  </p>

 				</li>
 			</ol>
@@ -454,7 +490,7 @@ The DCS Positionable is not existing or alive.  </p>
 </dt>
 <dd>
 	
-<p>Returns the DCS Positionable velocity vector.</p>
+<p>Returns the POSITIONABLE velocity vector.</p>

 		<h3>Return values</h3>
 			<ol>
@@ -467,7 +503,7 @@ The velocity vector</p>
 				<li>
 				
 <p><em>#nil:</em>
-The DCS Positionable is not existing or alive.  </p>
+The POSITIONABLE is not existing or alive.  </p>

 				</li>
 			</ol>
@@ -482,7 +518,7 @@ The DCS Positionable is not existing or alive.  </p>
 </dt>
 <dd>
 	
-<p>Returns the <a href="Unit.html##(UNIT)">Unit#UNIT</a> velocity in km/h.</p>
+<p>Returns the POSITIONABLE velocity in km/h.</p>

 		<h3>Return values</h3>
 			<ol>
@@ -495,7 +531,7 @@ The velocity in km/h</p>
 				<li>
 				
 <p><em>#nil:</em>
-The DCS Positionable is not existing or alive.  </p>
+The POSITIONABLE is not existing or alive.  </p>

 				</li>
 			</ol>
@@ -510,7 +546,7 @@ The DCS Positionable is not existing or alive.  </p>
 </dt>
 <dd>
 	
-<p>Returns true if the DCS Positionable is in the air.</p>
+<p>Returns true if the POSITIONABLE is in the air.</p>

 		<h3>Return values</h3>
 			<ol>
@@ -523,7 +559,7 @@ true if in the air.</p>
 				<li>
 				
 <p><em>#nil:</em>
-The DCS Positionable is not existing or alive.  </p>
+The POSITIONABLE is not existing or alive.  </p>

 				</li>
 			</ol>
@@ -551,7 +587,7 @@ true if Positionable is above a runway.</p>
 				<li>
 				
 <p><em>#nil:</em>
-The DCS Positionable is not existing or alive.  </p>
+The POSITIONABLE is not existing or alive.  </p>

 				</li>
 			</ol>
@@ -573,7 +609,7 @@ The DCS Positionable is not existing or alive.  </p>
 				<li>
 				
 <p><code><em><a href="DCSPositionable.html##(Positionable)">DCSPositionable#Positionable</a> PositionableName </em></code>: 
-The DCS Positionable name</p>
+The POSITIONABLE name</p>

 				</li>
 		</ul>