New revised CLEANUP class

This commit is contained in:
FlightControl
2017-06-30 10:27:44 +02:00
parent 862f2ab3ac
commit 133910ac3b
24 changed files with 524 additions and 577 deletions

View File

@@ -133,6 +133,12 @@
<td class="name" nowrap="nowrap"><a href="##(MISSION).AbortUnit">MISSION:AbortUnit(PlayerUnit)</a></td>
<td class="summary">
<p>Aborts a PlayerUnit from the Mission.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).AddPlayerName">MISSION:AddPlayerName(PlayerName)</a></td>
<td class="summary">
</td>
</tr>
<tr>
@@ -211,6 +217,12 @@
<td class="name" nowrap="nowrap"><a href="##(MISSION).GetNextTaskID">MISSION:GetNextTaskID(Task)</a></td>
<td class="summary">
<p>Return the next <a href="Task.html">Task</a> ID to be completed within the <a href="Mission.html">Mission</a>. </p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).GetPlayerNames">MISSION:GetPlayerNames()</a></td>
<td class="summary">
</td>
</tr>
<tr>
@@ -294,13 +306,19 @@
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).MenuReportBriefing">MISSION:MenuReportBriefing(ReportGroup)</a></td>
<td class="summary">
<p>Reports the briefing.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).MenuReportPlayersPerTask">MISSION:MenuReportPlayersPerTask(ReportGroup)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).MenuReportPlayersProgress">MISSION:MenuReportPlayersProgress(ReportGroup)</a></td>
<td class="summary">
</td>
</tr>
<tr>
@@ -312,7 +330,7 @@
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).MenuReportTasksSummary">MISSION:MenuReportTasksSummary(ReportGroup)</a></td>
<td class="summary">
<p>Report the task summary.</p>
</td>
</tr>
<tr>
@@ -499,6 +517,12 @@
<td class="name" nowrap="nowrap"><a href="##(MISSION).ReportPlayersPerTask">MISSION:ReportPlayersPerTask(ReportGroup)</a></td>
<td class="summary">
<p>Create an active player report of the Mission.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).ReportPlayersProgress">MISSION:ReportPlayersProgress(ReportGroup)</a></td>
<td class="summary">
<p>Create an Mission Progress report of the Mission.</p>
</td>
</tr>
<tr>
@@ -644,6 +668,27 @@ The CLIENT or UNIT of the Player joining the Mission.</p>
<dl class="function">
<dt>
<a id="#(MISSION).AddPlayerName" >
<strong>MISSION:AddPlayerName(PlayerName)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> PlayerName </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).AddScoring" >
<strong>MISSION:AddScoring(Scoring)</strong>
</a>
@@ -915,6 +960,19 @@ is the <a href="Task.html">Task</a> object.</p>
<p><em><a href="Tasking.Task.html##(TASK)">Tasking.Task#TASK</a>:</em>
The task added.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).GetPlayerNames" >
<strong>MISSION:GetPlayerNames()</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
@@ -1242,13 +1300,14 @@ true if Unit is part of a Task in the Mission.</p>
</dt>
<dd>
<p>Reports the briefing.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> ReportGroup </em></code>: </p>
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> ReportGroup </em></code>:
The group to which the report needs to be sent.</p>
</li>
</ul>
@@ -1265,6 +1324,27 @@ true if Unit is part of a Task in the Mission.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> ReportGroup </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).MenuReportPlayersProgress" >
<strong>MISSION:MenuReportPlayersProgress(ReportGroup)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
@@ -1311,7 +1391,7 @@ The status</p>
</dt>
<dd>
<p>Report the task summary.</p>
<h3>Parameter</h3>
<ul>
@@ -2283,6 +2363,42 @@ self</p>
<p><em>#string:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).ReportPlayersProgress" >
<strong>MISSION:ReportPlayersProgress(ReportGroup)</strong>
</a>
</dt>
<dd>
<p>Create an Mission Progress report of the Mission.</p>
<p>This reports provides a one liner per player of the mission achievements per task.</p>
<pre><code>Mission "&lt;MissionName&gt;" - &lt;MissionStatus&gt; - Active Players Report
- Player &lt;PlayerName&gt;: Task &lt;TaskName&gt; &lt;TaskStatus&gt;: &lt;Progress&gt;
- Player &lt;PlayerName&gt;: Task &lt;TaskName&gt; &lt;TaskStatus&gt;: &lt;Progress&gt;
- ..
</code></pre>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> ReportGroup </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#string:</em></p>
</dd>
</dl>
<dl class="function">