FlightControl-Master/MOOSE
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE.git synced 2025-10-29 16:58:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation etc

Browse Source
This commit is contained in:
FlightControl
2017-04-14 09:31:44 +02:00
parent 9a2b56fb9f
commit 798996efd2
82 changed files with 559 additions and 190 deletions
Download Patch File Download Diff File Expand all files Collapse all files

128
docs/Documentation/Task_CARGO.html
View File

@@ -80,7 +80,7 @@
<li><a href="Task.html">Task</a></li>
<li><a href="Task_A2G.html">Task_A2G</a></li>
<li><a href="Task_A2G_Dispatcher.html">Task_A2G_Dispatcher</a></li>
<li>Task_CARGO</li>
<li>Task_Cargo</li>
<li><a href="Task_PICKUP.html">Task_PICKUP</a></li>
<li><a href="Unit.html">Unit</a></li>
<li><a href="Utils.html">Utils</a></li>
@@ -91,7 +91,7 @@
</ul>
</div>
<div id="content">
<h1>Module <code>Task_CARGO</code></h1>
<h1>Module <code>Task_Cargo</code></h1>
<p><strong>Tasking (Release 2.1)</strong> -- The TASK_CARGO models tasks for players to transport <a href="Cargo.html">Cargo</a>.</p>
@@ -101,9 +101,10 @@
<hr/>
<p>Cargo are units or cargo objects within DCS world that allow to be transported or sling loaded by other units.
The CARGO class, as part of the moose core, is able to Board, Load, UnBoard and UnLoad from Carrier units.
This collection of classes in this module define tasks for human players to handle cargo objects.
<p>The Moose framework provides various CARGO classes that allow DCS phisical or logical objects to be transported or sling loaded by Carriers.
The CARGO_ classes, as part of the moose core, are able to Board, Load, UnBoard and UnLoad cargo between Carrier units.</p>
<p>This collection of classes in this module define tasks for human players to handle these cargo objects.
Cargo can be transported, picked-up, deployed and sling-loaded from and to other places.</p>
<p>The following classes are important to consider:</p>
@@ -147,8 +148,11 @@ Cargo can be transported, picked-up, deployed and sling-loaded from and to other
<td class="summary">
<h1>TASK_CARGO class, extends <a href="Task.html##(TASK)">Task#TASK</a></h1>
<p>The TASK_CARGO class defines <a href="Cargo.html">Cargo</a> transport tasks,
based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TASK</a>.</p>
<h2>A flexible tasking system</h2>
<p>The TASK_CARGO classes provide you with a flexible tasking sytem,
that allows you to transport cargo of various types between various locations
and various dedicated deployment zones.</p>
</td>
</tr>
<tr>
@@ -291,11 +295,109 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
<h1>TASK_CARGO class, extends <a href="Task.html##(TASK)">Task#TASK</a></h1>
<p>The TASK_CARGO class defines <a href="Cargo.html">Cargo</a> transport tasks,
based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TASK</a>.</p>
<h2>A flexible tasking system</h2>
<p>The TASK_CARGO classes provide you with a flexible tasking sytem,
that allows you to transport cargo of various types between various locations
and various dedicated deployment zones.</p>
<p>The TASK_CARGO is implemented using a <a href="Statemachine.html##(FSM_TASK)">Statemachine#FSM_TASK</a>, and has the following statuses:</p>
<p>The cargo in scope of the TASK<em>CARGO classes must be explicitly given, and is of type SET</em>CARGO.
The SET_CARGO contains a collection of CARGO objects that must be handled by the players in the mission.</p>
<h2>Task execution experience from the player perspective</h2>
<p>A human player can join the battle field in a client airborne slot or a ground vehicle within the CA module (ALT-J).
The player needs to accept the task from the task overview list within the mission, using the radio menus.</p>
<p>Once the TASK_CARGO is assigned to the player and accepted by the player, the player will obtain
an extra <strong>Cargo Handling Radio Menu</strong> that contains the CARGO objects that need to be transported.</p>
<p>Each CARGO object has a certain state:</p>
<ul>
<li><strong>UnLoaded</strong>: The CARGO is located within the battlefield. It may still need to be transported.</li>
<li><strong>Loaded</strong>: The CARGO is loaded within a Carrier. This can be your air unit, or another air unit, or even a vehicle.</li>
<li><strong>Boarding</strong>: The CARGO is running or moving towards your Carrier for loading.</li>
<li><strong>UnBoarding</strong>: The CARGO is driving or jumping out of your Carrier and moves to a location in the Deployment Zone.</li>
</ul>
<p>Cargo must be transported towards different **Deployment <a href="Zone.html">Zone</a>s**.</p>
<p>The Cargo Handling Radio Menu system allows to execute <strong>various actions</strong> to handle the cargo.
In the menu, you'll find for each CARGO, that is part of the scope of the task, various actions that can be completed.
Depending on the location of your Carrier unit, the menu options will vary.</p>
<h2>Cargo Pickup and Boarding</h2>
<p>For cargo boarding, a cargo can only execute the boarding actions if it is within the foreseen <strong>Reporting Range</strong>.
Therefore, it is important that you steer your Carrier within the Reporting Range,
so that boarding actions can be executed on the cargo.
To Pickup and Board cargo, the following menu items will be shown in your carrier radio menu:</p>
<h3>Board Cargo</h3>
<p>If your Carrier is within the Reporting Range of the cargo, it will allow to pickup the cargo by selecting this menu option.
Depending on the Cargo type, the cargo will either move to your Carrier or you will receive instructions how to handle the cargo
pickup. If the cargo moves to your carrier, it will indicate the boarding status.
Note that multiple units need to board your Carrier, so it is required to await the full boarding process.
Once the cargo is fully boarded within your Carrier, you will be notified of this.</p>
<p>Note that for airborne Carriers, it is required to land first before the Boarding process can be initiated.
If during boarding the Carrier gets airborne, the boarding process will be cancelled.</p>
<h2>Pickup Cargo</h2>
<p>If your Carrier is not within the Reporting Range of the cargo, the HQ will guide you to its location.
Routing information is shown in flight that directs you to the cargo within Reporting Range.
Upon arrival, the Cargo will contact you and further instructions will be given.
When your Carrier is airborne, you will receive instructions to land your Carrier.
The action will not be completed until you've landed your Carrier.</p>
<h2>Cargo Deploy and UnBoarding</h2>
<p>Various Deployment Zones can be foreseen in the scope of the Cargo transportation. Each deployment zone can be of varying <a href="Zone.html">Zone</a> type.
The Cargo Handling Radio Menu provides with menu options to execute an action to steer your Carrier to a specific Zone.</p>
<h3>UnBoard Cargo</h3>
<p>If your Carrier is already within a Deployment Zone,
then the Cargo Handling Radio Menu allows to <strong>UnBoard</strong> a specific cargo that is
loaded within your Carrier group into the Deployment Zone.
Note that the Unboarding process takes a while, as the cargo units (infantry or vehicles) must unload from your Carrier.
Ensure that you stay at the position or stay on the ground while Unboarding.
If any unforeseen manoeuvre is done by the Carrier, then the Unboarding will be cancelled.</p>
<h3>Deploy Cargo</h3>
<p>If your Carrier is not within a Deployment Zone, you'll need to fly towards one.
Fortunately, the Cargo Handling Radio Menu provides you with menu options to select a specific Deployment Zone to fly towards.
Once a Deployment Zone has been selected, your Carrier will receive routing information from HQ towards the Deployment Zone center.
Upon arrival, the HQ will provide you with further instructions.
When your Carrier is airborne, you will receive instructions to land your Carrier.
The action will not be completed until you've landed your Carrier!</p>
<h2>Handle TASK_CARGO Events ...</h2>
<p>The TASK_CARGO classes define <a href="Cargo.html">Cargo</a> transport tasks,
based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TASK</a>.</p>
<h3>Specific TASK_CARGO Events</h3>
<p>Specific Cargo Handling event can be captured, that allow to trigger specific actions!</p>
<ul>
<li><strong>Boarded</strong>: Triggered when the Cargo has been Boarded into your Carrier.</li>
<li><strong>UnBoarded</strong>: Triggered when the cargo has been Unboarded from your Carrier and has arrived at the Deployment Zone.</li>
</ul>
<h3>Standard TASK_CARGO Events</h3>
<p>The TASK_CARGO is implemented using a <a href="Statemachine.html##(FSM_TASK)">Statemachine#FSM_TASK</a>, and has the following standard statuses:</p>
<ul>
<li><strong>None</strong>: Start of the process.</li>
@@ -305,10 +407,6 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
<li><strong>Failed</strong>: The cargo task has failed. This will happen if the player exists the task early, without communicating a possible cancellation to HQ.</li>
</ul>
<h1>1.1) Set the scoring of achievements in a cargo task.</h1>
<p>Scoring or penalties can be given in the following circumstances:</p>
<hr/>
@@ -328,7 +426,7 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
</dd>
</dl>
<h2><a id="#(Task_CARGO)" >Type <code>Task_CARGO</code></a></h2>
<h2><a id="#(Task_Cargo)" >Type <code>Task_Cargo</code></a></h2>
<h2><a id="#(FSM_PROCESS)" >Type <code>FSM_PROCESS</code></a></h2>
<h3>Field(s)</h3>