Merge branch 'master' into funkyfranky

2025-08-15 10:47:21 +00:00 · 2017-09-11 23:27:04 +02:00
parent 217ded3492 eac57ae0a3
commit fa8a9b52fe
15 changed files with 507 additions and 32 deletions
--- a/docs/Documentation/AI_A2A.html
+++ b/docs/Documentation/AI_A2A.html
@@ -662,6 +662,7 @@
 		<dl class="function">
 <dt>

+		<em>#number</em>
 <a id="#(AI_A2A).IdleCount" >
 <strong>AI_A2A.IdleCount</strong>
 </a>
--- a/docs/Documentation/Cargo.html
+++ b/docs/Documentation/Cargo.html
@@ -3543,6 +3543,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
@@ -1097,7 +1097,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>
@@ -1151,7 +1151,10 @@ function below will use the range 1-7 just in case</p>
 		<dl class="function">
 <dt>

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

+		<em>#number</em>
 <a id="#(DETECTION_BASE).DetectedItemCount" >
 <strong>DETECTION_BASE.DetectedItemCount</strong>
 </a>
@@ -2479,6 +2480,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>
--- a/docs/Documentation/Point.html
+++ b/docs/Documentation/Point.html
@@ -316,6 +316,30 @@
 		<td class="name" nowrap="nowrap"><a href="##(COORDINATE).IsLOS">COORDINATE:IsLOS(ToCoordinate)</a></td>
 		<td class="summary">
 <p>Returns if a Coordinate has Line of Sight (LOS) with the ToCoordinate.</p>
+</td>
+		</tr>
+		<tr>
+		<td class="name" nowrap="nowrap"><a href="##(COORDINATE).MarkToAll">COORDINATE:MarkToAll(MarkText)</a></td>
+		<td class="summary">
+<p>Mark to All</p>
+</td>
+		</tr>
+		<tr>
+		<td class="name" nowrap="nowrap"><a href="##(COORDINATE).MarkToCoalition">COORDINATE:MarkToCoalition(MarkText, Coalition)</a></td>
+		<td class="summary">
+<p>Mark to Coalition</p>
+</td>
+		</tr>
+		<tr>
+		<td class="name" nowrap="nowrap"><a href="##(COORDINATE).MarkToCoalitionBlue">COORDINATE:MarkToCoalitionBlue(MarkText)</a></td>
+		<td class="summary">
+<p>Mark to Blue Coalition</p>
+</td>
+		</tr>
+		<tr>
+		<td class="name" nowrap="nowrap"><a href="##(COORDINATE).MarkToCoalitionRed">COORDINATE:MarkToCoalitionRed(MarkText)</a></td>
+		<td class="summary">
+<p>Mark to Red Coalition</p>
 </td>
 		</tr>
 		<tr>
@@ -334,6 +358,12 @@
 		<td class="name" nowrap="nowrap"><a href="##(COORDINATE).NewFromVec3">COORDINATE:NewFromVec3(Vec3)</a></td>
 		<td class="summary">
 <p>Create a new COORDINATE object from  Vec3 coordinates.</p>
+</td>
+		</tr>
+		<tr>
+		<td class="name" nowrap="nowrap"><a href="##(COORDINATE).RemoveMark">COORDINATE:RemoveMark(MarkID)</a></td>
+		<td class="summary">
+<p>Remove a mark</p>
 </td>
 		</tr>
 		<tr>
@@ -863,6 +893,20 @@
 </ul>


