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/Spot.html
Grey-Echo fb6bb635c6 Documentation Update
2017-04-22 11:35:14 +02:00

758 lines
15 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_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_Designate.html">AI_Designate</a></li>
<li><a href="AI_Patrol.html">AI_Patrol</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><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="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="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="Radio.html">Radio</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="Smoke.html">Smoke</a></li>
<li><a href="Spawn.html">Spawn</a></li>
<li><a href="SpawnStatic.html">SpawnStatic</a></li>
<li>Spot</li>
<li><a href="Static.html">Static</a></li>
<li><a href="StaticObject.html">StaticObject</a></li>
<li><a href="Task.html">Task</a></li>
<li><a href="Task_A2G.html">Task_A2G</a></li>
<li><a href="Task_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="Utils.html">Utils</a></li>
<li><a href="Zone.html">Zone</a></li>
<li><a href="env.html">env</a></li>
<li><a href="land.html">land</a></li>
<li><a href="routines.html">routines</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>Spot</code></h1>
<p><strong>Core (Release 2.1)</strong> -- Management of SPOT logistics, that can be transported from and to transportation carriers.</p>
<p><img src="..\Presentations\SPOT\Dia1.JPG" alt="Banner Image"/></p>
<hr/>
<p>Spot lases points endlessly or for a duration.</p>
<hr/>
<h1>Demo Missions</h1>
<h3><a href="">SPOT Demo Missions source code</a></h3>
<h3><a href="">SPOT Demo Missions, only for beta testers</a></h3>
<h3><a href="https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases">ALL Demo Missions pack of the last release</a></h3>
<hr/>
<h1>YouTube Channel</h1>
<h3><a href="">SPOT YouTube Channel</a></h3>
<hr/>
<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="#SPOT">SPOT</a></td>
<td class="summary">
</td>
</tr>
</table>
<h2><a id="#(SPOT)">Type <code>SPOT</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).IsLasing">SPOT:IsLasing()</a></td>
<td class="summary">
<p>Check if the SPOT is lasing</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).LaseOff">SPOT:LaseOff()</a></td>
<td class="summary">
<p>LaseOff Trigger for SPOT</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).LaseOn">SPOT:LaseOn()</a></td>
<td class="summary">
<p>LaseOn Trigger for SPOT</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).LaseScheduler">SPOT.LaseScheduler</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).LaserCode">SPOT.LaserCode</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).New">SPOT:New(Recce, LaserCode, Duration)</a></td>
<td class="summary">
<p>SPOT Constructor.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).OnAfterLaseOff">SPOT:OnAfterLaseOff(From, Event, To)</a></td>
<td class="summary">
<p>LaseOff Handler OnAfter for SPOT</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).OnAfterLaseOn">SPOT:OnAfterLaseOn(From, Event, To)</a></td>
<td class="summary">
<p>LaseOn Handler OnAfter for SPOT</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).OnBeforeLaseOff">SPOT:OnBeforeLaseOff(From, Event, To)</a></td>
<td class="summary">
<p>LaseOff Handler OnBefore for SPOT</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).OnBeforeLaseOn">SPOT:OnBeforeLaseOn(From, Event, To)</a></td>
<td class="summary">
<p>LaseOn Handler OnBefore for SPOT</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).OnEventDead">SPOT:OnEventDead(EventData)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).Recce">SPOT.Recce</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).ScheduleID">SPOT.ScheduleID</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).Spot">SPOT.Spot</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).Target">SPOT.Target</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).__LaseOff">SPOT:__LaseOff(Delay)</a></td>
<td class="summary">
<p>LaseOff Asynchronous Trigger for SPOT</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).__LaseOn">SPOT:__LaseOn(Delay)</a></td>
<td class="summary">
<p>LaseOn Asynchronous Trigger for SPOT</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).onafterLaseOff">SPOT:onafterLaseOff(From, Event, To)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).onafterLaseOn">SPOT:onafterLaseOn(From, Event, To, Target, LaserCode, Duration)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).onafterLasing">SPOT:onafterLasing(From, Event, To)</a></td>
<td class="summary">
</td>
</tr>
</table>
<h2>Global(s)</h2>
<dl class="function">
<dt>
<em><a href="##(SPOT)">#SPOT</a></em>
<a id="SPOT" >
<strong>SPOT</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<h2><a id="#(Spot)" >Type <code>Spot</code></a></h2>
<h2><a id="#(SPOT)" >Type <code>SPOT</code></a></h2>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<a id="#(SPOT).IsLasing" >
<strong>SPOT:IsLasing()</strong>
</a>
</dt>
<dd>
<p>Check if the SPOT is lasing</p>
<h3>Return value</h3>
<p><em>#boolean:</em>
true if it is lasing</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SPOT).LaseOff" >
<strong>SPOT:LaseOff()</strong>
</a>
</dt>
<dd>
<p>LaseOff Trigger for SPOT</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SPOT).LaseOn" >
<strong>SPOT:LaseOn()</strong>
</a>
</dt>
<dd>
<p>LaseOn Trigger for SPOT</p>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(SPOT).LaseScheduler" >
<strong>SPOT.LaseScheduler</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(SPOT).LaserCode" >
<strong>SPOT.LaserCode</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SPOT).New" >
<strong>SPOT:New(Recce, LaserCode, Duration)</strong>
</a>
</dt>
<dd>
<p>SPOT Constructor.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> Recce </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="##(SPOT)">#SPOT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SPOT).OnAfterLaseOff" >
<strong>SPOT:OnAfterLaseOff(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>LaseOff Handler OnAfter for SPOT</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>: </p>
</li>
<li>
<p><code><em>#string Event </em></code>: </p>
</li>
<li>
<p><code><em>#string To </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SPOT).OnAfterLaseOn" >
<strong>SPOT:OnAfterLaseOn(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>LaseOn Handler OnAfter for SPOT</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>: </p>
</li>
<li>
<p><code><em>#string Event </em></code>: </p>
</li>
<li>
<p><code><em>#string To </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SPOT).OnBeforeLaseOff" >
<strong>SPOT:OnBeforeLaseOff(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>LaseOff Handler OnBefore for SPOT</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>: </p>
</li>
<li>
<p><code><em>#string Event </em></code>: </p>
</li>
<li>
<p><code><em>#string To </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#boolean:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SPOT).OnBeforeLaseOn" >
<strong>SPOT:OnBeforeLaseOn(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>LaseOn Handler OnBefore for SPOT</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>: </p>
</li>
<li>
<p><code><em>#string Event </em></code>: </p>
</li>
<li>
<p><code><em>#string To </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#boolean:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SPOT).OnEventDead" >
<strong>SPOT:OnEventDead(EventData)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a> EventData </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(SPOT).Recce" >
<strong>SPOT.Recce</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SPOT).ScheduleID" >
<strong>SPOT.ScheduleID</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SPOT).Spot" >
<strong>SPOT.Spot</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SPOT).Target" >
<strong>SPOT.Target</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SPOT).__LaseOff" >
<strong>SPOT:__LaseOff(Delay)</strong>
</a>
</dt>
<dd>
<p>LaseOff Asynchronous Trigger for SPOT</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#number Delay </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SPOT).__LaseOn" >
<strong>SPOT:__LaseOn(Delay)</strong>
</a>
</dt>
<dd>
<p>LaseOn Asynchronous Trigger for SPOT</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#number Delay </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SPOT).onafterLaseOff" >
<strong>SPOT:onafterLaseOff(From, Event, To)</strong>
</a>
</dt>
<dd>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em> From </em></code>: </p>
</li>
<li>
<p><code><em> Event </em></code>: </p>
</li>
<li>
<p><code><em> To </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(SPOT)">#SPOT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SPOT).onafterLaseOn" >
<strong>SPOT:onafterLaseOn(From, Event, To, Target, LaserCode, Duration)</strong>
</a>
</dt>
<dd>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em> From </em></code>: </p>
</li>
<li>
<p><code><em> Event </em></code>: </p>
</li>
<li>
<p><code><em> To </em></code>: </p>
</li>
<li>
<p><code><em><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.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>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SPOT).onafterLasing" >
<strong>SPOT:onafterLasing(From, Event, To)</strong>
</a>
</dt>
<dd>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em> From </em></code>: </p>
</li>
<li>
<p><code><em> Event </em></code>: </p>
</li>
<li>
<p><code><em> To </em></code>: </p>
</li>
</ul>
</dd>
</dl>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink