mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-10-29 16:58:06 +00:00
2174 lines
45 KiB
HTML
2174 lines
45 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html>
|
|
<head>
|
|
<link rel="stylesheet" href="stylesheet.css" type="text/css"/>
|
|
</head>
|
|
<body>
|
|
<div id="container">
|
|
<div id="product">
|
|
<div id="product_logo"></div>
|
|
<div id="product_name"><big><b></b></big></div>
|
|
<div id="product_description"></div>
|
|
</div>
|
|
<div id="main">
|
|
<div id="navigation">
|
|
<h2>Modules</h2>
|
|
<ul><li>
|
|
<a href="index.html">index</a>
|
|
</li></ul>
|
|
<ul>
|
|
<li><a href="AIBalancer.html">AIBalancer</a></li>
|
|
<li><a href="Airbase.html">Airbase</a></li>
|
|
<li><a href="AirbasePolice.html">AirbasePolice</a></li>
|
|
<li><a href="Base.html">Base</a></li>
|
|
<li>Cargo</li>
|
|
<li><a href="CleanUp.html">CleanUp</a></li>
|
|
<li><a href="Client.html">Client</a></li>
|
|
<li><a href="Controllable.html">Controllable</a></li>
|
|
<li><a href="DCSAirbase.html">DCSAirbase</a></li>
|
|
<li><a href="DCSCoalitionObject.html">DCSCoalitionObject</a></li>
|
|
<li><a href="DCSCommand.html">DCSCommand</a></li>
|
|
<li><a href="DCSController.html">DCSController</a></li>
|
|
<li><a href="DCSGroup.html">DCSGroup</a></li>
|
|
<li><a href="DCSObject.html">DCSObject</a></li>
|
|
<li><a href="DCSTask.html">DCSTask</a></li>
|
|
<li><a href="DCSTypes.html">DCSTypes</a></li>
|
|
<li><a href="DCSUnit.html">DCSUnit</a></li>
|
|
<li><a href="DCSWorld.html">DCSWorld</a></li>
|
|
<li><a href="DCScountry.html">DCScountry</a></li>
|
|
<li><a href="DCStimer.html">DCStimer</a></li>
|
|
<li><a href="DCStrigger.html">DCStrigger</a></li>
|
|
<li><a href="Database.html">Database</a></li>
|
|
<li><a href="Detection.html">Detection</a></li>
|
|
<li><a href="DetectionManager.html">DetectionManager</a></li>
|
|
<li><a href="Escort.html">Escort</a></li>
|
|
<li><a href="Event.html">Event</a></li>
|
|
<li><a href="Group.html">Group</a></li>
|
|
<li><a href="Identifiable.html">Identifiable</a></li>
|
|
<li><a href="MOVEMENT.html">MOVEMENT</a></li>
|
|
<li><a href="Menu.html">Menu</a></li>
|
|
<li><a href="Message.html">Message</a></li>
|
|
<li><a href="MissileTrainer.html">MissileTrainer</a></li>
|
|
<li><a href="Mission.html">Mission</a></li>
|
|
<li><a href="Object.html">Object</a></li>
|
|
<li><a href="Point.html">Point</a></li>
|
|
<li><a href="Positionable.html">Positionable</a></li>
|
|
<li><a href="Process.html">Process</a></li>
|
|
<li><a href="Process_Destroy.html">Process_Destroy</a></li>
|
|
<li><a href="Process_JTAC.html">Process_JTAC</a></li>
|
|
<li><a href="Process_PatrolZone.html">Process_PatrolZone</a></li>
|
|
<li><a href="Process_Pickup.html">Process_Pickup</a></li>
|
|
<li><a href="Process_Smoke.html">Process_Smoke</a></li>
|
|
<li><a href="Scheduler.html">Scheduler</a></li>
|
|
<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="Spawn.html">Spawn</a></li>
|
|
<li><a href="StateMachine.html">StateMachine</a></li>
|
|
<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_A2G.html">Task_A2G</a></li>
|
|
<li><a href="Task_Assign.html">Task_Assign</a></li>
|
|
<li><a href="Task_Client_Menu.html">Task_Client_Menu</a></li>
|
|
<li><a href="Task_PICKUP.html">Task_PICKUP</a></li>
|
|
<li><a href="Task_Route.html">Task_Route</a></li>
|
|
<li><a href="Task_SEAD.html">Task_SEAD</a></li>
|
|
<li><a href="Unit.html">Unit</a></li>
|
|
<li><a href="Utils.html">Utils</a></li>
|
|
<li><a href="Zone.html">Zone</a></li>
|
|
<li><a href="env.html">env</a></li>
|
|
<li><a href="land.html">land</a></li>
|
|
<li><a href="routines.html">routines</a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="content">
|
|
<h1>Module <code>Cargo</code></h1>
|
|
|
|
<p>This module contains the CARGO classes.</p>
|
|
|
|
|
|
|
|
<hr/>
|
|
|
|
<h1>1) <a href="Cargo.html##(CARGO_BASE)">Cargo#CARGO_BASE</a> class, extends <a href="Base.html##(BASE)">Base#BASE</a></h1>
|
|
<p>The <a href="##(CARGO_BASE)">#CARGO_BASE</a> class defines the core functions that defines a cargo object within MOOSE.
|
|
A cargo is a logical object defined within a <a href="Mission.html">Mission</a>, that is available for transport, and has a life status within a simulation.</p>
|
|
|
|
<p>Cargo can be of various forms:</p>
|
|
|
|
<ul>
|
|
<li>CARGO_UNIT, represented by a <a href="Unit.html">Unit</a> in a <a href="Group.html">Group</a>: Cargo can be represented by a Unit in a Group. Destruction of the Unit will mean that the cargo is lost.</li>
|
|
<li>CARGO_STATIC, represented by a <a href="Static.html">Static</a>: Cargo can be represented by a Static. Destruction of the Static will mean that the cargo is lost.</li>
|
|
<li>CARGO_PACKAGE, contained in a <a href="Unit.html">Unit</a> of a <a href="Group.html">Group</a>: Cargo can be contained within a Unit of a Group. The cargo can be <strong>delivered</strong> by the <a href="Unit.html">Unit</a>. If the Unit is destroyed, the cargo will be destroyed also.</li>
|
|
<li>CARGO_PACKAGE, Contained in a <a href="Static.html">Static</a>: Cargo can be contained within a Static. The cargo can be <strong>collected</strong> from the @Static. If the <a href="Static.html">Static</a> is destroyed, the cargo will be destroyed.</li>
|
|
<li>CARGO_SLINGLOAD, represented by a <a href="Cargo.html">Cargo</a> that is transportable: Cargo can be represented by a Cargo object that is transportable. Destruction of the Cargo will mean that the cargo is lost.</li>
|
|
</ul>
|
|
|
|
<h2>1.2) CARGO state machine:</h2>
|
|
<p>The CARGO is a state machine: it manages the different events and states of the <a href="Controllable.html">Controllable</a> it is controlling.</p>
|
|
|
|
<h3>1.2.1) CARGO Events:</h3>
|
|
|
|
<ul>
|
|
<li><a href="##(CARGO).Board">CARGO.Board</a>( ToCarrier ): Boards the cargo to a Carrier.</li>
|
|
<li><a href="##(CARGO).Load">CARGO.Load</a>( ToCarrier ): Loads the cargo into a Carrier, regardless of its position.</li>
|
|
<li><a href="##(CARGO).UnBoard">CARGO.UnBoard</a>( ToPointVec2 ): UnBoard the cargo from a Carrier. This will trigger a movement of the cargo to the option ToPointVec2.</li>
|
|
<li><a href="##(CARGO).UnLoad">CARGO.UnLoad</a>( ToPointVec2 ): UnLoads the cargo from a Carrier.</li>
|
|
<li><a href="##(CARGO).Dead">CARGO.Dead</a>( Controllable ): The cargo is dead. The cargo process will be ended.</li>
|
|
</ul>
|
|
|
|
<h3>1.2.2) PROCESS_PATROLZONE States:</h3>
|
|
|
|
<ul>
|
|
<li><strong>UnLoaded</strong>: The cargo is unloaded from a carrier.</li>
|
|
<li><strong>Boarding</strong>: The cargo is currently boarding (= running) into a carrier.</li>
|
|
<li><strong>Loaded</strong>: The cargo is loaded into a carrier.</li>
|
|
<li><strong>UnBoarding</strong>: The cargo is currently unboarding (=running) from a carrier.</li>
|
|
<li><strong>Dead</strong>: The cargo is dead ...</li>
|
|
<li><strong>End</strong>: The process has come to an end.</li>
|
|
</ul>
|
|
|
|
<h3>1.2.3) PROCESS_PATROLZONE state transition functions:</h3>
|
|
|
|
<p>State transition functions can be set <strong>by the mission designer</strong> customizing or improving the behaviour of the state.
|
|
There are 2 moments when state transition functions will be called by the state machine:</p>
|
|
|
|
<ul>
|
|
<li><p><strong>Before</strong> the state transition.
|
|
The state transition function needs to start with the name <strong>OnBefore + the name of the state</strong>.
|
|
If the state transition function returns false, then the processing of the state transition will not be done!
|
|
If you want to change the behaviour of the AIControllable at this event, return false,
|
|
but then you'll need to specify your own logic using the AIControllable!</p></li>
|
|
<li><p><strong>After</strong> the state transition.
|
|
The state transition function needs to start with the name <strong>OnAfter + the name of the state</strong>.
|
|
These state transition functions need to provide a return value, which is specified at the function description.</p>
|
|
</li>
|
|
</ul>
|
|
|
|
<h2>Global(s)</h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="#CARGO">CARGO</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="#CARGOS">CARGOS</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="#CARGO_PACKAGE">CARGO_PACKAGE</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="#CARGO_REPRESENTABLE">CARGO_REPRESENTABLE</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="#CARGO_UNIT">CARGO_UNIT</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="#FSMT">FSMT</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<h2><a id="#(CARGO)">Type <code>CARGO</code></a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO).Board">CARGO:Board(ToPointVec2)</a></td>
|
|
<td class="summary">
|
|
<p>Event Function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO).CargoCarrier">CARGO.CargoCarrier</a></td>
|
|
<td class="summary">
|
|
<p>The alive DCS object carrying the cargo. This value can be nil, meaning, that the cargo is not contained anywhere...</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO).CargoObject">CARGO.CargoObject</a></td>
|
|
<td class="summary">
|
|
<p>The alive DCS object representing the cargo. This value can be nil, meaning, that the cargo is not represented anywhere...</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO).CargoScheduler">CARGO.CargoScheduler</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO).ClassName">CARGO.ClassName</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO).Containable">CARGO.Containable</a></td>
|
|
<td class="summary">
|
|
<p>This flag defines if the cargo can be contained within a DCS Unit.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO).IsNear">CARGO:IsNear(PointVec2)</a></td>
|
|
<td class="summary">
|
|
<p>Check if CargoCarrier is near the Cargo to be Loaded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO).Load">CARGO:Load(ToCarrier)</a></td>
|
|
<td class="summary">
|
|
<p>Event Function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO).Moveable">CARGO.Moveable</a></td>
|
|
<td class="summary">
|
|
<p>This flag defines if the cargo is moveable.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO).Name">CARGO.Name</a></td>
|
|
<td class="summary">
|
|
<p>A string defining the name of the cargo. The name is the unique identifier of the cargo.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO).NearRadius">CARGO.NearRadius</a></td>
|
|
<td class="summary">
|
|
<p>(optional) A number defining the radius in meters when the cargo is near to a Carrier, so that it can be loaded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO).New">CARGO:New(Mission, Type, Name, Weight, ReportRadius, NearRadius)</a></td>
|
|
<td class="summary">
|
|
<p>CARGO Constructor.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO).OnAfterBoarding">CARGO:OnAfterBoarding(Controllable)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO).OnAfterLoaded">CARGO:OnAfterLoaded(Controllable)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO).OnAfterUnBoarding">CARGO:OnAfterUnBoarding(Controllable)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO).OnAfterUnLoaded">CARGO:OnAfterUnLoaded(Controllable)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO).OnBeforeBoarding">CARGO:OnBeforeBoarding(Controllable)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO).OnBeforeLoaded">CARGO:OnBeforeLoaded(Controllable)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO).OnBeforeUnBoarding">CARGO:OnBeforeUnBoarding(Controllable)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO).OnBeforeUnLoaded">CARGO:OnBeforeUnLoaded(Controllable)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO).ReportRadius">CARGO.ReportRadius</a></td>
|
|
<td class="summary">
|
|
<p>(optional) A number defining the radius in meters when the cargo is signalling or reporting to a Carrier.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO).Representable">CARGO.Representable</a></td>
|
|
<td class="summary">
|
|
<p>This flag defines if the cargo can be represented by a DCS Unit.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO).Slingloadable">CARGO.Slingloadable</a></td>
|
|
<td class="summary">
|
|
<p>This flag defines if the cargo can be slingloaded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO).Spawn">CARGO:Spawn(PointVec2)</a></td>
|
|
<td class="summary">
|
|
<p>Template method to spawn a new representation of the CARGO in the simulator.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO).Type">CARGO.Type</a></td>
|
|
<td class="summary">
|
|
<p>A string defining the type of the cargo. eg. Engineers, Equipment, Screwdrivers.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO).UnBoard">CARGO:UnBoard(ToPointVec2)</a></td>
|
|
<td class="summary">
|
|
<p>Event Function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO).Weight">CARGO.Weight</a></td>
|
|
<td class="summary">
|
|
<p>A number defining the weight of the cargo. The weight is expressed in kg.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2><a id="#(CARGO_PACKAGE)">Type <code>CARGO_PACKAGE</code></a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO_PACKAGE).CargoCarrier">CARGO_PACKAGE.CargoCarrier</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO_PACKAGE).CargoInAir">CARGO_PACKAGE.CargoInAir</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO_PACKAGE).ClassName">CARGO_PACKAGE.ClassName</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO_PACKAGE).IsNear">CARGO_PACKAGE:IsNear(CargoCarrier)</a></td>
|
|
<td class="summary">
|
|
<p>Check if CargoCarrier is near the Cargo to be Loaded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO_PACKAGE).New">CARGO_PACKAGE:New(Mission, CargoCarrier, Type, Name, Weight, ReportRadius, NearRadius)</a></td>
|
|
<td class="summary">
|
|
<p>CARGO_PACKAGE Constructor.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO_PACKAGE).onafterLoad">CARGO_PACKAGE:onafterLoad(FsmP, Event, From, To, CargoCarrier, Speed, LoadDistance, Angle)</a></td>
|
|
<td class="summary">
|
|
<p>Load Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO_PACKAGE).onafterOnBoard">CARGO_PACKAGE:onafterOnBoard(FsmP, Event, From, To, CargoCarrier, Speed, BoardDistance, Angle, LoadDistance)</a></td>
|
|
<td class="summary">
|
|
<p>Board Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO_PACKAGE).onafterOnBoarded">CARGO_PACKAGE:onafterOnBoarded(FsmP, Event, From, To, CargoCarrier, Speed, BoardDistance, LoadDistance, Angle)</a></td>
|
|
<td class="summary">
|
|
<p>Boarded Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO_PACKAGE).onafterUnBoard">CARGO_PACKAGE:onafterUnBoard(FsmP, Event, From, To, Speed, UnLoadDistance, UnBoardDistance, Radius, Angle, CargoCarrier)</a></td>
|
|
<td class="summary">
|
|
<p>UnBoard Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO_PACKAGE).onafterUnBoarded">CARGO_PACKAGE:onafterUnBoarded(FsmP, Event, From, To, CargoCarrier, Speed)</a></td>
|
|
<td class="summary">
|
|
<p>UnBoarded Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO_PACKAGE).onafterUnLoad">CARGO_PACKAGE:onafterUnLoad(FsmP, Event, From, To, Distance, Angle, CargoCarrier, Speed)</a></td>
|
|
<td class="summary">
|
|
<p>UnLoad Event.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2><a id="#(CARGO_REPRESENTABLE)">Type <code>CARGO_REPRESENTABLE</code></a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO_REPRESENTABLE).ClassName">CARGO_REPRESENTABLE.ClassName</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO_REPRESENTABLE).New">CARGO_REPRESENTABLE:New(Mission, CargoObject, Type, Name, Weight, ReportRadius, NearRadius)</a></td>
|
|
<td class="summary">
|
|
<p>CARGO_REPRESENTABLE Constructor.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2><a id="#(CARGO_UNIT)">Type <code>CARGO_UNIT</code></a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO_UNIT).CargoCarrier">CARGO_UNIT.CargoCarrier</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO_UNIT).CargoInAir">CARGO_UNIT.CargoInAir</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO_UNIT).CargoObject">CARGO_UNIT.CargoObject</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO_UNIT).ClassName">CARGO_UNIT.ClassName</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO_UNIT).New">CARGO_UNIT:New(Mission, CargoUnit, Type, Name, Weight, ReportRadius, NearRadius)</a></td>
|
|
<td class="summary">
|
|
<p>CARGO_UNIT Constructor.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO_UNIT).OnLoadedCallBack">CARGO_UNIT.OnLoadedCallBack</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO_UNIT).OnUnLoadedCallBack">CARGO_UNIT.OnUnLoadedCallBack</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO_UNIT).onafterBoard">CARGO_UNIT:onafterBoard(Event, From, To, CargoCarrier)</a></td>
|
|
<td class="summary">
|
|
<p>Board Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO_UNIT).onafterUnBoarded">CARGO_UNIT:onafterUnBoarded(ToPointVec2, Event, From, To)</a></td>
|
|
<td class="summary">
|
|
<p>UnBoard Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO_UNIT).onenterBoarding">CARGO_UNIT:onenterBoarding(CargoCarrier, Event, From, To)</a></td>
|
|
<td class="summary">
|
|
<p>Enter Boarding State.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO_UNIT).onenterLoaded">CARGO_UNIT:onenterLoaded(CargoCarrier, Event, From, To)</a></td>
|
|
<td class="summary">
|
|
<p>Loaded State.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO_UNIT).onenterUnBoarding">CARGO_UNIT:onenterUnBoarding(ToPointVec2, Event, From, To)</a></td>
|
|
<td class="summary">
|
|
<p>Enter UnBoarding State.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO_UNIT).onenterUnLoaded">CARGO_UNIT:onenterUnLoaded(Point, Event, From, To, ToPointVec2)</a></td>
|
|
<td class="summary">
|
|
<p>Enter UnLoaded State.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO_UNIT).onleaveBoarding">CARGO_UNIT:onleaveBoarding(CargoCarrier, Event, From, To)</a></td>
|
|
<td class="summary">
|
|
<p>Leave Boarding State.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(CARGO_UNIT).onleaveUnBoarding">CARGO_UNIT:onleaveUnBoarding(ToPointVec2, Event, From, To)</a></td>
|
|
<td class="summary">
|
|
<p>Leave UnBoarding State.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2>Global(s)</h2>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(CARGO)">#CARGO</a></em>
|
|
<a id="CARGO" >
|
|
<strong>CARGO</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="CARGOS" >
|
|
<strong>CARGOS</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(CARGO_PACKAGE)">#CARGO_PACKAGE</a></em>
|
|
<a id="CARGO_PACKAGE" >
|
|
<strong>CARGO_PACKAGE</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(CARGO_REPRESENTABLE)">#CARGO_REPRESENTABLE</a></em>
|
|
<a id="CARGO_REPRESENTABLE" >
|
|
<strong>CARGO_REPRESENTABLE</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(CARGO_UNIT)">#CARGO_UNIT</a></em>
|
|
<a id="CARGO_UNIT" >
|
|
<strong>CARGO_UNIT</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="FSMT" >
|
|
<strong>FSMT</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<h2><a id="#(Cargo)" >Type <code>Cargo</code></a></h2>
|
|
|
|
<h2><a id="#(CARGO)" >Type <code>CARGO</code></a></h2>
|
|
<h3>Field(s)</h3>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO).Board" >
|
|
<strong>CARGO:Board(ToPointVec2)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Event Function.</p>
|
|
|
|
|
|
<p>The cargo must be in the <strong>Loaded</strong> state.
|
|
UnLoads the cargo to a Carrier. The event will unload the cargo from the Carrier. There will be no movement simulated of the cargo loading.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Point.html##(POINT_VEC2)">Point#POINT_VEC2</a> ToPointVec2 </em></code>:
|
|
(optional) @{Point#POINT_VEC2) to where the cargo will be placed after unloading. If not provided, the cargo will be placed 60 meters behind the Carrier location.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="Positionable.html##(POSITIONABLE)">Positionable#POSITIONABLE</a></em>
|
|
<a id="#(CARGO).CargoCarrier" >
|
|
<strong>CARGO.CargoCarrier</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>The alive DCS object carrying the cargo. This value can be nil, meaning, that the cargo is not contained anywhere...</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="Controllable.html##(CONTROLLABLE)">Controllable#CONTROLLABLE</a></em>
|
|
<a id="#(CARGO).CargoObject" >
|
|
<strong>CARGO.CargoObject</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>The alive DCS object representing the cargo. This value can be nil, meaning, that the cargo is not represented anywhere...</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(CARGO).CargoScheduler" >
|
|
<strong>CARGO.CargoScheduler</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#string</em>
|
|
<a id="#(CARGO).ClassName" >
|
|
<strong>CARGO.ClassName</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#boolean</em>
|
|
<a id="#(CARGO).Containable" >
|
|
<strong>CARGO.Containable</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>This flag defines if the cargo can be contained within a DCS Unit.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO).IsNear" >
|
|
<strong>CARGO:IsNear(PointVec2)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Check if CargoCarrier is near the Cargo to be Loaded.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Point.html##(POINT_VEC2)">Point#POINT_VEC2</a> PointVec2 </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em>#boolean:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO).Load" >
|
|
<strong>CARGO:Load(ToCarrier)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Event Function.</p>
|
|
|
|
|
|
<p>The cargo must be in the <strong>UnLoaded</strong> state.
|
|
Loads the cargo to a Carrier. The event will load the cargo into the Carrier regardless of its position. There will be no movement simulated of the cargo loading.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Controllable.html##(CONTROLLABLE)">Controllable#CONTROLLABLE</a> ToCarrier </em></code>:
|
|
The Carrier that will hold the cargo.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#boolean</em>
|
|
<a id="#(CARGO).Moveable" >
|
|
<strong>CARGO.Moveable</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>This flag defines if the cargo is moveable.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#string</em>
|
|
<a id="#(CARGO).Name" >
|
|
<strong>CARGO.Name</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>A string defining the name of the cargo. The name is the unique identifier of the cargo.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#number</em>
|
|
<a id="#(CARGO).NearRadius" >
|
|
<strong>CARGO.NearRadius</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>(optional) A number defining the radius in meters when the cargo is near to a Carrier, so that it can be loaded.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO).New" >
|
|
<strong>CARGO:New(Mission, Type, Name, Weight, ReportRadius, NearRadius)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>CARGO Constructor.</p>
|
|
|
|
|
|
<p>This class is an abstract class and should not be instantiated.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Mission.html##(MISSION)">Mission#MISSION</a> Mission </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string Type </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string Name </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number Weight </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number ReportRadius </em></code>:
|
|
(optional)</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number NearRadius </em></code>:
|
|
(optional)</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(CARGO)">#CARGO</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO).OnAfterBoarding" >
|
|
<strong>CARGO:OnAfterBoarding(Controllable)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Controllable.html##(CONTROLLABLE)">Controllable#CONTROLLABLE</a> Controllable </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO).OnAfterLoaded" >
|
|
<strong>CARGO:OnAfterLoaded(Controllable)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Controllable.html##(CONTROLLABLE)">Controllable#CONTROLLABLE</a> Controllable </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO).OnAfterUnBoarding" >
|
|
<strong>CARGO:OnAfterUnBoarding(Controllable)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Controllable.html##(CONTROLLABLE)">Controllable#CONTROLLABLE</a> Controllable </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO).OnAfterUnLoaded" >
|
|
<strong>CARGO:OnAfterUnLoaded(Controllable)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Controllable.html##(CONTROLLABLE)">Controllable#CONTROLLABLE</a> Controllable </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO).OnBeforeBoarding" >
|
|
<strong>CARGO:OnBeforeBoarding(Controllable)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Controllable.html##(CONTROLLABLE)">Controllable#CONTROLLABLE</a> Controllable </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em>#boolean:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO).OnBeforeLoaded" >
|
|
<strong>CARGO:OnBeforeLoaded(Controllable)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Controllable.html##(CONTROLLABLE)">Controllable#CONTROLLABLE</a> Controllable </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em>#boolean:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO).OnBeforeUnBoarding" >
|
|
<strong>CARGO:OnBeforeUnBoarding(Controllable)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Controllable.html##(CONTROLLABLE)">Controllable#CONTROLLABLE</a> Controllable </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em>#boolean:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO).OnBeforeUnLoaded" >
|
|
<strong>CARGO:OnBeforeUnLoaded(Controllable)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Controllable.html##(CONTROLLABLE)">Controllable#CONTROLLABLE</a> Controllable </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em>#boolean:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#number</em>
|
|
<a id="#(CARGO).ReportRadius" >
|
|
<strong>CARGO.ReportRadius</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>(optional) A number defining the radius in meters when the cargo is signalling or reporting to a Carrier.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#boolean</em>
|
|
<a id="#(CARGO).Representable" >
|
|
<strong>CARGO.Representable</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>This flag defines if the cargo can be represented by a DCS Unit.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#boolean</em>
|
|
<a id="#(CARGO).Slingloadable" >
|
|
<strong>CARGO.Slingloadable</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>This flag defines if the cargo can be slingloaded.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO).Spawn" >
|
|
<strong>CARGO:Spawn(PointVec2)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Template method to spawn a new representation of the CARGO in the simulator.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em> PointVec2 </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(CARGO)">#CARGO</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#string</em>
|
|
<a id="#(CARGO).Type" >
|
|
<strong>CARGO.Type</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>A string defining the type of the cargo. eg. Engineers, Equipment, Screwdrivers.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO).UnBoard" >
|
|
<strong>CARGO:UnBoard(ToPointVec2)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Event Function.</p>
|
|
|
|
|
|
<p>The cargo must be in the <strong>Loaded</strong> state.
|
|
UnBoards the cargo to a Carrier. The event will create a movement (= running or driving) of the cargo from the Carrier.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Point.html##(POINT_VEC2)">Point#POINT_VEC2</a> ToPointVec2 </em></code>:
|
|
(optional) @{Point#POINT_VEC2) to where the cargo should run after onboarding. If not provided, the cargo will run to 60 meters behind the Carrier location.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#number</em>
|
|
<a id="#(CARGO).Weight" >
|
|
<strong>CARGO.Weight</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>A number defining the weight of the cargo. The weight is expressed in kg.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h2><a id="#(CARGO.CargoObjects)" >Type <code>CARGO.CargoObjects</code></a></h2>
|
|
|
|
<h2><a id="#(CARGO_PACKAGE)" >Type <code>CARGO_PACKAGE</code></a></h2>
|
|
<h3>Field(s)</h3>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(CARGO_PACKAGE).CargoCarrier" >
|
|
<strong>CARGO_PACKAGE.CargoCarrier</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(CARGO_PACKAGE).CargoInAir" >
|
|
<strong>CARGO_PACKAGE.CargoInAir</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#string</em>
|
|
<a id="#(CARGO_PACKAGE).ClassName" >
|
|
<strong>CARGO_PACKAGE.ClassName</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO_PACKAGE).IsNear" >
|
|
<strong>CARGO_PACKAGE:IsNear(CargoCarrier)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Check if CargoCarrier is near the Cargo to be Loaded.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Unit.html##(UNIT)">Unit#UNIT</a> CargoCarrier </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em>#boolean:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO_PACKAGE).New" >
|
|
<strong>CARGO_PACKAGE:New(Mission, CargoCarrier, Type, Name, Weight, ReportRadius, NearRadius)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>CARGO_PACKAGE Constructor.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Mission.html##(MISSION)">Mission#MISSION</a> Mission </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em><a href="Unit.html##(UNIT)">Unit#UNIT</a> CargoCarrier </em></code>:
|
|
The UNIT carrying the package.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string Type </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string Name </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number Weight </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number ReportRadius </em></code>:
|
|
(optional)</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number NearRadius </em></code>:
|
|
(optional)</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(CARGO_PACKAGE)">#CARGO_PACKAGE</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO_PACKAGE).onafterLoad" >
|
|
<strong>CARGO_PACKAGE:onafterLoad(FsmP, Event, From, To, CargoCarrier, Speed, LoadDistance, Angle)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Load Event.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="StateMachine.html##(STATEMACHINE_PROCESS)">StateMachine#STATEMACHINE_PROCESS</a> FsmP </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string Event </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string From </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string To </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em><a href="Unit.html##(UNIT)">Unit#UNIT</a> CargoCarrier </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number Speed </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number LoadDistance </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number Angle </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO_PACKAGE).onafterOnBoard" >
|
|
<strong>CARGO_PACKAGE:onafterOnBoard(FsmP, Event, From, To, CargoCarrier, Speed, BoardDistance, Angle, LoadDistance)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Board Event.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="StateMachine.html##(STATEMACHINE_PROCESS)">StateMachine#STATEMACHINE_PROCESS</a> FsmP </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string Event </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string From </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string To </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em><a href="Unit.html##(UNIT)">Unit#UNIT</a> CargoCarrier </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number Speed </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number BoardDistance </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number Angle </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> LoadDistance </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO_PACKAGE).onafterOnBoarded" >
|
|
<strong>CARGO_PACKAGE:onafterOnBoarded(FsmP, Event, From, To, CargoCarrier, Speed, BoardDistance, LoadDistance, Angle)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Boarded Event.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="StateMachine.html##(STATEMACHINE_PROCESS)">StateMachine#STATEMACHINE_PROCESS</a> FsmP </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string Event </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string From </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string To </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em><a href="Unit.html##(UNIT)">Unit#UNIT</a> CargoCarrier </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> Speed </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> BoardDistance </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> LoadDistance </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> Angle </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO_PACKAGE).onafterUnBoard" >
|
|
<strong>CARGO_PACKAGE:onafterUnBoard(FsmP, Event, From, To, Speed, UnLoadDistance, UnBoardDistance, Radius, Angle, CargoCarrier)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>UnBoard Event.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="StateMachine.html##(STATEMACHINE_PROCESS)">StateMachine#STATEMACHINE_PROCESS</a> FsmP </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string Event </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string From </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string To </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number Speed </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number UnLoadDistance </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number UnBoardDistance </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number Radius </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number Angle </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> CargoCarrier </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO_PACKAGE).onafterUnBoarded" >
|
|
<strong>CARGO_PACKAGE:onafterUnBoarded(FsmP, Event, From, To, CargoCarrier, Speed)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>UnBoarded Event.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="StateMachine.html##(STATEMACHINE_PROCESS)">StateMachine#STATEMACHINE_PROCESS</a> FsmP </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string Event </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string From </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string To </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em><a href="Unit.html##(UNIT)">Unit#UNIT</a> CargoCarrier </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> Speed </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO_PACKAGE).onafterUnLoad" >
|
|
<strong>CARGO_PACKAGE:onafterUnLoad(FsmP, Event, From, To, Distance, Angle, CargoCarrier, Speed)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>UnLoad Event.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="StateMachine.html##(STATEMACHINE_PROCESS)">StateMachine#STATEMACHINE_PROCESS</a> FsmP </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string Event </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string From </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string To </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number Distance </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number Angle </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> CargoCarrier </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> Speed </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h2><a id="#(CARGO_REPRESENTABLE)" >Type <code>CARGO_REPRESENTABLE</code></a></h2>
|
|
<h3>Field(s)</h3>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#string</em>
|
|
<a id="#(CARGO_REPRESENTABLE).ClassName" >
|
|
<strong>CARGO_REPRESENTABLE.ClassName</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO_REPRESENTABLE).New" >
|
|
<strong>CARGO_REPRESENTABLE:New(Mission, CargoObject, Type, Name, Weight, ReportRadius, NearRadius)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>CARGO_REPRESENTABLE Constructor.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Mission.html##(MISSION)">Mission#MISSION</a> Mission </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em><a href="Controllable.html##(Controllable)">Controllable#Controllable</a> CargoObject </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string Type </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string Name </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number Weight </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number ReportRadius </em></code>:
|
|
(optional)</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number NearRadius </em></code>:
|
|
(optional)</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(CARGO_REPRESENTABLE)">#CARGO_REPRESENTABLE</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h2><a id="#(CARGO_UNIT)" >Type <code>CARGO_UNIT</code></a></h2>
|
|
<h3>Field(s)</h3>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO_UNIT).CargoCarrier" >
|
|
<strong>CARGO_UNIT.CargoCarrier</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(CARGO_UNIT).CargoInAir" >
|
|
<strong>CARGO_UNIT.CargoInAir</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(CARGO_UNIT).CargoObject" >
|
|
<strong>CARGO_UNIT.CargoObject</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#string</em>
|
|
<a id="#(CARGO_UNIT).ClassName" >
|
|
<strong>CARGO_UNIT.ClassName</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO_UNIT).New" >
|
|
<strong>CARGO_UNIT:New(Mission, CargoUnit, Type, Name, Weight, ReportRadius, NearRadius)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>CARGO_UNIT Constructor.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Mission.html##(MISSION)">Mission#MISSION</a> Mission </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em><a href="Unit.html##(UNIT)">Unit#UNIT</a> CargoUnit </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string Type </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string Name </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number Weight </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number ReportRadius </em></code>:
|
|
(optional)</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number NearRadius </em></code>:
|
|
(optional)</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(CARGO_UNIT)">#CARGO_UNIT</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO_UNIT).OnLoadedCallBack" >
|
|
<strong>CARGO_UNIT.OnLoadedCallBack</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO_UNIT).OnUnLoadedCallBack" >
|
|
<strong>CARGO_UNIT.OnUnLoadedCallBack</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO_UNIT).onafterBoard" >
|
|
<strong>CARGO_UNIT:onafterBoard(Event, From, To, CargoCarrier)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Board Event.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#string Event </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string From </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string To </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> CargoCarrier </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO_UNIT).onafterUnBoarded" >
|
|
<strong>CARGO_UNIT:onafterUnBoarded(ToPointVec2, Event, From, To)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>UnBoard Event.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Point.html##(POINT_VEC2)">Point#POINT_VEC2</a> ToPointVec2 </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string Event </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string From </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string To </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO_UNIT).onenterBoarding" >
|
|
<strong>CARGO_UNIT:onenterBoarding(CargoCarrier, Event, From, To)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Enter Boarding State.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Unit.html##(UNIT)">Unit#UNIT</a> CargoCarrier </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string Event </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string From </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string To </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO_UNIT).onenterLoaded" >
|
|
<strong>CARGO_UNIT:onenterLoaded(CargoCarrier, Event, From, To)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Loaded State.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Unit.html##(UNIT)">Unit#UNIT</a> CargoCarrier </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string Event </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string From </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string To </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO_UNIT).onenterUnBoarding" >
|
|
<strong>CARGO_UNIT:onenterUnBoarding(ToPointVec2, Event, From, To)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Enter UnBoarding State.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Point.html##(POINT_VEC2)">Point#POINT_VEC2</a> ToPointVec2 </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string Event </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string From </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string To </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO_UNIT).onenterUnLoaded" >
|
|
<strong>CARGO_UNIT:onenterUnLoaded(Point, Event, From, To, ToPointVec2)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Enter UnLoaded State.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em> Point </em></code>:
|
|
POINT_VEC2</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string Event </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string From </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string To </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> ToPointVec2 </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO_UNIT).onleaveBoarding" >
|
|
<strong>CARGO_UNIT:onleaveBoarding(CargoCarrier, Event, From, To)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Leave Boarding State.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Unit.html##(UNIT)">Unit#UNIT</a> CargoCarrier </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string Event </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string From </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string To </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(CARGO_UNIT).onleaveUnBoarding" >
|
|
<strong>CARGO_UNIT:onleaveUnBoarding(ToPointVec2, Event, From, To)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Leave UnBoarding State.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Point.html##(POINT_VEC2)">Point#POINT_VEC2</a> ToPointVec2 </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string Event </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string From </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string To </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|