+<h2>Markings</h2>
+
+<p>Place markers (text boxes with clarifications for briefings, target locations or any other reference point) on the map for all players, coalitions or specific groups:</p>
+
+<ul>
+    <li><a href="##(COORDINATE).MarkToAll">COORDINATE.MarkToAll</a>(): Place a mark to all players.</li>
+    <li><a href="##(COORDINATE).MarkToCoalition">COORDINATE.MarkToCoalition</a>(): Place a mark to a coalition.</li>
+    <li><a href="##(COORDINATE).MarkToCoalitionRed">COORDINATE.MarkToCoalitionRed</a>(): Place a mark to the red coalition.</li>
+    <li><a href="##(COORDINATE).MarkToCoalitionBlue">COORDINATE.MarkToCoalitionBlue</a>(): Place a mark to the blue coalition.</li>
+    <li><a href="##(COORDINATE).MarkToGroup">COORDINATE.MarkToGroup</a>(): Place a mark to a group (needs to have a client in it or a CA group (CA group is bugged)).</li>
+    <li><a href="##(COORDINATE).RemoveMark">COORDINATE.RemoveMark</a>(): Removes a mark from the map.</li>
+</ul>
+
+
 <h2>3D calculation methods</h2>

 <p>Various calculation methods exist to use or manipulate 3D space. Find below a short description of each method:</p>
@@ -1701,6 +1745,135 @@ true If the ToCoordinate has LOS with the Coordinate, otherwise false.</p>
 		<dl class="function">
 <dt>

+<a id="#(COORDINATE).MarkToAll" >
+<strong>COORDINATE:MarkToAll(MarkText)</strong>
+</a>
+</dt>
+<dd>
+	
+<p>Mark to All</p>
+
+		<h3>Parameter</h3>
+		<ul>
+				<li>
+				
+<p><code><em>#string MarkText </em></code>: 
+Free format text that shows the marking clarification.</p>
+
+				</li>
+		</ul>
+		<h3>Return value</h3>
+				
+<p><em>#number:</em>
+The resulting Mark ID which is a number.</p>
+
+			<h3>Usage:</h3>
+		<pre class="example"><code>  local TargetCoord = TargetGroup:GetCoordinate()
+  local MarkID = TargetCoord:MarkToAll( "This is a target for all players" )</code></pre>
+
+</dd>
+</dl>
+		<dl class="function">
+<dt>
+
+<a id="#(COORDINATE).MarkToCoalition" >
+<strong>COORDINATE:MarkToCoalition(MarkText, Coalition)</strong>
+</a>
+</dt>
+<dd>
+	
+<p>Mark to Coalition</p>
+
+		<h3>Parameters</h3>
+		<ul>
+				<li>
+				
+<p><code><em>#string MarkText </em></code>: 
+Free format text that shows the marking clarification.</p>
+
+				</li>
+				<li>
+				
+<p><code><em> Coalition </em></code>: </p>
+
+				</li>
+		</ul>
+		<h3>Return value</h3>
+				
+<p><em>#number:</em>
+The resulting Mark ID which is a number.</p>
+
+			<h3>Usage:</h3>
+		<pre class="example"><code>  local TargetCoord = TargetGroup:GetCoordinate()
+  local MarkID = TargetCoord:MarkToCoalition( "This is a target for the red coalition", coalition.side.RED )</code></pre>
+
+</dd>
+</dl>
+		<dl class="function">
+<dt>
+
+<a id="#(COORDINATE).MarkToCoalitionBlue" >
+<strong>COORDINATE:MarkToCoalitionBlue(MarkText)</strong>
+</a>
+</dt>
+<dd>
+	
+<p>Mark to Blue Coalition</p>
+
+		<h3>Parameter</h3>
+		<ul>
+				<li>
+				
+<p><code><em>#string MarkText </em></code>: 
+Free format text that shows the marking clarification.</p>
+
+				</li>
+		</ul>
+		<h3>Return value</h3>
+				
+<p><em>#number:</em>
+The resulting Mark ID which is a number.</p>
+
+			<h3>Usage:</h3>
+		<pre class="example"><code>  local TargetCoord = TargetGroup:GetCoordinate()
+  local MarkID = TargetCoord:MarkToCoalitionBlue( "This is a target for the blue coalition" )</code></pre>
+
+</dd>
+</dl>
+		<dl class="function">
+<dt>
+
+<a id="#(COORDINATE).MarkToCoalitionRed" >
+<strong>COORDINATE:MarkToCoalitionRed(MarkText)</strong>
+</a>
+</dt>
+<dd>
+	
+<p>Mark to Red Coalition</p>
+
+		<h3>Parameter</h3>
+		<ul>
+				<li>
+				
+<p><code><em>#string MarkText </em></code>: 
+Free format text that shows the marking clarification.</p>
+
+				</li>
+		</ul>
+		<h3>Return value</h3>
+				
+<p><em>#number:</em>
+The resulting Mark ID which is a number.</p>
+
+			<h3>Usage:</h3>
+		<pre class="example"><code>  local TargetCoord = TargetGroup:GetCoordinate()
+  local MarkID = TargetCoord:MarkToCoalitionRed( "This is a target for the red coalition" )</code></pre>
+
+</dd>
+</dl>
+		<dl class="function">
+<dt>
+
 <a id="#(COORDINATE).New" >
 <strong>COORDINATE:New(x, y, z)</strong>
 </a>
