Documentation

This commit is contained in:
FlightControl
2017-05-23 22:20:29 +02:00
parent f6a26e3723
commit fb1e9972a5
80 changed files with 5769 additions and 1508 deletions

View File

@@ -75,6 +75,7 @@
<li><a href="Scoring.html">Scoring</a></li>
<li><a href="Sead.html">Sead</a></li>
<li><a href="Set.html">Set</a></li>
<li><a href="Settings.html">Settings</a></li>
<li><a href="Smoke.html">Smoke</a></li>
<li><a href="Spawn.html">Spawn</a></li>
<li><a href="SpawnStatic.html">SpawnStatic</a></li>
@@ -82,6 +83,8 @@
<li><a href="Static.html">Static</a></li>
<li><a href="StaticObject.html">StaticObject</a></li>
<li><a href="Task.html">Task</a></li>
<li><a href="Task_A2A.html">Task_A2A</a></li>
<li><a href="Task_A2A_Dispatcher.html">Task_A2A_Dispatcher</a></li>
<li>Task_A2G</li>
<li><a href="Task_A2G_Dispatcher.html">Task_A2G_Dispatcher</a></li>
<li><a href="Task_Cargo.html">Task_Cargo</a></li>
@@ -218,7 +221,7 @@ The TASK_A2G is implemented using a <a href="Statemachine.html##(FSM_TASK)">Stat
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G).GetRendezVousPointVec2">TASK_A2G:GetRendezVousPointVec2(TaskUnit)</a></td>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G).GetRendezVousCoordinate">TASK_A2G:GetRendezVousCoordinate(TaskUnit)</a></td>
<td class="summary">
</td>
@@ -230,7 +233,7 @@ The TASK_A2G is implemented using a <a href="Statemachine.html##(FSM_TASK)">Stat
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G).GetTargetPointVec2">TASK_A2G:GetTargetPointVec2(TaskUnit)</a></td>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G).GetTargetCoordinate">TASK_A2G:GetTargetCoordinate(TaskUnit)</a></td>
<td class="summary">
</td>
@@ -254,7 +257,7 @@ The TASK_A2G is implemented using a <a href="Statemachine.html##(FSM_TASK)">Stat
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G).SetRendezVousPointVec2">TASK_A2G:SetRendezVousPointVec2(RendezVousPointVec2, RendezVousRange, TaskUnit)</a></td>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G).SetRendezVousCoordinate">TASK_A2G:SetRendezVousCoordinate(RendezVousCoordinate, RendezVousRange, TaskUnit)</a></td>
<td class="summary">
</td>
@@ -278,7 +281,7 @@ The TASK_A2G is implemented using a <a href="Statemachine.html##(FSM_TASK)">Stat
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G).SetTargetPointVec2">TASK_A2G:SetTargetPointVec2(TargetPointVec2, TaskUnit)</a></td>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G).SetTargetCoordinate">TASK_A2G:SetTargetCoordinate(TargetCoordinate, TaskUnit)</a></td>
<td class="summary">
</td>
@@ -459,8 +462,8 @@ The TASK_A2G is implemented using a <a href="Statemachine.html##(FSM_TASK)">Stat
<dl class="function">
<dt>
<a id="#(TASK_A2G).GetRendezVousPointVec2" >
<strong>TASK_A2G:GetRendezVousPointVec2(TaskUnit)</strong>
<a id="#(TASK_A2G).GetRendezVousCoordinate" >
<strong>TASK_A2G:GetRendezVousCoordinate(TaskUnit)</strong>
</a>
</dt>
<dd>
@@ -479,8 +482,8 @@ The TASK_A2G is implemented using a <a href="Statemachine.html##(FSM_TASK)">Stat
<ol>
<li>
<p><em><a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>:</em>
The PointVec2 object referencing to the 2D point where the RendezVous point is located on the map.</p>
<p><em><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>:</em>
The Coordinate object referencing to the 2D point where the RendezVous point is located on the map.</p>
</li>
<li>
@@ -521,8 +524,8 @@ The Zone object where the RendezVous is located on the map.</p>
<dl class="function">
<dt>
<a id="#(TASK_A2G).GetTargetPointVec2" >
<strong>TASK_A2G:GetTargetPointVec2(TaskUnit)</strong>
<a id="#(TASK_A2G).GetTargetCoordinate" >
<strong>TASK_A2G:GetTargetCoordinate(TaskUnit)</strong>
</a>
</dt>
<dd>
@@ -539,8 +542,8 @@ The Zone object where the RendezVous is located on the map.</p>
</ul>
<h3>Return value</h3>
<p><em><a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>:</em>
The PointVec2 object where the Target is located on the map.</p>
<p><em><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>:</em>
The Coordinate object where the Target is located on the map.</p>
</dd>
</dl>
@@ -682,8 +685,8 @@ The penalty in points.</p>
<dl class="function">
<dt>
<a id="#(TASK_A2G).SetRendezVousPointVec2" >
<strong>TASK_A2G:SetRendezVousPointVec2(RendezVousPointVec2, RendezVousRange, TaskUnit)</strong>
<a id="#(TASK_A2G).SetRendezVousCoordinate" >
<strong>TASK_A2G:SetRendezVousCoordinate(RendezVousCoordinate, RendezVousRange, TaskUnit)</strong>
</a>
</dt>
<dd>
@@ -694,8 +697,8 @@ The penalty in points.</p>
<ul>
<li>
<p><code><em><a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a> RendezVousPointVec2 </em></code>:
The PointVec2 object referencing to the 2D point where the RendezVous point is located on the map.</p>
<p><code><em><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a> RendezVousCoordinate </em></code>:
The Coordinate object referencing to the 2D point where the RendezVous point is located on the map.</p>
</li>
<li>
@@ -818,8 +821,8 @@ The score in points.</p>
<dl class="function">
<dt>
<a id="#(TASK_A2G).SetTargetPointVec2" >
<strong>TASK_A2G:SetTargetPointVec2(TargetPointVec2, TaskUnit)</strong>
<a id="#(TASK_A2G).SetTargetCoordinate" >
<strong>TASK_A2G:SetTargetCoordinate(TargetCoordinate, TaskUnit)</strong>
</a>
</dt>
<dd>
@@ -830,8 +833,8 @@ The score in points.</p>
<ul>
<li>
<p><code><em><a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a> TargetPointVec2 </em></code>:
The PointVec2 object where the Target is located on the map.</p>
<p><code><em><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a> TargetCoordinate </em></code>:
The Coordinate object where the Target is located on the map.</p>
</li>
<li>