Documentation

This commit is contained in:
FlightControl_Master
2017-11-22 06:23:58 +01:00
parent dd58838983
commit b7183023c9
95 changed files with 514 additions and 876 deletions

View File

@@ -1,6 +1,6 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head><!-- Global site tag (gtag.js) - Google Analytics --><script async src="https://www.googletagmanager.com/gtag/js?id=UA-97385487-1"></script><script>window.dataLayer = window.dataLayer || [];function gtag(){dataLayer.push(arguments);}gtag('js', new Date());gtag('config', 'UA-97385487-1');</script>
<head>
<link rel="stylesheet" href="stylesheet.css" type="text/css"/>
</head>
<body>
@@ -215,12 +215,30 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G).GetTargetZone">TASK_A2G:GetTargetZone(TaskUnit)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G).InitialTargets">TASK_A2G.InitialTargets</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G).InitialThreat">TASK_A2G.InitialThreat</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G).New">TASK_A2G:New(Mission, SetGroup, TaskName, UnitSetTargets, TargetDistance, TargetZone, TargetSetUnit, TaskType, TaskBriefing)</a></td>
<td class="summary">
<p>Instantiates a new TASK_A2G.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G).ReportOrder">TASK_A2G:ReportOrder(ReportGroup)</a></td>
<td class="summary">
<p>Return the relative distance to the target vicinity from the player, in order to sort the targets in the reports per distance from the threats.</p>
</td>
</tr>
<tr>
@@ -263,6 +281,18 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G).TargetSetUnit">TASK_A2G.TargetSetUnit</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G).UpdateTaskInfo">TASK_A2G:UpdateTaskInfo()</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G).onafterGoal">TASK_A2G:onafterGoal(TaskUnit, From, Event, To)</a></td>
<td class="summary">
<p>This method checks every 10 seconds if the goal has been reached of the task.</p>
</td>
</tr>
</table>
@@ -273,12 +303,6 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G_BAI).New">TASK_A2G_BAI:New(Mission, SetGroup, TaskName, TargetSetUnit, TaskBriefing)</a></td>
<td class="summary">
<p>Instantiates a new TASK<em>A2G</em>BAI.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G_BAI).ReportOrder">TASK_A2G_BAI:ReportOrder(ReportGroup)</a></td>
<td class="summary">
</td>
</tr>
<tr>
@@ -303,18 +327,6 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G_BAI).TargetSetUnit">TASK_A2G_BAI.TargetSetUnit</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G_BAI).UpdateTaskInfo">TASK_A2G_BAI:UpdateTaskInfo()</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G_BAI).onafterGoal">TASK_A2G_BAI:onafterGoal(TaskUnit, From, Event, To)</a></td>
<td class="summary">
</td>
</tr>
</table>
@@ -325,12 +337,6 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G_CAS).New">TASK_A2G_CAS:New(Mission, SetGroup, TaskName, TargetSetUnit, TaskBriefing)</a></td>
<td class="summary">
<p>Instantiates a new TASK<em>A2G</em>CAS.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G_CAS).ReportOrder">TASK_A2G_CAS:ReportOrder(ReportGroup)</a></td>
<td class="summary">
</td>
</tr>
<tr>
@@ -355,18 +361,6 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G_CAS).TargetSetUnit">TASK_A2G_CAS.TargetSetUnit</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G_CAS).UpdateTaskInfo">TASK_A2G_CAS:UpdateTaskInfo()</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G_CAS).onafterGoal">TASK_A2G_CAS:onafterGoal(TaskUnit, From, Event, To)</a></td>
<td class="summary">
</td>
</tr>
</table>
@@ -377,12 +371,6 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G_SEAD).New">TASK_A2G_SEAD:New(Mission, SetGroup, TaskName, TargetSetUnit, TaskBriefing)</a></td>
<td class="summary">
<p>Instantiates a new TASK<em>A2G</em>SEAD.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G_SEAD).ReportOrder">TASK_A2G_SEAD:ReportOrder(ReportGroup)</a></td>
<td class="summary">
</td>
</tr>
<tr>
@@ -407,18 +395,6 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G_SEAD).TargetSetUnit">TASK_A2G_SEAD.TargetSetUnit</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G_SEAD).UpdateTaskInfo">TASK_A2G_SEAD:UpdateTaskInfo()</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G_SEAD).onafterGoal">TASK_A2G_SEAD:onafterGoal(TaskUnit, From, Event, To)</a></td>
<td class="summary">
</td>
</tr>
</table>
@@ -737,6 +713,34 @@ The Coordinate object where the Target is located on the map.</p>
<p><em><a href="Core.Zone.html##(ZONE_BASE)">Core.Zone#ZONE_BASE</a>:</em>
The Zone object where the Target is located on the map.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(TASK_A2G).InitialTargets" >
<strong>TASK_A2G.InitialTargets</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(TASK_A2G).InitialThreat" >
<strong>TASK_A2G.InitialThreat</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
@@ -813,6 +817,27 @@ self</p>
<dl class="function">
<dt>
<a id="#(TASK_A2G).ReportOrder" >
<strong>TASK_A2G:ReportOrder(ReportGroup)</strong>
</a>
</dt>
<dd>
<p>Return the relative distance to the target vicinity from the player, in order to sort the targets in the reports per distance from the threats.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> ReportGroup </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_A2G).SetGoalTotal" >
<strong>TASK_A2G:SetGoalTotal()</strong>
</a>
@@ -971,6 +996,55 @@ The Zone object where the Target is located on the map.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_A2G).UpdateTaskInfo" >
<strong>TASK_A2G:UpdateTaskInfo()</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_A2G).onafterGoal" >
<strong>TASK_A2G:onafterGoal(TaskUnit, From, Event, To)</strong>
</a>
</dt>
<dd>
<p>This method checks every 10 seconds if the goal has been reached of the task.</p>
<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>
@@ -1031,27 +1105,6 @@ self</p>
<dl class="function">
<dt>
<a id="#(TASK_A2G_BAI).ReportOrder" >
<strong>TASK_A2G_BAI:ReportOrder(ReportGroup)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> ReportGroup </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_A2G_BAI).SetScoreOnFail" >
<strong>TASK_A2G_BAI:SetScoreOnFail(PlayerName, Penalty, TaskUnit)</strong>
</a>
@@ -1175,55 +1228,6 @@ The score in points.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_A2G_BAI).UpdateTaskInfo" >
<strong>TASK_A2G_BAI:UpdateTaskInfo()</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_A2G_BAI).onafterGoal" >
<strong>TASK_A2G_BAI: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>
@@ -1284,27 +1288,6 @@ self</p>
<dl class="function">
<dt>
<a id="#(TASK_A2G_CAS).ReportOrder" >
<strong>TASK_A2G_CAS:ReportOrder(ReportGroup)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> ReportGroup </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_A2G_CAS).SetScoreOnFail" >
<strong>TASK_A2G_CAS:SetScoreOnFail(PlayerName, Penalty, TaskUnit)</strong>
</a>
@@ -1428,55 +1411,6 @@ The score in points.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_A2G_CAS).UpdateTaskInfo" >
<strong>TASK_A2G_CAS:UpdateTaskInfo()</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_A2G_CAS).onafterGoal" >
<strong>TASK_A2G_CAS: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>
@@ -1537,27 +1471,6 @@ self</p>
<dl class="function">
<dt>
<a id="#(TASK_A2G_SEAD).ReportOrder" >
<strong>TASK_A2G_SEAD:ReportOrder(ReportGroup)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> ReportGroup </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_A2G_SEAD).SetScoreOnFail" >
<strong>TASK_A2G_SEAD:SetScoreOnFail(PlayerName, Penalty, TaskUnit)</strong>
</a>
@@ -1681,55 +1594,6 @@ The score in points.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_A2G_SEAD).UpdateTaskInfo" >
<strong>TASK_A2G_SEAD:UpdateTaskInfo()</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_A2G_SEAD).onafterGoal" >
<strong>TASK_A2G_SEAD: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>