mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-08-15 10:47:21 +00:00
2832 lines
60 KiB
HTML
2832 lines
60 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="AI_Balancer.html">AI_Balancer</a></li>
|
|
<li><a href="Account.html">Account</a></li>
|
|
<li><a href="Airbase.html">Airbase</a></li>
|
|
<li><a href="AirbasePolice.html">AirbasePolice</a></li>
|
|
<li><a href="Assign.html">Assign</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="CommandCenter.html">CommandCenter</a></li>
|
|
<li><a href="Controllable.html">Controllable</a></li>
|
|
<li><a href="Database.html">Database</a></li>
|
|
<li><a href="Detection.html">Detection</a></li>
|
|
<li><a href="Escort.html">Escort</a></li>
|
|
<li><a href="Event.html">Event</a></li>
|
|
<li><a href="Fsm.html">Fsm</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="Patrol.html">Patrol</a></li>
|
|
<li><a href="Point.html">Point</a></li>
|
|
<li><a href="Positionable.html">Positionable</a></li>
|
|
<li><a href="Process_JTAC.html">Process_JTAC</a></li>
|
|
<li><a href="Process_Pickup.html">Process_Pickup</a></li>
|
|
<li><a href="Route.html">Route</a></li>
|
|
<li><a href="ScheduleDispatcher.html">ScheduleDispatcher</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="Smoke.html">Smoke</a></li>
|
|
<li><a href="Spawn.html">Spawn</a></li>
|
|
<li><a href="Static.html">Static</a></li>
|
|
<li><a href="Task.html">Task</a></li>
|
|
<li><a href="Task_A2G.html">Task_A2G</a></li>
|
|
<li><a href="Task_PICKUP.html">Task_PICKUP</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="routines.html">routines</a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="content">
|
|
<h1>Module <code>Cargo</code></h1>
|
|
|
|
<p>Management of logical cargo objects, that can be transported from and to transportation carriers.</p>
|
|
|
|
|
|
|
|
<hr/>
|
|
|
|
<p>Cargo can be of various forms, always are composed out of ONE object ( one unit or one static or one slingload crate ):</p>
|
|
|
|
<ul>
|
|
<li><p>AI<em>CARGO</em>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.</p></li>
|
|
<li><p>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.</p></li>
|
|
<li><p>AI<em>CARGO</em>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.</p></li>
|
|
<li><p>AI<em>CARGO</em>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.</p></li>
|
|
<li><p>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.</p></li>
|
|
<li><p>AI<em>CARGO</em>GROUPED, represented by a Group of CARGO_UNITs.</p></li>
|
|
</ul>
|
|
|
|
<h1>1) <a href="AI.AI_Cargo.html##(AI_CARGO)">AI.AI<em>Cargo#AI</em>CARGO</a> class, extends <a href="Core.Fsm.html##(FSM_PROCESS)">Core.Fsm#FSM_PROCESS</a></h1>
|
|
<p>The <a href="##(AI_CARGO)">#AI_CARGO</a> class defines the core functions that defines a cargo object within MOOSE.
|
|
A cargo is a logical object defined that is available for transport, and has a life status within a simulation.</p>
|
|
|
|
<p>The AI<em>CARGO is a state machine: it manages the different events and states of the cargo.
|
|
All derived classes from AI</em>CARGO follow the same state machine, expose the same cargo event functions, and provide the same cargo states.</p>
|
|
|
|
<h2>1.2.1) AI_CARGO Events:</h2>
|
|
|
|
<ul>
|
|
<li><a href="##(AI_CARGO).Board">AI_CARGO.Board</a>( ToCarrier ): Boards the cargo to a carrier.</li>
|
|
<li><a href="##(AI_CARGO).Load">AI_CARGO.Load</a>( ToCarrier ): Loads the cargo into a carrier, regardless of its position.</li>
|
|
<li><a href="##(AI_CARGO).UnBoard">AI_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="##(AI_CARGO).UnLoad">AI_CARGO.UnLoad</a>( ToPointVec2 ): UnLoads the cargo from a carrier.</li>
|
|
<li><a href="##(AI_CARGO).Dead">AI_CARGO.Dead</a>( Controllable ): The cargo is dead. The cargo process will be ended.</li>
|
|
</ul>
|
|
|
|
<h2>1.2.2) AI_CARGO States:</h2>
|
|
|
|
<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>
|
|
|
|
<h2>1.2.3) AI_CARGO state transition methods:</h2>
|
|
|
|
<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 methods will be called by the state machine:</p>
|
|
|
|
<ul>
|
|
<li><p><strong>Before</strong> the state transition.
|
|
The state transition method needs to start with the name <strong>OnBefore + the name of the state</strong>.
|
|
If the state transition method 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 method needs to start with the name <strong>OnAfter + the name of the state</strong>.
|
|
These state transition methods need to provide a return value, which is specified at the function description.</p></li>
|
|
</ul>
|
|
|
|
<h1>2) #AI<em>CARGO</em>UNIT class</h1>
|
|
<p>The AI<em>CARGO</em>UNIT class defines a cargo that is represented by a UNIT object within the simulator, and can be transported by a carrier.
|
|
Use the event functions as described above to Load, UnLoad, Board, UnBoard the AI<em>CARGO</em>UNIT objects to and from carriers.</p>
|
|
|
|
<h1>5) #AI<em>CARGO</em>GROUPED class</h1>
|
|
<p>The AI<em>CARGO</em>GROUPED class defines a cargo that is represented by a group of UNIT objects within the simulator, and can be transported by a carrier.
|
|
Use the event functions as described above to Load, UnLoad, Board, UnBoard the AI<em>CARGO</em>UNIT objects to and from carriers.</p>
|
|
|
|
<p>This module is still under construction, but is described above works already, and will keep working ...</p>
|
|
|
|
|
|
<h2>Global(s)</h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="#AI_CARGO">AI_CARGO</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="#AI_CARGO_GROUP">AI_CARGO_GROUP</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="#AI_CARGO_GROUPED">AI_CARGO_GROUPED</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="#AI_CARGO_PACKAGE">AI_CARGO_PACKAGE</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="#AI_CARGO_REPRESENTABLE">AI_CARGO_REPRESENTABLE</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="#AI_CARGO_UNIT">AI_CARGO_UNIT</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="#CARGOS">CARGOS</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<h2><a id="#(AI_CARGO)">Type <code>AI_CARGO</code></a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO).Board">AI_CARGO:Board(ToCarrier)</a></td>
|
|
<td class="summary">
|
|
<p>Boards the cargo to a Carrier.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO).CargoCarrier">AI_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="##(AI_CARGO).CargoObject">AI_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="##(AI_CARGO).ClassName">AI_CARGO.ClassName</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO).Containable">AI_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="##(AI_CARGO).IsNear">AI_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="##(AI_CARGO).Load">AI_CARGO:Load(ToCarrier)</a></td>
|
|
<td class="summary">
|
|
<p>Loads the cargo to a Carrier.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO).Moveable">AI_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="##(AI_CARGO).Name">AI_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="##(AI_CARGO).NearRadius">AI_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="##(AI_CARGO).New">AI_CARGO:New(Type, Name, Weight, ReportRadius, NearRadius)</a></td>
|
|
<td class="summary">
|
|
<p>AI_CARGO Constructor.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO).OnAfterBoarding">AI_CARGO:OnAfterBoarding(Controllable)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO).OnAfterLoaded">AI_CARGO:OnAfterLoaded(Controllable)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO).OnAfterUnBoarding">AI_CARGO:OnAfterUnBoarding(Controllable)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO).OnAfterUnLoaded">AI_CARGO:OnAfterUnLoaded(Controllable)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO).OnBeforeBoarding">AI_CARGO:OnBeforeBoarding(Controllable)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO).OnBeforeLoaded">AI_CARGO:OnBeforeLoaded(Controllable)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO).OnBeforeUnBoarding">AI_CARGO:OnBeforeUnBoarding(Controllable)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO).OnBeforeUnLoaded">AI_CARGO:OnBeforeUnLoaded(Controllable)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO).ReportRadius">AI_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="##(AI_CARGO).Representable">AI_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="##(AI_CARGO).Slingloadable">AI_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="##(AI_CARGO).Spawn">AI_CARGO:Spawn(PointVec2)</a></td>
|
|
<td class="summary">
|
|
<p>Template method to spawn a new representation of the AI_CARGO in the simulator.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO).Type">AI_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="##(AI_CARGO).UnBoard">AI_CARGO:UnBoard(ToPointVec2)</a></td>
|
|
<td class="summary">
|
|
<p>UnBoards the cargo to a Carrier.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO).UnLoad">AI_CARGO:UnLoad(ToPointVec2)</a></td>
|
|
<td class="summary">
|
|
<p>UnLoads the cargo to a Carrier.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO).Weight">AI_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>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO).__Board">AI_CARGO:__Board(DelaySeconds, ToCarrier)</a></td>
|
|
<td class="summary">
|
|
<p>Boards the cargo to a Carrier.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO).__Load">AI_CARGO:__Load(DelaySeconds, ToCarrier)</a></td>
|
|
<td class="summary">
|
|
<p>Loads the cargo to a Carrier.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO).__UnBoard">AI_CARGO:__UnBoard(DelaySeconds, ToPointVec2)</a></td>
|
|
<td class="summary">
|
|
<p>UnBoards the cargo to a Carrier.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO).__UnLoad">AI_CARGO:__UnLoad(DelaySeconds, ToPointVec2)</a></td>
|
|
<td class="summary">
|
|
<p>UnLoads the cargo to a Carrier.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2><a id="#(AI_CARGO_GROUP)">Type <code>AI_CARGO_GROUP</code></a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_GROUP).CargoSet">AI_CARGO_GROUP.CargoSet</a></td>
|
|
<td class="summary">
|
|
<p>A set of cargo objects.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_GROUP).ClassName">AI_CARGO_GROUP.ClassName</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_GROUP).Name">AI_CARGO_GROUP.Name</a></td>
|
|
<td class="summary">
|
|
<p>A string defining the name of the cargo group. The name is the unique identifier of the cargo.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_GROUP).New">AI_CARGO_GROUP:New(CargoSet, Type, Name, Weight, ReportRadius, NearRadius)</a></td>
|
|
<td class="summary">
|
|
<p>AI<em>CARGO</em>GROUP constructor.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2><a id="#(AI_CARGO_GROUPED)">Type <code>AI_CARGO_GROUPED</code></a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_GROUPED).ClassName">AI_CARGO_GROUPED.ClassName</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_GROUPED).New">AI_CARGO_GROUPED:New(CargoSet, Type, Name, Weight, ReportRadius, NearRadius)</a></td>
|
|
<td class="summary">
|
|
<p>AI<em>CARGO</em>GROUPED constructor.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_GROUPED).onafterUnBoarding">AI_CARGO_GROUPED:onafterUnBoarding(ToPointVec2, Event, From, To)</a></td>
|
|
<td class="summary">
|
|
<p>UnBoard Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_GROUPED).onenterBoarding">AI_CARGO_GROUPED: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="##(AI_CARGO_GROUPED).onenterLoaded">AI_CARGO_GROUPED:onenterLoaded(CargoCarrier, Event, From, To)</a></td>
|
|
<td class="summary">
|
|
<p>Enter Loaded State.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_GROUPED).onenterUnBoarding">AI_CARGO_GROUPED: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="##(AI_CARGO_GROUPED).onenterUnLoaded">AI_CARGO_GROUPED:onenterUnLoaded(Core, Event, From, To, ToPointVec2)</a></td>
|
|
<td class="summary">
|
|
<p>Enter UnLoaded State.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_GROUPED).onleaveBoarding">AI_CARGO_GROUPED: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="##(AI_CARGO_GROUPED).onleaveUnBoarding">AI_CARGO_GROUPED:onleaveUnBoarding(ToPointVec2, Event, From, To)</a></td>
|
|
<td class="summary">
|
|
<p>Leave UnBoarding State.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2><a id="#(AI_CARGO_PACKAGE)">Type <code>AI_CARGO_PACKAGE</code></a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_PACKAGE).CargoCarrier">AI_CARGO_PACKAGE.CargoCarrier</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_PACKAGE).CargoInAir">AI_CARGO_PACKAGE.CargoInAir</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_PACKAGE).ClassName">AI_CARGO_PACKAGE.ClassName</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_PACKAGE).IsNear">AI_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="##(AI_CARGO_PACKAGE).New">AI_CARGO_PACKAGE:New(CargoCarrier, Type, Name, Weight, ReportRadius, NearRadius)</a></td>
|
|
<td class="summary">
|
|
<p>AI<em>CARGO</em>PACKAGE Constructor.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_PACKAGE).onafterLoad">AI_CARGO_PACKAGE:onafterLoad(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="##(AI_CARGO_PACKAGE).onafterOnBoard">AI_CARGO_PACKAGE:onafterOnBoard(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="##(AI_CARGO_PACKAGE).onafterOnBoarded">AI_CARGO_PACKAGE:onafterOnBoarded(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="##(AI_CARGO_PACKAGE).onafterUnBoard">AI_CARGO_PACKAGE:onafterUnBoard(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="##(AI_CARGO_PACKAGE).onafterUnBoarded">AI_CARGO_PACKAGE:onafterUnBoarded(Event, From, To, CargoCarrier, Speed)</a></td>
|
|
<td class="summary">
|
|
<p>UnBoarded Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_PACKAGE).onafterUnLoad">AI_CARGO_PACKAGE:onafterUnLoad(Event, From, To, Distance, Angle, CargoCarrier, Speed)</a></td>
|
|
<td class="summary">
|
|
<p>UnLoad Event.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2><a id="#(AI_CARGO_REPRESENTABLE)">Type <code>AI_CARGO_REPRESENTABLE</code></a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_REPRESENTABLE).ClassName">AI_CARGO_REPRESENTABLE.ClassName</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_REPRESENTABLE).New">AI_CARGO_REPRESENTABLE:New(CargoObject, Type, Name, Weight, ReportRadius, NearRadius)</a></td>
|
|
<td class="summary">
|
|
<p>AI<em>CARGO</em>REPRESENTABLE Constructor.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_REPRESENTABLE).RouteTo">AI_CARGO_REPRESENTABLE:RouteTo(ToPointVec2, Speed)</a></td>
|
|
<td class="summary">
|
|
<p>Route a cargo unit to a PointVec2.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2><a id="#(AI_CARGO_UNIT)">Type <code>AI_CARGO_UNIT</code></a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_UNIT).CargoCarrier">AI_CARGO_UNIT.CargoCarrier</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_UNIT).CargoInAir">AI_CARGO_UNIT.CargoInAir</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_UNIT).CargoObject">AI_CARGO_UNIT.CargoObject</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_UNIT).ClassName">AI_CARGO_UNIT.ClassName</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_UNIT).New">AI_CARGO_UNIT:New(CargoUnit, Type, Name, Weight, ReportRadius, NearRadius)</a></td>
|
|
<td class="summary">
|
|
<p>AI<em>CARGO</em>UNIT Constructor.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_UNIT).OnUnLoadedCallBack">AI_CARGO_UNIT.OnUnLoadedCallBack</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_UNIT).onafterBoard">AI_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="##(AI_CARGO_UNIT).onafterUnBoarding">AI_CARGO_UNIT:onafterUnBoarding(Event, From, To, ToPointVec2)</a></td>
|
|
<td class="summary">
|
|
<p>UnBoard Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_UNIT).onenterBoarding">AI_CARGO_UNIT:onenterBoarding(Event, From, To, CargoCarrier)</a></td>
|
|
<td class="summary">
|
|
<p>Enter Boarding State.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_UNIT).onenterLoaded">AI_CARGO_UNIT:onenterLoaded(Event, From, To, CargoCarrier)</a></td>
|
|
<td class="summary">
|
|
<p>Loaded State.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_UNIT).onenterUnBoarding">AI_CARGO_UNIT:onenterUnBoarding(Event, From, To, ToPointVec2)</a></td>
|
|
<td class="summary">
|
|
<p>Enter UnBoarding State.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_UNIT).onenterUnLoaded">AI_CARGO_UNIT:onenterUnLoaded(Event, From, To, Core, ToPointVec2)</a></td>
|
|
<td class="summary">
|
|
<p>Enter UnLoaded State.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_UNIT).onleaveBoarding">AI_CARGO_UNIT:onleaveBoarding(Event, From, To, CargoCarrier)</a></td>
|
|
<td class="summary">
|
|
<p>Leave Boarding State.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(AI_CARGO_UNIT).onleaveUnBoarding">AI_CARGO_UNIT:onleaveUnBoarding(Event, From, To, ToPointVec2)</a></td>
|
|
<td class="summary">
|
|
<p>Leave UnBoarding State.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2>Global(s)</h2>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(AI_CARGO)">#AI_CARGO</a></em>
|
|
<a id="AI_CARGO" >
|
|
<strong>AI_CARGO</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(AI_CARGO_GROUP)">#AI_CARGO_GROUP</a></em>
|
|
<a id="AI_CARGO_GROUP" >
|
|
<strong>AI_CARGO_GROUP</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(AI_CARGO_GROUPED)">#AI_CARGO_GROUPED</a></em>
|
|
<a id="AI_CARGO_GROUPED" >
|
|
<strong>AI_CARGO_GROUPED</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(AI_CARGO_PACKAGE)">#AI_CARGO_PACKAGE</a></em>
|
|
<a id="AI_CARGO_PACKAGE" >
|
|
<strong>AI_CARGO_PACKAGE</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(AI_CARGO_REPRESENTABLE)">#AI_CARGO_REPRESENTABLE</a></em>
|
|
<a id="AI_CARGO_REPRESENTABLE" >
|
|
<strong>AI_CARGO_REPRESENTABLE</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(AI_CARGO_UNIT)">#AI_CARGO_UNIT</a></em>
|
|
<a id="AI_CARGO_UNIT" >
|
|
<strong>AI_CARGO_UNIT</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="CARGOS" >
|
|
<strong>CARGOS</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<h2><a id="#(Cargo)" >Type <code>Cargo</code></a></h2>
|
|
|
|
<h2><a id="#(AI_CARGO)" >Type <code>AI_CARGO</code></a></h2>
|
|
<h3>Field(s)</h3>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(AI_CARGO).Board" >
|
|
<strong>AI_CARGO:Board(ToCarrier)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Boards the cargo to a Carrier.</p>
|
|
|
|
|
|
<p>The event will create a movement (= running or driving) of the cargo to the Carrier.
|
|
The cargo must be in the <strong>UnLoaded</strong> state.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> ToCarrier </em></code>:
|
|
The Carrier that will hold the cargo.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a></em>
|
|
<a id="#(AI_CARGO).CargoCarrier" >
|
|
<strong>AI_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="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a></em>
|
|
<a id="#(AI_CARGO).CargoObject" >
|
|
<strong>AI_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>#string</em>
|
|
<a id="#(AI_CARGO).ClassName" >
|
|
<strong>AI_CARGO.ClassName</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#boolean</em>
|
|
<a id="#(AI_CARGO).Containable" >
|
|
<strong>AI_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="#(AI_CARGO).IsNear" >
|
|
<strong>AI_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="Core.Point.html##(POINT_VEC2)">Core.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="#(AI_CARGO).Load" >
|
|
<strong>AI_CARGO:Load(ToCarrier)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Loads the cargo to a Carrier.</p>
|
|
|
|
|
|
<p>The event will load the cargo into the Carrier regardless of its position. There will be no movement simulated of the cargo loading.
|
|
The cargo must be in the <strong>UnLoaded</strong> state.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.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="#(AI_CARGO).Moveable" >
|
|
<strong>AI_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="#(AI_CARGO).Name" >
|
|
<strong>AI_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="#(AI_CARGO).NearRadius" >
|
|
<strong>AI_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="#(AI_CARGO).New" >
|
|
<strong>AI_CARGO:New(Type, Name, Weight, ReportRadius, NearRadius)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>AI_CARGO Constructor.</p>
|
|
|
|
|
|
<p>This class is an abstract class and should not be instantiated.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<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="##(AI_CARGO)">#AI_CARGO</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(AI_CARGO).OnAfterBoarding" >
|
|
<strong>AI_CARGO:OnAfterBoarding(Controllable)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> Controllable </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(AI_CARGO).OnAfterLoaded" >
|
|
<strong>AI_CARGO:OnAfterLoaded(Controllable)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> Controllable </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(AI_CARGO).OnAfterUnBoarding" >
|
|
<strong>AI_CARGO:OnAfterUnBoarding(Controllable)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> Controllable </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(AI_CARGO).OnAfterUnLoaded" >
|
|
<strong>AI_CARGO:OnAfterUnLoaded(Controllable)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> Controllable </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(AI_CARGO).OnBeforeBoarding" >
|
|
<strong>AI_CARGO:OnBeforeBoarding(Controllable)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.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="#(AI_CARGO).OnBeforeLoaded" >
|
|
<strong>AI_CARGO:OnBeforeLoaded(Controllable)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.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="#(AI_CARGO).OnBeforeUnBoarding" >
|
|
<strong>AI_CARGO:OnBeforeUnBoarding(Controllable)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.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="#(AI_CARGO).OnBeforeUnLoaded" >
|
|
<strong>AI_CARGO:OnBeforeUnLoaded(Controllable)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.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="#(AI_CARGO).ReportRadius" >
|
|
<strong>AI_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="#(AI_CARGO).Representable" >
|
|
<strong>AI_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="#(AI_CARGO).Slingloadable" >
|
|
<strong>AI_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="#(AI_CARGO).Spawn" >
|
|
<strong>AI_CARGO:Spawn(PointVec2)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Template method to spawn a new representation of the AI_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="##(AI_CARGO)">#AI_CARGO</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#string</em>
|
|
<a id="#(AI_CARGO).Type" >
|
|
<strong>AI_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="#(AI_CARGO).UnBoard" >
|
|
<strong>AI_CARGO:UnBoard(ToPointVec2)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>UnBoards the cargo to a Carrier.</p>
|
|
|
|
|
|
<p>The event will create a movement (= running or driving) of the cargo from the Carrier.
|
|
The cargo must be in the <strong>Loaded</strong> state.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a> ToPointVec2 </em></code>:
|
|
(optional) @{Core.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>
|
|
|
|
<a id="#(AI_CARGO).UnLoad" >
|
|
<strong>AI_CARGO:UnLoad(ToPointVec2)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>UnLoads the cargo to a Carrier.</p>
|
|
|
|
|
|
<p>The event will unload the cargo from the Carrier. There will be no movement simulated of the cargo loading.
|
|
The cargo must be in the <strong>Loaded</strong> state.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a> ToPointVec2 </em></code>:
|
|
(optional) @{Core.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>#number</em>
|
|
<a id="#(AI_CARGO).Weight" >
|
|
<strong>AI_CARGO.Weight</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>A number defining the weight of the cargo. The weight is expressed in kg.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(AI_CARGO).__Board" >
|
|
<strong>AI_CARGO:__Board(DelaySeconds, ToCarrier)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Boards the cargo to a Carrier.</p>
|
|
|
|
|
|
<p>The event will create a movement (= running or driving) of the cargo to the Carrier.
|
|
The cargo must be in the <strong>UnLoaded</strong> state.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number DelaySeconds </em></code>:
|
|
The amount of seconds to delay the action.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> ToCarrier </em></code>:
|
|
The Carrier that will hold the cargo.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(AI_CARGO).__Load" >
|
|
<strong>AI_CARGO:__Load(DelaySeconds, ToCarrier)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Loads the cargo to a Carrier.</p>
|
|
|
|
|
|
<p>The event will load the cargo into the Carrier regardless of its position. There will be no movement simulated of the cargo loading.
|
|
The cargo must be in the <strong>UnLoaded</strong> state.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number DelaySeconds </em></code>:
|
|
The amount of seconds to delay the action.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> ToCarrier </em></code>:
|
|
The Carrier that will hold the cargo.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(AI_CARGO).__UnBoard" >
|
|
<strong>AI_CARGO:__UnBoard(DelaySeconds, ToPointVec2)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>UnBoards the cargo to a Carrier.</p>
|
|
|
|
|
|
<p>The event will create a movement (= running or driving) of the cargo from the Carrier.
|
|
The cargo must be in the <strong>Loaded</strong> state.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number DelaySeconds </em></code>:
|
|
The amount of seconds to delay the action.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em><a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a> ToPointVec2 </em></code>:
|
|
(optional) @{Core.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>
|
|
|
|
<a id="#(AI_CARGO).__UnLoad" >
|
|
<strong>AI_CARGO:__UnLoad(DelaySeconds, ToPointVec2)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>UnLoads the cargo to a Carrier.</p>
|
|
|
|
|
|
<p>The event will unload the cargo from the Carrier. There will be no movement simulated of the cargo loading.
|
|
The cargo must be in the <strong>Loaded</strong> state.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number DelaySeconds </em></code>:
|
|
The amount of seconds to delay the action.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em><a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a> ToPointVec2 </em></code>:
|
|
(optional) @{Core.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>
|
|
|
|
<h2><a id="#(AI_CARGO.CargoObjects)" >Type <code>AI_CARGO.CargoObjects</code></a></h2>
|
|
|
|
<h2><a id="#(AI_CARGO_GROUP)" >Type <code>AI_CARGO_GROUP</code></a></h2>
|
|
<h3>Field(s)</h3>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="Set.html##(SET_BASE)">Set#SET_BASE</a></em>
|
|
<a id="#(AI_CARGO_GROUP).CargoSet" >
|
|
<strong>AI_CARGO_GROUP.CargoSet</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>A set of cargo objects.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#string</em>
|
|
<a id="#(AI_CARGO_GROUP).ClassName" >
|
|
<strong>AI_CARGO_GROUP.ClassName</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#string</em>
|
|
<a id="#(AI_CARGO_GROUP).Name" >
|
|
<strong>AI_CARGO_GROUP.Name</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>A string defining the name of the cargo group. The name is the unique identifier of the cargo.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(AI_CARGO_GROUP).New" >
|
|
<strong>AI_CARGO_GROUP:New(CargoSet, Type, Name, Weight, ReportRadius, NearRadius)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>AI<em>CARGO</em>GROUP constructor.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Core.Set.html##(Set_BASE)">Core.Set#Set_BASE</a> CargoSet </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="##(AI_CARGO_GROUP)">#AI<em>CARGO</em>GROUP</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h2><a id="#(AI_CARGO_GROUPED)" >Type <code>AI_CARGO_GROUPED</code></a></h2>
|
|
<h3>Field(s)</h3>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#string</em>
|
|
<a id="#(AI_CARGO_GROUPED).ClassName" >
|
|
<strong>AI_CARGO_GROUPED.ClassName</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(AI_CARGO_GROUPED).New" >
|
|
<strong>AI_CARGO_GROUPED:New(CargoSet, Type, Name, Weight, ReportRadius, NearRadius)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>AI<em>CARGO</em>GROUPED constructor.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Core.Set.html##(Set_BASE)">Core.Set#Set_BASE</a> CargoSet </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="##(AI_CARGO_GROUPED)">#AI<em>CARGO</em>GROUPED</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(AI_CARGO_GROUPED).onafterUnBoarding" >
|
|
<strong>AI_CARGO_GROUPED:onafterUnBoarding(ToPointVec2, Event, From, To)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>UnBoard Event.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Core.Point.html##(POINT_VEC2)">Core.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="#(AI_CARGO_GROUPED).onenterBoarding" >
|
|
<strong>AI_CARGO_GROUPED:onenterBoarding(CargoCarrier, Event, From, To)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Enter Boarding State.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.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="#(AI_CARGO_GROUPED).onenterLoaded" >
|
|
<strong>AI_CARGO_GROUPED:onenterLoaded(CargoCarrier, Event, From, To)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Enter Loaded State.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.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="#(AI_CARGO_GROUPED).onenterUnBoarding" >
|
|
<strong>AI_CARGO_GROUPED:onenterUnBoarding(ToPointVec2, Event, From, To)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Enter UnBoarding State.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Core.Point.html##(POINT_VEC2)">Core.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="#(AI_CARGO_GROUPED).onenterUnLoaded" >
|
|
<strong>AI_CARGO_GROUPED:onenterUnLoaded(Core, Event, From, To, ToPointVec2)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Enter UnLoaded State.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em> Core </em></code>:
|
|
Point#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="#(AI_CARGO_GROUPED).onleaveBoarding" >
|
|
<strong>AI_CARGO_GROUPED:onleaveBoarding(CargoCarrier, Event, From, To)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Leave Boarding State.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.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="#(AI_CARGO_GROUPED).onleaveUnBoarding" >
|
|
<strong>AI_CARGO_GROUPED:onleaveUnBoarding(ToPointVec2, Event, From, To)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Leave UnBoarding State.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Core.Point.html##(POINT_VEC2)">Core.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>
|
|
|
|
<h2><a id="#(AI_CARGO_PACKAGE)" >Type <code>AI_CARGO_PACKAGE</code></a></h2>
|
|
<h3>Field(s)</h3>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(AI_CARGO_PACKAGE).CargoCarrier" >
|
|
<strong>AI_CARGO_PACKAGE.CargoCarrier</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(AI_CARGO_PACKAGE).CargoInAir" >
|
|
<strong>AI_CARGO_PACKAGE.CargoInAir</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#string</em>
|
|
<a id="#(AI_CARGO_PACKAGE).ClassName" >
|
|
<strong>AI_CARGO_PACKAGE.ClassName</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(AI_CARGO_PACKAGE).IsNear" >
|
|
<strong>AI_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="Wrapper.Unit.html##(UNIT)">Wrapper.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="#(AI_CARGO_PACKAGE).New" >
|
|
<strong>AI_CARGO_PACKAGE:New(CargoCarrier, Type, Name, Weight, ReportRadius, NearRadius)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>AI<em>CARGO</em>PACKAGE Constructor.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.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="##(AI_CARGO_PACKAGE)">#AI<em>CARGO</em>PACKAGE</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(AI_CARGO_PACKAGE).onafterLoad" >
|
|
<strong>AI_CARGO_PACKAGE:onafterLoad(Event, From, To, CargoCarrier, Speed, LoadDistance, Angle)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Load 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><a href="Wrapper.Unit.html##(UNIT)">Wrapper.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="#(AI_CARGO_PACKAGE).onafterOnBoard" >
|
|
<strong>AI_CARGO_PACKAGE:onafterOnBoard(Event, From, To, CargoCarrier, Speed, BoardDistance, Angle, LoadDistance)</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><a href="Wrapper.Unit.html##(UNIT)">Wrapper.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="#(AI_CARGO_PACKAGE).onafterOnBoarded" >
|
|
<strong>AI_CARGO_PACKAGE:onafterOnBoarded(Event, From, To, CargoCarrier, Speed, BoardDistance, LoadDistance, Angle)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Boarded 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><a href="Wrapper.Unit.html##(UNIT)">Wrapper.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="#(AI_CARGO_PACKAGE).onafterUnBoard" >
|
|
<strong>AI_CARGO_PACKAGE:onafterUnBoard(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>#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="#(AI_CARGO_PACKAGE).onafterUnBoarded" >
|
|
<strong>AI_CARGO_PACKAGE:onafterUnBoarded(Event, From, To, CargoCarrier, Speed)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>UnBoarded 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><a href="Wrapper.Unit.html##(UNIT)">Wrapper.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="#(AI_CARGO_PACKAGE).onafterUnLoad" >
|
|
<strong>AI_CARGO_PACKAGE:onafterUnLoad(Event, From, To, Distance, Angle, CargoCarrier, Speed)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>UnLoad 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>#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="#(AI_CARGO_REPRESENTABLE)" >Type <code>AI_CARGO_REPRESENTABLE</code></a></h2>
|
|
<h3>Field(s)</h3>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#string</em>
|
|
<a id="#(AI_CARGO_REPRESENTABLE).ClassName" >
|
|
<strong>AI_CARGO_REPRESENTABLE.ClassName</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(AI_CARGO_REPRESENTABLE).New" >
|
|
<strong>AI_CARGO_REPRESENTABLE:New(CargoObject, Type, Name, Weight, ReportRadius, NearRadius)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>AI<em>CARGO</em>REPRESENTABLE Constructor.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Controllable.html##(Controllable)">Wrapper.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="##(AI_CARGO_REPRESENTABLE)">#AI<em>CARGO</em>REPRESENTABLE</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(AI_CARGO_REPRESENTABLE).RouteTo" >
|
|
<strong>AI_CARGO_REPRESENTABLE:RouteTo(ToPointVec2, Speed)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Route a cargo unit to a PointVec2.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a> ToPointVec2 </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#number Speed </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(AI_CARGO_REPRESENTABLE)">#AI<em>CARGO</em>REPRESENTABLE</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h2><a id="#(AI_CARGO_UNIT)" >Type <code>AI_CARGO_UNIT</code></a></h2>
|
|
<h3>Field(s)</h3>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(AI_CARGO_UNIT).CargoCarrier" >
|
|
<strong>AI_CARGO_UNIT.CargoCarrier</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(AI_CARGO_UNIT).CargoInAir" >
|
|
<strong>AI_CARGO_UNIT.CargoInAir</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(AI_CARGO_UNIT).CargoObject" >
|
|
<strong>AI_CARGO_UNIT.CargoObject</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em>#string</em>
|
|
<a id="#(AI_CARGO_UNIT).ClassName" >
|
|
<strong>AI_CARGO_UNIT.ClassName</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(AI_CARGO_UNIT).New" >
|
|
<strong>AI_CARGO_UNIT:New(CargoUnit, Type, Name, Weight, ReportRadius, NearRadius)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>AI<em>CARGO</em>UNIT Constructor.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.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="##(AI_CARGO_UNIT)">#AI<em>CARGO</em>UNIT</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(AI_CARGO_UNIT).OnUnLoadedCallBack" >
|
|
<strong>AI_CARGO_UNIT.OnUnLoadedCallBack</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(AI_CARGO_UNIT).onafterBoard" >
|
|
<strong>AI_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="#(AI_CARGO_UNIT).onafterUnBoarding" >
|
|
<strong>AI_CARGO_UNIT:onafterUnBoarding(Event, From, To, ToPointVec2)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>UnBoard 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><a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a> ToPointVec2 </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(AI_CARGO_UNIT).onenterBoarding" >
|
|
<strong>AI_CARGO_UNIT:onenterBoarding(Event, From, To, CargoCarrier)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Enter Boarding State.</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><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> CargoCarrier </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(AI_CARGO_UNIT).onenterLoaded" >
|
|
<strong>AI_CARGO_UNIT:onenterLoaded(Event, From, To, CargoCarrier)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Loaded State.</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><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> CargoCarrier </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(AI_CARGO_UNIT).onenterUnBoarding" >
|
|
<strong>AI_CARGO_UNIT:onenterUnBoarding(Event, From, To, ToPointVec2)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Enter UnBoarding State.</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><a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a> ToPointVec2 </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(AI_CARGO_UNIT).onenterUnLoaded" >
|
|
<strong>AI_CARGO_UNIT:onenterUnLoaded(Event, From, To, Core, ToPointVec2)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Enter UnLoaded State.</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> Core </em></code>:
|
|
Point#POINT_VEC2</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> ToPointVec2 </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(AI_CARGO_UNIT).onleaveBoarding" >
|
|
<strong>AI_CARGO_UNIT:onleaveBoarding(Event, From, To, CargoCarrier)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Leave Boarding State.</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><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> CargoCarrier </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(AI_CARGO_UNIT).onleaveUnBoarding" >
|
|
<strong>AI_CARGO_UNIT:onleaveUnBoarding(Event, From, To, ToPointVec2)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Leave UnBoarding State.</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><a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a> ToPointVec2 </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|