@@ -1795,6 +1968,35 @@ The Vec3 point.</p>
 <p><em><a href="##(COORDINATE)">#COORDINATE</a>:</em></p>


+</dd>
+</dl>
+		<dl class="function">
+<dt>
+
+<a id="#(COORDINATE).RemoveMark" >
+<strong>COORDINATE:RemoveMark(MarkID)</strong>
+</a>
+</dt>
+<dd>
+	
+<p>Remove a mark</p>
+
+		<h3>Parameter</h3>
+		<ul>
+				<li>
+				
+<p><code><em>#number MarkID </em></code>: 
+The ID of the mark to be removed.</p>
+
+				</li>
+		</ul>
+			<h3>Usage:</h3>
+		<pre class="example"><code>  local TargetCoord = TargetGroup:GetCoordinate()
+  local MarkGroup = GROUP:FindByName( "AttackGroup" )
+  local MarkID = TargetCoord:MarkToGroup( "This is a target for the attack group", AttackGroup )
+  &lt;&lt;&lt; logic &gt;&gt;&gt;
+  RemoveMark( MarkID ) -- The mark is now removed</code></pre>
+
 </dd>
 </dl>
 		<dl class="function">
@@ -2937,7 +3139,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
@@ -823,6 +823,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>
@@ -2195,9 +2201,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">
@@ -2736,6 +2739,9 @@ when nothing was spawned.</p>
 	


+	
+<p> Overwrite unit names by default with group name.</p>
+
 </dd>
 </dl>
 		<dl class="function">
@@ -3737,6 +3743,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/SpawnStatic.html
+++ b/docs/Documentation/SpawnStatic.html
@@ -437,6 +437,7 @@ 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/Utils.html
+++ b/docs/Documentation/Utils.html
@@ -237,6 +237,12 @@ which are excellent tools to be reused in an OO environment!.</p>
 		<td class="name" nowrap="nowrap"><a href="##(UTILS).FeetToMeters">UTILS.FeetToMeters(feet)</a></td>
 		<td class="summary">

+</td>
+		</tr>
+		<tr>
+		<td class="name" nowrap="nowrap"><a href="##(UTILS).GetMarkID">UTILS.GetMarkID()</a></td>
+		<td class="summary">
+
 </td>
 		</tr>
 		<tr>
@@ -333,6 +339,12 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
 		<td class="name" nowrap="nowrap"><a href="##(UTILS).ToRadian">UTILS.ToRadian(angle)</a></td>
 		<td class="summary">

+</td>
+		</tr>
+		<tr>
+		<td class="name" nowrap="nowrap"><a href="##(UTILS)._MarkID">UTILS._MarkID</a></td>
+		<td class="summary">
+
 </td>
 		</tr>
 		<tr>
@@ -638,6 +650,22 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
 		<dl class="function">
 <dt>

+<a id="#(UTILS).GetMarkID" >
+<strong>UTILS.GetMarkID()</strong>
+</a>
+</dt>
+<dd>
+	
+
+
+	
+<p> get a new mark ID for markings</p>
+
+</dd>
+</dl>
+		<dl class="function">
+<dt>
+
 <a id="#(UTILS).IsInstanceOf" >
 <strong>UTILS.IsInstanceOf(object, className)</strong>
 </a>
@@ -944,6 +972,20 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte

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