mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-08-15 10:47:21 +00:00
688 lines
17 KiB
HTML
688 lines
17 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_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>Base</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><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="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>Base</code></h1>
|
|
|
|
<p><strong>Core</strong> -- VELOCITY models a speed, which can be expressed in various formats according the Settings.</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="#VELOCITY">VELOCITY</a></td>
|
|
<td class="summary">
|
|
<h1>VELOCITY class, extends <a href="Base.html##(BASE)">Base#BASE</a></h1>
|
|
|
|
<p>VELOCITY models a speed, which can be expressed in various formats according the Settings.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="#VELOCITY_POSITIONABLE">VELOCITY_POSITIONABLE</a></td>
|
|
<td class="summary">
|
|
<h1>VELOCITY_POSITIONABLE class, extends <a href="Base.html##(BASE)">Base#BASE</a></h1>
|
|
|
|
<p>VELOCITY_POSITIONABLE monitors the speed of an <a href="Positionable.html">Positionable</a> in the simulation, which can be expressed in various formats according the Settings.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<h2><a id="#(VELOCITY)">Type <code>VELOCITY</code></a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(VELOCITY).Get">VELOCITY:Get()</a></td>
|
|
<td class="summary">
|
|
<p>Get the velocity in Mps (meters per second).</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(VELOCITY).GetKmph">VELOCITY:GetKmph()</a></td>
|
|
<td class="summary">
|
|
<p>Get the velocity in Kmph (kilometers per hour).</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(VELOCITY).GetMiph">VELOCITY:GetMiph()</a></td>
|
|
<td class="summary">
|
|
<p>Get the velocity in Miph (miles per hour).</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(VELOCITY).GetText">VELOCITY:GetText(Settings)</a></td>
|
|
<td class="summary">
|
|
<p>Get the velocity in text, according the player <a href="Settings.html">Settings</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(VELOCITY).New">VELOCITY:New(VelocityMps)</a></td>
|
|
<td class="summary">
|
|
<p>VELOCITY Constructor.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(VELOCITY).Set">VELOCITY:Set(VelocityMps)</a></td>
|
|
<td class="summary">
|
|
<p>Set the velocity in Mps (meters per second).</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(VELOCITY).SetKmph">VELOCITY:SetKmph(VelocityKmph)</a></td>
|
|
<td class="summary">
|
|
<p>Set the velocity in Kmph (kilometers per hour).</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(VELOCITY).SetMiph">VELOCITY:SetMiph(VelocityMiph)</a></td>
|
|
<td class="summary">
|
|
<p>Set the velocity in Miph (miles per hour).</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(VELOCITY).ToString">VELOCITY:ToString(Controllable, Settings, VelocityGroup)</a></td>
|
|
<td class="summary">
|
|
<p>Get the velocity in text, according the player or default <a href="Settings.html">Settings</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(VELOCITY).Velocity">VELOCITY.Velocity</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2><a id="#(VELOCITY_POSITIONABLE)">Type <code>VELOCITY_POSITIONABLE</code></a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(VELOCITY_POSITIONABLE).Get">VELOCITY_POSITIONABLE:Get()</a></td>
|
|
<td class="summary">
|
|
<p>Get the velocity in Mps (meters per second).</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(VELOCITY_POSITIONABLE).GetKmph">VELOCITY_POSITIONABLE:GetKmph()</a></td>
|
|
<td class="summary">
|
|
<p>Get the velocity in Kmph (kilometers per hour).</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(VELOCITY_POSITIONABLE).GetMiph">VELOCITY_POSITIONABLE:GetMiph()</a></td>
|
|
<td class="summary">
|
|
<p>Get the velocity in Miph (miles per hour).</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(VELOCITY_POSITIONABLE).New">VELOCITY_POSITIONABLE:New(Positionable)</a></td>
|
|
<td class="summary">
|
|
<p>VELOCITY_POSITIONABLE Constructor.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(VELOCITY_POSITIONABLE).Positionable">VELOCITY_POSITIONABLE.Positionable</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(VELOCITY_POSITIONABLE).ToString">VELOCITY_POSITIONABLE:ToString()</a></td>
|
|
<td class="summary">
|
|
<p>Get the velocity in text, according the player or default <a href="Settings.html">Settings</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(VELOCITY_POSITIONABLE).Velocity">VELOCITY_POSITIONABLE.Velocity</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2>Global(s)</h2>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(VELOCITY)">#VELOCITY</a></em>
|
|
<a id="VELOCITY" >
|
|
<strong>VELOCITY</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<h1>VELOCITY class, extends <a href="Base.html##(BASE)">Base#BASE</a></h1>
|
|
|
|
<p>VELOCITY models a speed, which can be expressed in various formats according the Settings.</p>
|
|
|
|
|
|
|
|
<h2>1. VELOCITY constructor</h2>
|
|
|
|
<ul>
|
|
<li><a href="##(VELOCITY).New">VELOCITY.New</a>(): Creates a new VELOCITY object.</li>
|
|
</ul>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(VELOCITY_POSITIONABLE)">#VELOCITY_POSITIONABLE</a></em>
|
|
<a id="VELOCITY_POSITIONABLE" >
|
|
<strong>VELOCITY_POSITIONABLE</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<h1>VELOCITY_POSITIONABLE class, extends <a href="Base.html##(BASE)">Base#BASE</a></h1>
|
|
|
|
<p>VELOCITY_POSITIONABLE monitors the speed of an <a href="Positionable.html">Positionable</a> in the simulation, which can be expressed in various formats according the Settings.</p>
|
|
|
|
|
|
|
|
<h2>1. VELOCITY_POSITIONABLE constructor</h2>
|
|
|
|
<ul>
|
|
<li><a href="##(VELOCITY_POSITIONABLE).New">VELOCITY_POSITIONABLE.New</a>(): Creates a new VELOCITY_POSITIONABLE object.</li>
|
|
</ul>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<h2><a id="#(Base)" >Type <code>Base</code></a></h2>
|
|
|
|
<h2><a id="#(VELOCITY)" >Type <code>VELOCITY</code></a></h2>
|
|
<h3>Field(s)</h3>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(VELOCITY).Get" >
|
|
<strong>VELOCITY:Get()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Get the velocity in Mps (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="#(VELOCITY).GetKmph" >
|
|
<strong>VELOCITY:GetKmph()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Get the velocity in Kmph (kilometers per hour).</p>
|
|
|
|
<h3>Return value</h3>
|
|
|
|
<p><em>#number:</em>
|
|
The velocity in kilometers per hour. </p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(VELOCITY).GetMiph" >
|
|
<strong>VELOCITY:GetMiph()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Get the velocity in Miph (miles per hour).</p>
|
|
|
|
<h3>Return value</h3>
|
|
|
|
<p><em>#number:</em>
|
|
The velocity in miles per hour. </p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(VELOCITY).GetText" >
|
|
<strong>VELOCITY:GetText(Settings)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Get the velocity in text, according the player <a href="Settings.html">Settings</a>.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Core.Settings.html##(SETTINGS)">Core.Settings#SETTINGS</a> Settings </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em>#string:</em>
|
|
The velocity in text. </p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(VELOCITY).New" >
|
|
<strong>VELOCITY:New(VelocityMps)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>VELOCITY Constructor.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number VelocityMps </em></code>:
|
|
The velocity in meters per second. </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(VELOCITY)">#VELOCITY</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(VELOCITY).Set" >
|
|
<strong>VELOCITY:Set(VelocityMps)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Set the velocity in Mps (meters per second).</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number VelocityMps </em></code>:
|
|
The velocity in meters per second. </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(VELOCITY)">#VELOCITY</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(VELOCITY).SetKmph" >
|
|
<strong>VELOCITY:SetKmph(VelocityKmph)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Set the velocity in Kmph (kilometers per hour).</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number VelocityKmph </em></code>:
|
|
The velocity in kilometers per hour. </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(VELOCITY)">#VELOCITY</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(VELOCITY).SetMiph" >
|
|
<strong>VELOCITY:SetMiph(VelocityMiph)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Set the velocity in Miph (miles per hour).</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em>#number VelocityMiph </em></code>:
|
|
The velocity in miles per hour. </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(VELOCITY)">#VELOCITY</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(VELOCITY).ToString" >
|
|
<strong>VELOCITY:ToString(Controllable, Settings, VelocityGroup)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Get the velocity in text, according the player or default <a href="Settings.html">Settings</a>.</p>
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> Controllable </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em><a href="Core.Settings.html##(SETTINGS)">Core.Settings#SETTINGS</a> Settings </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> VelocityGroup </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em>#string:</em>
|
|
The velocity in text according the player or default <a href="Settings.html">Settings</a></p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(VELOCITY).Velocity" >
|
|
<strong>VELOCITY.Velocity</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h2><a id="#(VELOCITY_POSITIONABLE)" >Type <code>VELOCITY_POSITIONABLE</code></a></h2>
|
|
<h3>Field(s)</h3>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(VELOCITY_POSITIONABLE).Get" >
|
|
<strong>VELOCITY_POSITIONABLE:Get()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Get the velocity in Mps (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="#(VELOCITY_POSITIONABLE).GetKmph" >
|
|
<strong>VELOCITY_POSITIONABLE:GetKmph()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Get the velocity in Kmph (kilometers per hour).</p>
|
|
|
|
<h3>Return value</h3>
|
|
|
|
<p><em>#number:</em>
|
|
The velocity in kilometers per hour. </p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(VELOCITY_POSITIONABLE).GetMiph" >
|
|
<strong>VELOCITY_POSITIONABLE:GetMiph()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Get the velocity in Miph (miles per hour).</p>
|
|
|
|
<h3>Return value</h3>
|
|
|
|
<p><em>#number:</em>
|
|
The velocity in miles per hour. </p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(VELOCITY_POSITIONABLE).New" >
|
|
<strong>VELOCITY_POSITIONABLE:New(Positionable)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>VELOCITY_POSITIONABLE Constructor.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a> Positionable </em></code>:
|
|
The Positionable to monitor the speed. </p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(VELOCITY_POSITIONABLE)">#VELOCITY_POSITIONABLE</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(VELOCITY_POSITIONABLE).Positionable" >
|
|
<strong>VELOCITY_POSITIONABLE.Positionable</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(VELOCITY_POSITIONABLE).ToString" >
|
|
<strong>VELOCITY_POSITIONABLE:ToString()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Get the velocity in text, according the player or default <a href="Settings.html">Settings</a>.</p>
|
|
|
|
<h3>Return value</h3>
|
|
|
|
<p><em>#string:</em>
|
|
The velocity in text according the player or default <a href="Settings.html">Settings</a></p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(VELOCITY_POSITIONABLE).Velocity" >
|
|
<strong>VELOCITY_POSITIONABLE.Velocity</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|