weyne/MOOSE
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE.git synced 2025-08-15 10:47:21 +00:00
Code Issues Packages Projects Releases Wiki Activity
MOOSE/docs/Documentation/Positionable.html
FlightControl_Master 0e4a5c02d5 Working version, fiew!
2017-10-26 14:54:59 +02:00

2072 lines
48 KiB
HTML
Raw Blame History

<!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_A2A.html">AI_A2A</a></li>
<li><a href="AI_A2A_Cap.html">AI_A2A_Cap</a></li>
<li><a href="AI_A2A_Dispatcher.html">AI_A2A_Dispatcher</a></li>
<li><a href="AI_A2A_GCI.html">AI_A2A_GCI</a></li>
<li><a href="AI_A2A_Patrol.html">AI_A2A_Patrol</a></li>
<li><a href="AI_Bai.html">AI_Bai</a></li>
<li><a href="AI_Balancer.html">AI_Balancer</a></li>
<li><a href="AI_Cap.html">AI_Cap</a></li>
<li><a href="AI_Cas.html">AI_Cas</a></li>
<li><a href="AI_Formation.html">AI_Formation</a></li>
<li><a href="AI_Patrol.html">AI_Patrol</a></li>
<li><a href="ATC_Ground.html">ATC_Ground</a></li>
<li><a href="Account.html">Account</a></li>
<li><a href="Airbase.html">Airbase</a></li>
<li><a href="Assign.html">Assign</a></li>
<li><a href="Base.html">Base</a></li>
<li><a href="Cargo.html">Cargo</a></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="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="DCSVec3.html">DCSVec3</a></li>
<li><a href="DCSWorld.html">DCSWorld</a></li>
<li><a href="DCSZone.html">DCSZone</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="Designate.html">Designate</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="Fsm.html">Fsm</a></li>
<li><a href="Goal.html">Goal</a></li>
<li><a href="Group.html">Group</a></li>
<li><a href="Identifiable.html">Identifiable</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="Movement.html">Movement</a></li>
<li><a href="Object.html">Object</a></li>
<li><a href="Point.html">Point</a></li>
<li>Positionable</li>
<li><a href="Process_JTAC.html">Process_JTAC</a></li>
<li><a href="Process_Pickup.html">Process_Pickup</a></li>
<li><a href="Protect.html">Protect</a></li>
<li><a href="Radio.html">Radio</a></li>
<li><a href="Rat.html">Rat</a></li>
<li><a href="Route.html">Route</a></li>
<li><a href="Scenery.html">Scenery</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="Settings.html">Settings</a></li>
<li><a href="Smoke.html">Smoke</a></li>
<li><a href="Spawn.html">Spawn</a></li>
<li><a href="SpawnStatic.html">SpawnStatic</a></li>
<li><a href="Spot.html">Spot</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="TaskZoneCapture.html">TaskZoneCapture</a></li>
<li><a href="Task_A2A.html">Task_A2A</a></li>
<li><a href="Task_A2A_Dispatcher.html">Task_A2A_Dispatcher</a></li>
<li><a href="Task_A2G.html">Task_A2G</a></li>
<li><a href="Task_A2G_Dispatcher.html">Task_A2G_Dispatcher</a></li>
<li><a href="Task_Cargo.html">Task_Cargo</a></li>
<li><a href="Task_PICKUP.html">Task_PICKUP</a></li>
<li><a href="Unit.html">Unit</a></li>
<li><a href="UserFlag.html">UserFlag</a></li>
<li><a href="UserSound.html">UserSound</a></li>
<li><a href="Utils.html">Utils</a></li>
<li><a href="Zone.html">Zone</a></li>
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</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>Positionable</code></h1>
<p><strong>Wrapper</strong> -- POSITIONABLE wraps DCS classes that are "positionable".</p>
<hr/>
<h3>Author: <strong>Sven Van de Velde (FlightControl)</strong></h3>
<h3>Contributions:</h3>
<hr/>
<h2>Global(s)</h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="#POSITIONABLE">POSITIONABLE</a></td>
<td class="summary">
<h1>POSITIONABLE class, extends <a href="Identifiable.html##(IDENTIFIABLE)">Identifiable#IDENTIFIABLE</a></h1>
<p>The POSITIONABLE class is a wrapper class to handle the POSITIONABLE objects:</p>
<ul>
<li>Support all DCS APIs.</li>
</ul>
</td>
</tr>
</table>
<h2><a id="#(DCSPositionable)">Type <code>DCSPositionable</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(DCSPositionable).id_">DCSPositionable.id_</a></td>
<td class="summary">
<p>The ID of the controllable in DCS</p>
</td>
</tr>
</table>
<h2><a id="#(POSITIONABLE)">Type <code>POSITIONABLE</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).AddCargo">POSITIONABLE:AddCargo(Cargo)</a></td>
<td class="summary">
<p>Add cargo.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).CargoItemCount">POSITIONABLE:CargoItemCount()</a></td>
<td class="summary">
<p>Get cargo item count.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).ClearCargo">POSITIONABLE:ClearCargo()</a></td>
<td class="summary">
<p>Clear all cargo.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).Flare">POSITIONABLE:Flare(FlareColor)</a></td>
<td class="summary">
<p>Signal a flare at the position of the POSITIONABLE.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).FlareGreen">POSITIONABLE:FlareGreen()</a></td>
<td class="summary">
<p>Signal a green flare at the position of the POSITIONABLE.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).FlareRed">POSITIONABLE:FlareRed()</a></td>
<td class="summary">
<p>Signal a red flare at the position of the POSITIONABLE.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).FlareWhite">POSITIONABLE:FlareWhite()</a></td>
<td class="summary">
<p>Signal a white flare at the position of the POSITIONABLE.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).FlareYellow">POSITIONABLE:FlareYellow()</a></td>
<td class="summary">
<p>Signal a yellow flare at the position of the POSITIONABLE.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetAltitude">POSITIONABLE:GetAltitude()</a></td>
<td class="summary">
<p>Returns the altitude of the POSITIONABLE.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetBeacon">POSITIONABLE:GetBeacon()</a></td>
<td class="summary">
<p>Create a <a href="Radio.html##(BEACON)">Radio#BEACON</a>, to allow this POSITIONABLE to broadcast beacon signals</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetBoundingBox">POSITIONABLE:GetBoundingBox()</a></td>
<td class="summary">
<p>Get the bounding box of the underlying POSITIONABLE DCS Object.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetCoordinate">POSITIONABLE:GetCoordinate()</a></td>
<td class="summary">
<p>Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetHeading">POSITIONABLE:GetHeading()</a></td>
<td class="summary">
<p>Returns the POSITIONABLE heading in degrees.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetHeight">POSITIONABLE:GetHeight()</a></td>
<td class="summary">
<p>Returns the POSITIONABLE height in meters.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetLaserCode">POSITIONABLE:GetLaserCode()</a></td>
<td class="summary">
<p>Get the last assigned laser code</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetMessage">POSITIONABLE:GetMessage(Message, Duration, Name)</a></td>
<td class="summary">
<p>Returns a message with the callsign embedded (if there is one).</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetMessageText">POSITIONABLE:GetMessageText(Message, Name)</a></td>
<td class="summary">
<p>Returns the message text with the callsign embedded (if there is one).</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetMessageType">POSITIONABLE:GetMessageType(Message, MessageType, Name)</a></td>
<td class="summary">
<p>Returns a message of a specified type with the callsign embedded (if there is one).</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetPointVec2">POSITIONABLE:GetPointVec2()</a></td>
<td class="summary">
<p>Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetPointVec3">POSITIONABLE:GetPointVec3()</a></td>
<td class="summary">
<p>Returns a POINT_VEC3 object indicating the point in 3D of the POSITIONABLE within the mission.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetPositionVec3">POSITIONABLE:GetPositionVec3()</a></td>
<td class="summary">
<p>Returns the <a href="DCSTypes.html##(Position3)">DCSTypes#Position3</a> position vectors indicating the point and direction vectors in 3D of the POSITIONABLE within the mission.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetRadio">POSITIONABLE:GetRadio()</a></td>
<td class="summary">
<p>Create a <a href="Radio.html##(RADIO)">Radio#RADIO</a>, to allow radio transmission for this POSITIONABLE.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetRandomVec3">POSITIONABLE:GetRandomVec3(Radius)</a></td>
<td class="summary">
<p>Returns a random <a href="DCSTypes.html##(Vec3)">DCSTypes#Vec3</a> vector within a range, indicating the point in 3D of the POSITIONABLE within the mission.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetSpot">POSITIONABLE:GetSpot()</a></td>
<td class="summary">
<p>Get the Spot</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetVec2">POSITIONABLE:GetVec2()</a></td>
<td class="summary">
<p>Returns the <a href="DCSTypes.html##(Vec2)">DCSTypes#Vec2</a> vector indicating the point in 2D of the POSITIONABLE within the mission.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetVec3">POSITIONABLE:GetVec3()</a></td>
<td class="summary">
<p>Returns the <a href="DCSTypes.html##(Vec3)">DCSTypes#Vec3</a> vector indicating the 3D vector of the POSITIONABLE within the mission.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetVelocity">POSITIONABLE:GetVelocity()</a></td>
<td class="summary">
<p>Returns the a <a href="Velocity.html">Velocity</a> object from the positionable.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetVelocityKMH">POSITIONABLE:GetVelocityKMH()</a></td>
<td class="summary">
<p>Returns the POSITIONABLE velocity in km/h.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetVelocityMPS">POSITIONABLE:GetVelocityMPS()</a></td>
<td class="summary">
<p>Returns the POSITIONABLE velocity in meters per second.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetVelocityVec3">POSITIONABLE:GetVelocityVec3()</a></td>
<td class="summary">
<p>Returns the POSITIONABLE velocity Vec3 vector.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).HasCargo">POSITIONABLE:HasCargo(Cargo)</a></td>
<td class="summary">
<p>Returns if carrier has given cargo.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).InAir">POSITIONABLE:InAir()</a></td>
<td class="summary">
<p>Returns true if the POSITIONABLE is in the air.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).IsAboveRunway">POSITIONABLE:IsAboveRunway()</a></td>
<td class="summary">
<p>Returns if the Positionable is located above a runway.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).IsLasing">POSITIONABLE:IsLasing()</a></td>
<td class="summary">
<p>Check if the POSITIONABLE is lasing a target</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).LaseOff">POSITIONABLE:LaseOff()</a></td>
<td class="summary">
<p>Stop Lasing a POSITIONABLE</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).LaseUnit">POSITIONABLE:LaseUnit(Target, LaserCode, Duration)</a></td>
<td class="summary">
<p>Start Lasing a POSITIONABLE</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).LaserCode">POSITIONABLE.LaserCode</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).Message">POSITIONABLE:Message(Message, Duration, Name)</a></td>
<td class="summary">
<p>Send a message to the players in the <a href="Group.html">Group</a>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).MessageToAll">POSITIONABLE:MessageToAll(Message, Duration, Name)</a></td>
<td class="summary">
<p>Send a message to all coalitions.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).MessageToBlue">POSITIONABLE:MessageToBlue(Message, Duration, Name)</a></td>
<td class="summary">
<p>Send a message to the blue coalition.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).MessageToClient">POSITIONABLE:MessageToClient(Message, Duration, Client, Name)</a></td>
<td class="summary">
<p>Send a message to a client.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).MessageToCoalition">POSITIONABLE:MessageToCoalition(Message, Duration, MessageCoalition)</a></td>
<td class="summary">
<p>Send a message to a coalition.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).MessageToGroup">POSITIONABLE:MessageToGroup(Message, Duration, MessageGroup, Name)</a></td>
<td class="summary">
<p>Send a message to a <a href="Group.html">Group</a>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).MessageToRed">POSITIONABLE:MessageToRed(Message, Duration, Name)</a></td>
<td class="summary">
<p>Send a message to the red coalition.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).MessageToSetGroup">POSITIONABLE:MessageToSetGroup(Message, Duration, MessageSetGroup, Name)</a></td>
<td class="summary">
<p>Send a message to a <a href="Set.html##(SET_GROUP)">Set#SET_GROUP</a>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).MessageTypeToCoalition">POSITIONABLE:MessageTypeToCoalition(Message, MessageType, MessageCoalition)</a></td>
<td class="summary">
<p>Send a message to a coalition.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).MessageTypeToGroup">POSITIONABLE:MessageTypeToGroup(Message, MessageType, MessageGroup, Name)</a></td>
<td class="summary">
<p>Send a message of a message type to a <a href="Group.html">Group</a>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).New">POSITIONABLE:New(PositionableName)</a></td>
<td class="summary">
<p>Create a new POSITIONABLE from a DCSPositionable</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).RemoveCargo">POSITIONABLE:RemoveCargo(Cargo)</a></td>
<td class="summary">
<p>Remove cargo.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).Smoke">POSITIONABLE:Smoke(SmokeColor, Range, AddHeight)</a></td>
<td class="summary">
<p>Smoke the POSITIONABLE.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).SmokeBlue">POSITIONABLE:SmokeBlue()</a></td>
<td class="summary">
<p>Smoke the POSITIONABLE Blue.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).SmokeGreen">POSITIONABLE:SmokeGreen()</a></td>
<td class="summary">
<p>Smoke the POSITIONABLE Green.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).SmokeOrange">POSITIONABLE:SmokeOrange()</a></td>
<td class="summary">
<p>Smoke the POSITIONABLE Orange.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).SmokeRed">POSITIONABLE:SmokeRed()</a></td>
<td class="summary">
<p>Smoke the POSITIONABLE Red.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).SmokeWhite">POSITIONABLE:SmokeWhite()</a></td>
<td class="summary">
<p>Smoke the POSITIONABLE White.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).Spot">POSITIONABLE.Spot</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).__">POSITIONABLE.__</a></td>
<td class="summary">
</td>
</tr>
</table>
<h2><a id="#(POSITIONABLE.__)">Type <code>POSITIONABLE.__</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE.__).Cargo">POSITIONABLE.__.Cargo</a></td>
<td class="summary">
</td>
</tr>
</table>
<h2>Global(s)</h2>
<dl class="function">
<dt>
<em><a href="##(POSITIONABLE)">#POSITIONABLE</a></em>
<a id="POSITIONABLE" >
<strong>POSITIONABLE</strong>
</a>
</dt>
<dd>
<h1>POSITIONABLE class, extends <a href="Identifiable.html##(IDENTIFIABLE)">Identifiable#IDENTIFIABLE</a></h1>
<p>The POSITIONABLE class is a wrapper class to handle the POSITIONABLE objects:</p>
<ul>
<li>Support all DCS APIs.</li>
</ul>
<ul>
<li>Enhance with POSITIONABLE specific APIs not in the DCS API set.</li>
<li>Manage the "state" of the POSITIONABLE.</li>
</ul>
<h2>POSITIONABLE constructor</h2>
<p>The POSITIONABLE class provides the following functions to construct a POSITIONABLE instance:</p>
<ul>
<li><a href="##(POSITIONABLE).New">POSITIONABLE.New</a>(): Create a POSITIONABLE instance.</li>
</ul>
<h2>Get the current speed</h2>
<p>There are 3 methods that can be used to determine the speed.
Use <a href="##(POSITIONABLE).GetVelocityKMH">POSITIONABLE.GetVelocityKMH</a>() to retrieve the current speed in km/h. Use <a href="##(POSITIONABLE).GetVelocityMPS">POSITIONABLE.GetVelocityMPS</a>() to retrieve the speed in meters per second.
The method <a href="##(POSITIONABLE).GetVelocity">POSITIONABLE.GetVelocity</a>() returns the speed vector (a Vec3).</p>
<h2>Get the current altitude</h2>
<p>Altitude can be retrieved using the method <a href="##(POSITIONABLE).GetHeight">POSITIONABLE.GetHeight</a>() and returns the current altitude in meters from the orthonormal plane.</p>
</dd>
</dl>
<h2><a id="#(Positionable)" >Type <code>Positionable</code></a></h2>
<h2><a id="#(DCSPositionable)" >Type <code>DCSPositionable</code></a></h2>
<p>A DCSPositionable</p>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<a id="#(DCSPositionable).id_" >
<strong>DCSPositionable.id_</strong>
</a>
</dt>
<dd>
<p>The ID of the controllable in DCS</p>
</dd>
</dl>
<h2><a id="#(POSITIONABLE)" >Type <code>POSITIONABLE</code></a></h2>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).AddCargo" >
<strong>POSITIONABLE:AddCargo(Cargo)</strong>
</a>
</dt>
<dd>
<p>Add cargo.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Core.Cargo.html##(CARGO)">Core.Cargo#CARGO</a> Cargo </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(POSITIONABLE)">#POSITIONABLE</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).CargoItemCount" >
<strong>POSITIONABLE:CargoItemCount()</strong>
</a>
</dt>
<dd>
<p>Get cargo item count.</p>
<h3>Return value</h3>
<p><em><a href="Core.Cargo.html##(CARGO)">Core.Cargo#CARGO</a>:</em>
Cargo</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).ClearCargo" >
<strong>POSITIONABLE:ClearCargo()</strong>
</a>
</dt>
<dd>
<p>Clear all cargo.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).Flare" >
<strong>POSITIONABLE:Flare(FlareColor)</strong>
</a>
</dt>
<dd>
<p>Signal a flare at the position of the POSITIONABLE.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Utilities.Utils.html##(FLARECOLOR)">Utilities.Utils#FLARECOLOR</a> FlareColor </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).FlareGreen" >
<strong>POSITIONABLE:FlareGreen()</strong>
</a>
</dt>
<dd>
<p>Signal a green flare at the position of the POSITIONABLE.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).FlareRed" >
<strong>POSITIONABLE:FlareRed()</strong>
</a>
</dt>
<dd>
<p>Signal a red flare at the position of the POSITIONABLE.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).FlareWhite" >
<strong>POSITIONABLE:FlareWhite()</strong>
</a>
</dt>
<dd>
<p>Signal a white flare at the position of the POSITIONABLE.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).FlareYellow" >
<strong>POSITIONABLE:FlareYellow()</strong>
</a>
</dt>
<dd>
<p>Signal a yellow flare at the position of the POSITIONABLE.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).GetAltitude" >
<strong>POSITIONABLE:GetAltitude()</strong>
</a>
</dt>
<dd>
<p>Returns the altitude of the POSITIONABLE.</p>
<h3>Return values</h3>
<ol>
<li>
<p><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a>:</em>
The altitude of the POSITIONABLE.</p>
</li>
<li>
<p><em>#nil:</em>
The POSITIONABLE is not existing or alive. </p>
</li>
</ol>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).GetBeacon" >
<strong>POSITIONABLE:GetBeacon()</strong>
</a>
</dt>
<dd>
<p>Create a <a href="Radio.html##(BEACON)">Radio#BEACON</a>, to allow this POSITIONABLE to broadcast beacon signals</p>
<h3>Return value</h3>
<p><em><a href="##(RADIO)">#RADIO</a>:</em>
Radio</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).GetBoundingBox" >
<strong>POSITIONABLE:GetBoundingBox()</strong>
</a>
</dt>
<dd>
<p>Get the bounding box of the underlying POSITIONABLE DCS Object.</p>
<h3>Return values</h3>
<ol>
<li>
<p><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a>:</em>
The bounding box of the POSITIONABLE.</p>
</li>
<li>
<p><em>#nil:</em>
The POSITIONABLE is not existing or alive. </p>
</li>
</ol>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).GetCoordinate" >
<strong>POSITIONABLE:GetCoordinate()</strong>
</a>
</dt>
<dd>
<p>Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.</p>
<h3>Return value</h3>
<p><em><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>:</em>
The COORDINATE of the POSITIONABLE.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).GetHeading" >
<strong>POSITIONABLE:GetHeading()</strong>
</a>
</dt>
<dd>
<p>Returns the POSITIONABLE heading in degrees.</p>
<h3>Return values</h3>
<ol>
<li>
<p><em>#number:</em>
The POSTIONABLE heading</p>
</li>
<li>
<p><em>#nil:</em>
The POSITIONABLE is not existing or alive.</p>
</li>
</ol>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).GetHeight" >
<strong>POSITIONABLE:GetHeight()</strong>
</a>
</dt>
<dd>
<p>Returns the POSITIONABLE height in meters.</p>
<h3>Return values</h3>
<ol>
<li>
<p><em><a href="Dcs.DCSTypes.html##(Vec3)">Dcs.DCSTypes#Vec3</a>:</em>
The height of the positionable.</p>
</li>
<li>
<p><em>#nil:</em>
The POSITIONABLE is not existing or alive. </p>
</li>
</ol>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).GetLaserCode" >
<strong>POSITIONABLE:GetLaserCode()</strong>
</a>
</dt>
<dd>
<p>Get the last assigned laser code</p>
<h3>Return value</h3>
<p><em>#number:</em>
The laser code</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).GetMessage" >
<strong>POSITIONABLE:GetMessage(Message, Duration, Name)</strong>
</a>
</dt>
<dd>
<p>Returns a message with the callsign embedded (if there is one).</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string Message </em></code>:
The message text</p>
</li>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Duration)">Dcs.DCSTypes#Duration</a> Duration </em></code>:
The duration of the message.</p>
</li>
<li>
<p><code><em>#string Name </em></code>:
(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Core.Message.html##(MESSAGE)">Core.Message#MESSAGE</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).GetMessageText" >
<strong>POSITIONABLE:GetMessageText(Message, Name)</strong>
</a>
</dt>
<dd>
<p>Returns the message text with the callsign embedded (if there is one).</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string Message </em></code>:
The message text</p>
</li>
<li>
<p><code><em>#string Name </em></code>:
(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#string:</em>
The message text</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).GetMessageType" >
<strong>POSITIONABLE:GetMessageType(Message, MessageType, Name)</strong>
</a>
</dt>
<dd>
<p>Returns a message of a specified type with the callsign embedded (if there is one).</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string Message </em></code>:
The message text</p>
</li>
<li>
<p><code><em><a href="Core.Message.html##(MESSAGE)">Core.Message#MESSAGE</a> MessageType </em></code>:
MessageType The message type.</p>
</li>
<li>
<p><code><em>#string Name </em></code>:
(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Core.Message.html##(MESSAGE)">Core.Message#MESSAGE</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).GetPointVec2" >
<strong>POSITIONABLE:GetPointVec2()</strong>
</a>
</dt>
<dd>
<p>Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.</p>
<h3>Return values</h3>
<ol>
<li>
<p><em><a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>:</em>
The 2D point vector of the POSITIONABLE.</p>
</li>
<li>
<p><em>#nil:</em>
The POSITIONABLE is not existing or alive. </p>
</li>
</ol>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).GetPointVec3" >
<strong>POSITIONABLE:GetPointVec3()</strong>
</a>
</dt>
<dd>
<p>Returns a POINT_VEC3 object indicating the point in 3D of the POSITIONABLE within the mission.</p>
<h3>Return values</h3>
<ol>
<li>
<p><em><a href="Core.Point.html##(POINT_VEC3)">Core.Point#POINT_VEC3</a>:</em>
The 3D point vector of the POSITIONABLE.</p>
</li>
<li>
<p><em>#nil:</em>
The POSITIONABLE is not existing or alive. </p>
</li>
</ol>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).GetPositionVec3" >
<strong>POSITIONABLE:GetPositionVec3()</strong>
</a>
</dt>
<dd>
<p>Returns the <a href="DCSTypes.html##(Position3)">DCSTypes#Position3</a> position vectors indicating the point and direction vectors in 3D of the POSITIONABLE within the mission.</p>
<h3>Return values</h3>
<ol>
<li>
<p><em><a href="Dcs.DCSTypes.html##(Position)">Dcs.DCSTypes#Position</a>:</em>
The 3D position vectors of the POSITIONABLE.</p>
</li>
<li>
<p><em>#nil:</em>
The POSITIONABLE is not existing or alive. </p>
</li>
</ol>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).GetRadio" >
<strong>POSITIONABLE:GetRadio()</strong>
</a>
</dt>
<dd>
<p>Create a <a href="Radio.html##(RADIO)">Radio#RADIO</a>, to allow radio transmission for this POSITIONABLE.</p>
<p>Set parameters with the methods provided, then use RADIO:Broadcast() to actually broadcast the message</p>
<h3>Return value</h3>
<p><em><a href="##(RADIO)">#RADIO</a>:</em>
Radio</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).GetRandomVec3" >
<strong>POSITIONABLE:GetRandomVec3(Radius)</strong>
</a>
</dt>
<dd>
<p>Returns a random <a href="DCSTypes.html##(Vec3)">DCSTypes#Vec3</a> vector within a range, indicating the point in 3D of the POSITIONABLE within the mission.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#number Radius </em></code>: </p>
</li>
</ul>
<h3>Return values</h3>
<ol>
<li>
<p><em><a href="Dcs.DCSTypes.html##(Vec3)">Dcs.DCSTypes#Vec3</a>:</em>
The 3D point vector of the POSITIONABLE.</p>
</li>
<li>
<p><em>#nil:</em>
The POSITIONABLE is not existing or alive. </p>
</li>
</ol>
<h3>Usage:</h3>
<pre class="example"><code>
-- If Radius is ignored, returns the Dcs.DCSTypes#Vec3 of first UNIT of the GROUP</code></pre>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).GetSpot" >
<strong>POSITIONABLE:GetSpot()</strong>
</a>
</dt>
<dd>
<p>Get the Spot</p>
<h3>Return value</h3>
<p><em><a href="Core.Spot.html##(SPOT)">Core.Spot#SPOT</a>:</em>
The Spot</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).GetVec2" >
<strong>POSITIONABLE:GetVec2()</strong>
</a>
</dt>
<dd>
<p>Returns the <a href="DCSTypes.html##(Vec2)">DCSTypes#Vec2</a> vector indicating the point in 2D of the POSITIONABLE within the mission.</p>
<h3>Return values</h3>
<ol>
<li>
<p><em><a href="Dcs.DCSTypes.html##(Vec2)">Dcs.DCSTypes#Vec2</a>:</em>
The 2D point vector of the POSITIONABLE.</p>
</li>
<li>
<p><em>#nil:</em>
The POSITIONABLE is not existing or alive. </p>
</li>
</ol>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).GetVec3" >
<strong>POSITIONABLE:GetVec3()</strong>
</a>
</dt>
<dd>
<p>Returns the <a href="DCSTypes.html##(Vec3)">DCSTypes#Vec3</a> vector indicating the 3D vector of the POSITIONABLE within the mission.</p>
<h3>Return values</h3>
<ol>
<li>
<p><em><a href="Dcs.DCSTypes.html##(Vec3)">Dcs.DCSTypes#Vec3</a>:</em>
The 3D point vector of the POSITIONABLE.</p>
</li>
<li>
<p><em>#nil:</em>
The POSITIONABLE is not existing or alive. </p>
</li>
</ol>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).GetVelocity" >
<strong>POSITIONABLE:GetVelocity()</strong>
</a>
</dt>
<dd>
<p>Returns the a <a href="Velocity.html">Velocity</a> object from the positionable.</p>
<h3>Return values</h3>
<ol>
<li>
<p><em><a href="Core.Velocity.html##(VELOCITY)">Core.Velocity#VELOCITY</a>:</em>
Velocity The Velocity object.</p>
</li>
<li>
<p><em>#nil:</em>
The POSITIONABLE is not existing or alive. </p>
</li>
</ol>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).GetVelocityKMH" >
<strong>POSITIONABLE:GetVelocityKMH()</strong>
</a>
</dt>
<dd>
<p>Returns the POSITIONABLE velocity in km/h.</p>
<h3>Return value</h3>
<p><em>#number:</em>
The velocity in km/h</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).GetVelocityMPS" >
<strong>POSITIONABLE:GetVelocityMPS()</strong>
</a>
</dt>
<dd>
<p>Returns the POSITIONABLE velocity in meters per second.</p>
<h3>Return value</h3>
<p><em>#number:</em>
The velocity in meters per second.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).GetVelocityVec3" >
<strong>POSITIONABLE:GetVelocityVec3()</strong>
</a>
</dt>
<dd>
<p>Returns the POSITIONABLE velocity Vec3 vector.</p>
<h3>Return values</h3>
<ol>
<li>
<p><em><a href="Dcs.DCSTypes.html##(Vec3)">Dcs.DCSTypes#Vec3</a>:</em>
The velocity Vec3 vector</p>
</li>
<li>
<p><em>#nil:</em>
The POSITIONABLE is not existing or alive. </p>
</li>
</ol>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).HasCargo" >
<strong>POSITIONABLE:HasCargo(Cargo)</strong>
</a>
</dt>
<dd>
<p>Returns if carrier has given cargo.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> Cargo </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Core.Cargo.html##(CARGO)">Core.Cargo#CARGO</a>:</em>
Cargo</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).InAir" >
<strong>POSITIONABLE:InAir()</strong>
</a>
</dt>
<dd>
<p>Returns true if the POSITIONABLE is in the air.</p>
<p>Polymorphic, is overridden in GROUP and UNIT.</p>
<h3>Return values</h3>
<ol>
<li>
<p><em>#boolean:</em>
true if in the air.</p>
</li>
<li>
<p><em>#nil:</em>
The POSITIONABLE is not existing or alive. </p>
</li>
</ol>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).IsAboveRunway" >
<strong>POSITIONABLE:IsAboveRunway()</strong>
</a>
</dt>
<dd>
<p>Returns if the Positionable is located above a runway.</p>
<h3>Return values</h3>
<ol>
<li>
<p><em>#boolean:</em>
true if Positionable is above a runway.</p>
</li>
<li>
<p><em>#nil:</em>
The POSITIONABLE is not existing or alive. </p>
</li>
</ol>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).IsLasing" >
<strong>POSITIONABLE:IsLasing()</strong>
</a>
</dt>
<dd>
<p>Check if the POSITIONABLE is lasing a target</p>
<h3>Return value</h3>
<p><em>#boolean:</em>
true if it is lasing a target</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).LaseOff" >
<strong>POSITIONABLE:LaseOff()</strong>
</a>
</dt>
<dd>
<p>Stop Lasing a POSITIONABLE</p>
<h3>Return value</h3>
<p><em><a href="##(POSITIONABLE)">#POSITIONABLE</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).LaseUnit" >
<strong>POSITIONABLE:LaseUnit(Target, LaserCode, Duration)</strong>
</a>
</dt>
<dd>
<p>Start Lasing a POSITIONABLE</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="##(POSITIONABLE)">#POSITIONABLE</a> Target </em></code>: </p>
</li>
<li>
<p><code><em>#number LaserCode </em></code>: </p>
</li>
<li>
<p><code><em>#number Duration </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Core.Spot.html##(SPOT)">Core.Spot#SPOT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(POSITIONABLE).LaserCode" >
<strong>POSITIONABLE.LaserCode</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).Message" >
<strong>POSITIONABLE:Message(Message, Duration, Name)</strong>
</a>
</dt>
<dd>
<p>Send a message to the players in the <a href="Group.html">Group</a>.</p>
<p>The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string Message </em></code>:
The message text</p>
</li>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Duration)">Dcs.DCSTypes#Duration</a> Duration </em></code>:
The duration of the message.</p>
</li>
<li>
<p><code><em>#string Name </em></code>:
(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).MessageToAll" >
<strong>POSITIONABLE:MessageToAll(Message, Duration, Name)</strong>
</a>
</dt>
<dd>
<p>Send a message to all coalitions.</p>
<p>The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string Message </em></code>:
The message text</p>
</li>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Duration)">Dcs.DCSTypes#Duration</a> Duration </em></code>:
The duration of the message.</p>
</li>
<li>
<p><code><em>#string Name </em></code>:
(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).MessageToBlue" >
<strong>POSITIONABLE:MessageToBlue(Message, Duration, Name)</strong>
</a>
</dt>
<dd>
<p>Send a message to the blue coalition.</p>
<p>The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string Message </em></code>:
The message text</p>
</li>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Duration)">Dcs.DCSTypes#Duration</a> Duration </em></code>:
The duration of the message.</p>
</li>
<li>
<p><code><em>#string Name </em></code>:
(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).MessageToClient" >
<strong>POSITIONABLE:MessageToClient(Message, Duration, Client, Name)</strong>
</a>
</dt>
<dd>
<p>Send a message to a client.</p>
<p>The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string Message </em></code>:
The message text</p>
</li>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Duration)">Dcs.DCSTypes#Duration</a> Duration </em></code>:
The duration of the message.</p>
</li>
<li>
<p><code><em><a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a> Client </em></code>:
The client object receiving the message.</p>
</li>
<li>
<p><code><em>#string Name </em></code>:
(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).MessageToCoalition" >
<strong>POSITIONABLE:MessageToCoalition(Message, Duration, MessageCoalition)</strong>
</a>
</dt>
<dd>
<p>Send a message to a coalition.</p>
<p>The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string Message </em></code>:
The message text</p>
</li>
<li>
<p><code><em><a href="Dcs.DCSTYpes.html##(Duration)">Dcs.DCSTYpes#Duration</a> Duration </em></code>:
The duration of the message.</p>
</li>
<li>
<p><code><em><a href="Dcs.DCScoalition.html##(coalition)">Dcs.DCScoalition#coalition</a> MessageCoalition </em></code>:
The Coalition receiving the message.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).MessageToGroup" >
<strong>POSITIONABLE:MessageToGroup(Message, Duration, MessageGroup, Name)</strong>
</a>
</dt>
<dd>
<p>Send a message to a <a href="Group.html">Group</a>.</p>
<p>The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string Message </em></code>:
The message text</p>
</li>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Duration)">Dcs.DCSTypes#Duration</a> Duration </em></code>:
The duration of the message.</p>
</li>
<li>
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> MessageGroup </em></code>:
The GROUP object receiving the message.</p>
</li>
<li>
<p><code><em>#string Name </em></code>:
(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).MessageToRed" >
<strong>POSITIONABLE:MessageToRed(Message, Duration, Name)</strong>
</a>
</dt>
<dd>
<p>Send a message to the red coalition.</p>
<p>The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string Message </em></code>:
The message text</p>
</li>
<li>
<p><code><em><a href="Dcs.DCSTYpes.html##(Duration)">Dcs.DCSTYpes#Duration</a> Duration </em></code>:
The duration of the message.</p>
</li>
<li>
<p><code><em>#string Name </em></code>:
(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).MessageToSetGroup" >
<strong>POSITIONABLE:MessageToSetGroup(Message, Duration, MessageSetGroup, Name)</strong>
</a>
</dt>
<dd>
<p>Send a message to a <a href="Set.html##(SET_GROUP)">Set#SET_GROUP</a>.</p>
<p>The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string Message </em></code>:
The message text</p>
</li>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Duration)">Dcs.DCSTypes#Duration</a> Duration </em></code>:
The duration of the message.</p>
</li>
<li>
<p><code><em><a href="Core.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a> MessageSetGroup </em></code>:
The SET_GROUP collection receiving the message.</p>
</li>
<li>
<p><code><em>#string Name </em></code>:
(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).MessageTypeToCoalition" >
<strong>POSITIONABLE:MessageTypeToCoalition(Message, MessageType, MessageCoalition)</strong>
</a>
</dt>
<dd>
<p>Send a message to a coalition.</p>
<p>The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string Message </em></code>:
The message text</p>
</li>
<li>
<p><code><em><a href="Core.Message.html##(MESSAGE.Type)">Core.Message#MESSAGE.Type</a> MessageType </em></code>:
The message type that determines the duration.</p>
</li>
<li>
<p><code><em><a href="Dcs.DCScoalition.html##(coalition)">Dcs.DCScoalition#coalition</a> MessageCoalition </em></code>:
The Coalition receiving the message.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).MessageTypeToGroup" >
<strong>POSITIONABLE:MessageTypeToGroup(Message, MessageType, MessageGroup, Name)</strong>
</a>
</dt>
<dd>
<p>Send a message of a message type to a <a href="Group.html">Group</a>.</p>
<p>The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string Message </em></code>:
The message text</p>
</li>
<li>
<p><code><em><a href="Core.Message.html##(MESSAGE.Type)">Core.Message#MESSAGE.Type</a> MessageType </em></code>:
The message type that determines the duration.</p>
</li>
<li>
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> MessageGroup </em></code>:
The GROUP object receiving the message.</p>
</li>
<li>
<p><code><em>#string Name </em></code>:
(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).New" >
<strong>POSITIONABLE:New(PositionableName)</strong>
</a>
</dt>
<dd>
<p>Create a new POSITIONABLE from a DCSPositionable</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Dcs.DCSWrapper.Positionable.html##(Positionable)">Dcs.DCSWrapper.Positionable#Positionable</a> PositionableName </em></code>:
The POSITIONABLE name</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(POSITIONABLE)">#POSITIONABLE</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).RemoveCargo" >
<strong>POSITIONABLE:RemoveCargo(Cargo)</strong>
</a>
</dt>
<dd>
<p>Remove cargo.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Core.Cargo.html##(CARGO)">Core.Cargo#CARGO</a> Cargo </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(POSITIONABLE)">#POSITIONABLE</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).Smoke" >
<strong>POSITIONABLE:Smoke(SmokeColor, Range, AddHeight)</strong>
</a>
</dt>
<dd>
<p>Smoke the POSITIONABLE.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Utilities.Utils.html##(SMOKECOLOR)">Utilities.Utils#SMOKECOLOR</a> SmokeColor </em></code>:
The color to smoke to positionable.</p>
</li>
<li>
<p><code><em>#number Range </em></code>:
The range in meters to randomize the smoking around the positionable.</p>
</li>
<li>
<p><code><em>#number AddHeight </em></code>:
The height in meters to add to the altitude of the positionable.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).SmokeBlue" >
<strong>POSITIONABLE:SmokeBlue()</strong>
</a>
</dt>
<dd>
<p>Smoke the POSITIONABLE Blue.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).SmokeGreen" >
<strong>POSITIONABLE:SmokeGreen()</strong>
</a>
</dt>
<dd>
<p>Smoke the POSITIONABLE Green.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).SmokeOrange" >
<strong>POSITIONABLE:SmokeOrange()</strong>
</a>
</dt>
<dd>
<p>Smoke the POSITIONABLE Orange.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).SmokeRed" >
<strong>POSITIONABLE:SmokeRed()</strong>
</a>
</dt>
<dd>
<p>Smoke the POSITIONABLE Red.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).SmokeWhite" >
<strong>POSITIONABLE:SmokeWhite()</strong>
</a>
</dt>
<dd>
<p>Smoke the POSITIONABLE White.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Core.Spot.html##(SPOT)">Core.Spot#SPOT</a></em>
<a id="#(POSITIONABLE).Spot" >
<strong>POSITIONABLE.Spot</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="##(POSITIONABLE.__)">#POSITIONABLE.__</a></em>
<a id="#(POSITIONABLE).__" >
<strong>POSITIONABLE.__</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<h2><a id="#(POSITIONABLE.__)" >Type <code>POSITIONABLE.__</code></a></h2>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<em><a href="##(POSITIONABLE.__.Cargo)">#POSITIONABLE.__.Cargo</a></em>
<a id="#(POSITIONABLE.__).Cargo" >
<strong>POSITIONABLE.__.Cargo</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<h2><a id="#(POSITIONABLE.__.Cargo)" >Type <code>POSITIONABLE.__.Cargo</code></a></h2>
<h2><a id="#(RADIO)" >Type <code>RADIO</code></a></h2>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink