Documentation

This commit is contained in:
FlightControl
2017-06-24 16:21:43 +02:00
parent 70f2c0051a
commit 1b36cee3b6
13 changed files with 1582 additions and 340 deletions

View File

@@ -192,12 +192,6 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
<td class="name" nowrap="nowrap"><a href="##(TASK_A2A).New">TASK_A2A:New(Mission, SetAttack, TaskName, UnitSetTargets, TargetDistance, TargetZone, TargetSetUnit, TaskType, TaskBriefing)</a></td>
<td class="summary">
<p>Instantiates a new TASK_A2A.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2A).SetPenaltyOnFailed">TASK_A2A:SetPenaltyOnFailed(Text, Penalty, TaskUnit)</a></td>
<td class="summary">
<p>Set a penalty when the A2A attack has failed.</p>
</td>
</tr>
<tr>
@@ -210,18 +204,6 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
<td class="name" nowrap="nowrap"><a href="##(TASK_A2A).SetRendezVousZone">TASK_A2A:SetRendezVousZone(RendezVousZone, TaskUnit)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2A).SetScoreOnDestroy">TASK_A2A:SetScoreOnDestroy(Text, Score, TaskUnit)</a></td>
<td class="summary">
<p>Set a score when a target in scope of the A2A attack, has been destroyed .</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2A).SetScoreOnSuccess">TASK_A2A:SetScoreOnSuccess(Text, Score, TaskUnit)</a></td>
<td class="summary">
<p>Set a score when all the targets in scope of the A2A attack, have been destroyed.</p>
</td>
</tr>
<tr>
@@ -250,12 +232,36 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
<td class="name" nowrap="nowrap"><a href="##(TASK_A2A_ENGAGE).New">TASK_A2A_ENGAGE:New(Mission, SetGroup, TaskName, TargetSetUnit, TaskBriefing)</a></td>
<td class="summary">
<p>Instantiates a new TASK<em>A2A</em>ENGAGE.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2A_ENGAGE).SetScoreOnFail">TASK_A2A_ENGAGE:SetScoreOnFail(PlayerName, Penalty, TaskUnit)</a></td>
<td class="summary">
<p>Set a penalty when the A2A attack has failed.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2A_ENGAGE).SetScoreOnProgress">TASK_A2A_ENGAGE:SetScoreOnProgress(PlayerName, Score, TaskUnit)</a></td>
<td class="summary">
<p>Set a score when a target in scope of the A2A attack, has been destroyed .</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2A_ENGAGE).SetScoreOnSuccess">TASK_A2A_ENGAGE:SetScoreOnSuccess(PlayerName, Score, TaskUnit)</a></td>
<td class="summary">
<p>Set a score when all the targets in scope of the A2A attack, have been destroyed.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2A_ENGAGE).TargetSetUnit">TASK_A2A_ENGAGE.TargetSetUnit</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2A_ENGAGE).onafterGoal">TASK_A2A_ENGAGE:onafterGoal(TaskUnit, From, Event, To)</a></td>
<td class="summary">
</td>
</tr>
</table>
@@ -266,12 +272,36 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
<td class="name" nowrap="nowrap"><a href="##(TASK_A2A_INTERCEPT).New">TASK_A2A_INTERCEPT:New(Mission, SetGroup, TaskName, TargetSetUnit, TaskBriefing)</a></td>
<td class="summary">
<p>Instantiates a new TASK<em>A2A</em>INTERCEPT.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2A_INTERCEPT).SetScoreOnFail">TASK_A2A_INTERCEPT:SetScoreOnFail(PlayerName, Penalty, TaskUnit)</a></td>
<td class="summary">
<p>Set a penalty when the A2A attack has failed.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2A_INTERCEPT).SetScoreOnProgress">TASK_A2A_INTERCEPT:SetScoreOnProgress(PlayerName, Score, TaskUnit)</a></td>
<td class="summary">
<p>Set a score when a target in scope of the A2A attack, has been destroyed .</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2A_INTERCEPT).SetScoreOnSuccess">TASK_A2A_INTERCEPT:SetScoreOnSuccess(PlayerName, Score, TaskUnit)</a></td>
<td class="summary">
<p>Set a score when all the targets in scope of the A2A attack, have been destroyed.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2A_INTERCEPT).TargetSetUnit">TASK_A2A_INTERCEPT.TargetSetUnit</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2A_INTERCEPT).onafterGoal">TASK_A2A_INTERCEPT:onafterGoal(TaskUnit, From, Event, To)</a></td>
<td class="summary">
</td>
</tr>
</table>
@@ -282,12 +312,36 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
<td class="name" nowrap="nowrap"><a href="##(TASK_A2A_SWEEP).New">TASK_A2A_SWEEP:New(Mission, SetGroup, TaskName, TargetSetUnit, TaskBriefing)</a></td>
<td class="summary">
<p>Instantiates a new TASK<em>A2A</em>SWEEP.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2A_SWEEP).SetScoreOnFail">TASK_A2A_SWEEP:SetScoreOnFail(PlayerName, Penalty, TaskUnit)</a></td>
<td class="summary">
<p>Set a penalty when the A2A attack has failed.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2A_SWEEP).SetScoreOnProgress">TASK_A2A_SWEEP:SetScoreOnProgress(PlayerName, Score, TaskUnit)</a></td>
<td class="summary">
<p>Set a score when a target in scope of the A2A attack, has been destroyed .</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2A_SWEEP).SetScoreOnSuccess">TASK_A2A_SWEEP:SetScoreOnSuccess(PlayerName, Score, TaskUnit)</a></td>
<td class="summary">
<p>Set a score when all the targets in scope of the A2A attack, have been destroyed.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2A_SWEEP).TargetSetUnit">TASK_A2A_SWEEP.TargetSetUnit</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2A_SWEEP).onafterGoal">TASK_A2A_SWEEP:onafterGoal(TaskUnit, From, Event, To)</a></td>
<td class="summary">
</td>
</tr>
</table>
@@ -617,44 +671,6 @@ If the TargetZone parameter is specified, the player will be routed to the cente
<p><em><a href="##(TASK_A2A)">#TASK_A2A</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_A2A).SetPenaltyOnFailed" >
<strong>TASK_A2A:SetPenaltyOnFailed(Text, Penalty, TaskUnit)</strong>
</a>
</dt>
<dd>
<p>Set a penalty when the A2A attack has failed.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string Text </em></code>:
The text to display to the player, when the A2A attack has failed.</p>
</li>
<li>
<p><code><em>#number Penalty </em></code>:
The penalty in points.</p>
</li>
<li>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> TaskUnit </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(TASK_A2A)">#TASK_A2A</a>:</em></p>
</dd>
</dl>
<dl class="function">
@@ -720,82 +736,6 @@ The Zone object where the RendezVous is located on the map.</p>
<dl class="function">
<dt>
<a id="#(TASK_A2A).SetScoreOnDestroy" >
<strong>TASK_A2A:SetScoreOnDestroy(Text, Score, TaskUnit)</strong>
</a>
</dt>
<dd>
<p>Set a score when a target in scope of the A2A attack, has been destroyed .</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string Text </em></code>:
The text to display to the player, when the target has been destroyed.</p>
</li>
<li>
<p><code><em>#number Score </em></code>:
The score in points.</p>
</li>
<li>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> TaskUnit </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(TASK_A2A)">#TASK_A2A</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_A2A).SetScoreOnSuccess" >
<strong>TASK_A2A:SetScoreOnSuccess(Text, Score, TaskUnit)</strong>
</a>
</dt>
<dd>
<p>Set a score when all the targets in scope of the A2A attack, have been destroyed.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string Text </em></code>:
The text to display to the player, when all targets hav been destroyed.</p>
</li>
<li>
<p><code><em>#number Score </em></code>:
The score in points.</p>
</li>
<li>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> TaskUnit </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(TASK_A2A)">#TASK_A2A</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_A2A).SetTargetCoordinate" >
<strong>TASK_A2A:SetTargetCoordinate(TargetCoordinate, TaskUnit)</strong>
</a>
@@ -924,6 +864,120 @@ The briefing of the task.</p>
<p><em><a href="##(TASK_A2A_ENGAGE)">#TASK<em>A2A</em>ENGAGE</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_A2A_ENGAGE).SetScoreOnFail" >
<strong>TASK_A2A_ENGAGE:SetScoreOnFail(PlayerName, Penalty, TaskUnit)</strong>
</a>
</dt>
<dd>
<p>Set a penalty when the A2A attack has failed.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string PlayerName </em></code>:
The name of the player.</p>
</li>
<li>
<p><code><em>#number Penalty </em></code>:
The penalty in points, must be a negative value!</p>
</li>
<li>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> TaskUnit </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(TASK_A2A_ENGAGE)">#TASK<em>A2A</em>ENGAGE</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_A2A_ENGAGE).SetScoreOnProgress" >
<strong>TASK_A2A_ENGAGE:SetScoreOnProgress(PlayerName, Score, TaskUnit)</strong>
</a>
</dt>
<dd>
<p>Set a score when a target in scope of the A2A attack, has been destroyed .</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string PlayerName </em></code>:
The name of the player.</p>
</li>
<li>
<p><code><em>#number Score </em></code>:
The score in points to be granted when task process has been achieved.</p>
</li>
<li>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> TaskUnit </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(TASK_A2A_ENGAGE)">#TASK<em>A2A</em>ENGAGE</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_A2A_ENGAGE).SetScoreOnSuccess" >
<strong>TASK_A2A_ENGAGE:SetScoreOnSuccess(PlayerName, Score, TaskUnit)</strong>
</a>
</dt>
<dd>
<p>Set a score when all the targets in scope of the A2A attack, have been destroyed.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string PlayerName </em></code>:
The name of the player.</p>
</li>
<li>
<p><code><em>#number Score </em></code>:
The score in points.</p>
</li>
<li>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> TaskUnit </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(TASK_A2A_ENGAGE)">#TASK<em>A2A</em>ENGAGE</a>:</em></p>
</dd>
</dl>
<dl class="function">
@@ -938,6 +992,42 @@ self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_A2A_ENGAGE).onafterGoal" >
<strong>TASK_A2A_ENGAGE: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>
@@ -990,8 +1080,122 @@ The briefing of the task.</p>
</ul>
<h3>Return value</h3>
<p><em><a href="##(TASK_A2A_INTERCEPT)">#TASK<em>A2A</em>INTERCEPT</a>:</em>
self</p>
<p><em><a href="##(TASK_A2A_INTERCEPT)">#TASK<em>A2A</em>INTERCEPT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_A2A_INTERCEPT).SetScoreOnFail" >
<strong>TASK_A2A_INTERCEPT:SetScoreOnFail(PlayerName, Penalty, TaskUnit)</strong>
</a>
</dt>
<dd>
<p>Set a penalty when the A2A attack has failed.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string PlayerName </em></code>:
The name of the player.</p>
</li>
<li>
<p><code><em>#number Penalty </em></code>:
The penalty in points, must be a negative value!</p>
</li>
<li>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> TaskUnit </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(TASK_A2A_INTERCEPT)">#TASK<em>A2A</em>INTERCEPT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_A2A_INTERCEPT).SetScoreOnProgress" >
<strong>TASK_A2A_INTERCEPT:SetScoreOnProgress(PlayerName, Score, TaskUnit)</strong>
</a>
</dt>
<dd>
<p>Set a score when a target in scope of the A2A attack, has been destroyed .</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string PlayerName </em></code>:
The name of the player.</p>
</li>
<li>
<p><code><em>#number Score </em></code>:
The score in points to be granted when task process has been achieved.</p>
</li>
<li>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> TaskUnit </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(TASK_A2A_INTERCEPT)">#TASK<em>A2A</em>INTERCEPT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_A2A_INTERCEPT).SetScoreOnSuccess" >
<strong>TASK_A2A_INTERCEPT:SetScoreOnSuccess(PlayerName, Score, TaskUnit)</strong>
</a>
</dt>
<dd>
<p>Set a score when all the targets in scope of the A2A attack, have been destroyed.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string PlayerName </em></code>:
The name of the player.</p>
</li>
<li>
<p><code><em>#number Score </em></code>:
The score in points.</p>
</li>
<li>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> TaskUnit </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(TASK_A2A_INTERCEPT)">#TASK<em>A2A</em>INTERCEPT</a>:</em></p>
</dd>
</dl>
@@ -1007,6 +1211,42 @@ self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_A2A_INTERCEPT).onafterGoal" >
<strong>TASK_A2A_INTERCEPT: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>
@@ -1062,6 +1302,120 @@ The briefing of the task.</p>
<p><em><a href="##(TASK_A2A_SWEEP)">#TASK<em>A2A</em>SWEEP</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_A2A_SWEEP).SetScoreOnFail" >
<strong>TASK_A2A_SWEEP:SetScoreOnFail(PlayerName, Penalty, TaskUnit)</strong>
</a>
</dt>
<dd>
<p>Set a penalty when the A2A attack has failed.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string PlayerName </em></code>:
The name of the player.</p>
</li>
<li>
<p><code><em>#number Penalty </em></code>:
The penalty in points, must be a negative value!</p>
</li>
<li>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> TaskUnit </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(TASK_A2A_SWEEP)">#TASK<em>A2A</em>SWEEP</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_A2A_SWEEP).SetScoreOnProgress" >
<strong>TASK_A2A_SWEEP:SetScoreOnProgress(PlayerName, Score, TaskUnit)</strong>
</a>
</dt>
<dd>
<p>Set a score when a target in scope of the A2A attack, has been destroyed .</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string PlayerName </em></code>:
The name of the player.</p>
</li>
<li>
<p><code><em>#number Score </em></code>:
The score in points to be granted when task process has been achieved.</p>
</li>
<li>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> TaskUnit </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(TASK_A2A_SWEEP)">#TASK<em>A2A</em>SWEEP</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_A2A_SWEEP).SetScoreOnSuccess" >
<strong>TASK_A2A_SWEEP:SetScoreOnSuccess(PlayerName, Score, TaskUnit)</strong>
</a>
</dt>
<dd>
<p>Set a score when all the targets in scope of the A2A attack, have been destroyed.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string PlayerName </em></code>:
The name of the player.</p>
</li>
<li>
<p><code><em>#number Score </em></code>:
The score in points.</p>
</li>
<li>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> TaskUnit </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(TASK_A2A_SWEEP)">#TASK<em>A2A</em>SWEEP</a>:</em></p>
</dd>
</dl>
<dl class="function">
@@ -1076,6 +1430,42 @@ self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_A2A_SWEEP).onafterGoal" >
<strong>TASK_A2A_SWEEP: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>