mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-08-15 10:47:21 +00:00
557 lines
16 KiB
HTML
557 lines
16 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
|
<head>
|
|
<title>MOOSE</title>
|
|
<link rel="stylesheet" href="../ldoc.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> <!-- id="product" -->
|
|
|
|
|
|
<div id="main">
|
|
|
|
|
|
<!-- Menu -->
|
|
|
|
<div id="navigation">
|
|
<br/>
|
|
<h1>MOOSE</h1>
|
|
|
|
<ul>
|
|
<li><a href="../index.html">Index</a></li>
|
|
</ul>
|
|
|
|
<h2>Contents</h2>
|
|
<ul>
|
|
<li><a href="#Tables">Tables</a></li>
|
|
<li><a href="#Methods">Methods</a></li>
|
|
</ul>
|
|
|
|
|
|
<h2>Classes</h2>
|
|
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
|
<li><a href="../classes/BASE.html">BASE</a></li>
|
|
<li><a href="../classes/CARGO.html">CARGO</a></li>
|
|
<li><a href="../classes/CLEANUP.html">CLEANUP</a></li>
|
|
<li><strong>CLIENT</strong></li>
|
|
<li><a href="../classes/DATABASE.html">DATABASE</a></li>
|
|
<li><a href="../classes/DEPLOYTASK.html">DEPLOYTASK</a></li>
|
|
<li><a href="../classes/DESTROYBASETASK.html">DESTROYBASETASK</a></li>
|
|
<li><a href="../classes/DESTROYGROUPSTASK.html">DESTROYGROUPSTASK</a></li>
|
|
<li><a href="../classes/DESTROYRADARSTASK.html">DESTROYRADARSTASK</a></li>
|
|
<li><a href="../classes/DESTROYUNITTYPESTASK.html">DESTROYUNITTYPESTASK</a></li>
|
|
<li><a href="../classes/GOHOMETASK.html">GOHOMETASK</a></li>
|
|
<li><a href="../classes/MENU.html">MENU</a></li>
|
|
<li><a href="../classes/MESSAGE.html">MESSAGE</a></li>
|
|
<li><a href="../classes/MISSION.html">MISSION</a></li>
|
|
<li><a href="../classes/MOVEMENT.html">MOVEMENT</a></li>
|
|
<li><a href="../classes/NOTASK.html">NOTASK</a></li>
|
|
<li><a href="../classes/PICKUPTASK.html">PICKUPTASK</a></li>
|
|
<li><a href="../classes/ROUTETASK.html">ROUTETASK</a></li>
|
|
<li><a href="../classes/SEAD.html">SEAD</a></li>
|
|
<li><a href="../classes/SLINGLOADHOOKTASK.html">SLINGLOADHOOKTASK</a></li>
|
|
<li><a href="../classes/SLINGLOADUNHOOKTASK.html">SLINGLOADUNHOOKTASK</a></li>
|
|
<li><a href="../classes/SPAWN.html">SPAWN</a></li>
|
|
<li><a href="../classes/STAGE.html">STAGE</a></li>
|
|
<li><a href="../classes/TASK.html">TASK</a></li>
|
|
</ul>
|
|
<h2>Modules</h2>
|
|
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
|
<li><a href="../modules/routines.html">routines</a></li>
|
|
<li><a href="../modules/trace.html">trace</a></li>
|
|
</ul>
|
|
<h2>Scripts</h2>
|
|
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
|
<li><a href="../scripts/eStatHandler.html">eStatHandler</a></li>
|
|
</ul>
|
|
<h2>Topics</h2>
|
|
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
|
<li><a href="../topics/manual.md.html">manual</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
<div id="content">
|
|
|
|
<h1>Class <code>CLIENT</code></h1>
|
|
<p>CLIENT Classes</p>
|
|
<p>
|
|
|
|
</p>
|
|
|
|
|
|
<h2><a href="#Tables">Tables</a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap><a href="#CLIENT.CLIENT">CLIENT.CLIENT</a></td>
|
|
<td class="summary">Clients are those Groups defined within the Mission Editor that have the skillset defined as "Client" or "Player".</td>
|
|
</tr>
|
|
</table>
|
|
<h2><a href="#Methods">Methods</a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap><a href="#CLIENT:New">CLIENT:New (ClientName, ClientBriefing)</a></td>
|
|
<td class="summary">Use this method to register new Clients within the MOF.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#CLIENT:Reset">CLIENT:Reset (ClientName)</a></td>
|
|
<td class="summary">Resets a CLIENT.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#CLIENT:ClientGroup">CLIENT:ClientGroup ()</a></td>
|
|
<td class="summary">ClientGroup returns the Group of a Client.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#CLIENT:Transport">CLIENT:Transport ()</a></td>
|
|
<td class="summary">Transport defines that the Client is a Transport.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#CLIENT:AddBriefing">CLIENT:AddBriefing (ClientBriefing)</a></td>
|
|
<td class="summary">AddBriefing adds a briefing to a Client when a Player joins a Mission.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#CLIENT:IsTransport">CLIENT:IsTransport ()</a></td>
|
|
<td class="summary">IsTransport returns if a Client is a transport.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#CLIENT:FindCargo">CLIENT:FindCargo (CargoName)</a></td>
|
|
<td class="summary">FindCargo finds loaded Cargo within a CLIENT instance.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#CLIENT:ShowCargo">CLIENT:ShowCargo ()</a></td>
|
|
<td class="summary">ShowCargo shows the <a href="../classes/CARGO.html#">CARGO</a> within the CLIENT to the Player.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#CLIENT:AddCargo">CLIENT:AddCargo (CargoName, CargoGroupName, CargoType, CargoWeight, CargoGroupTemplate)</a></td>
|
|
<td class="summary">AddCargo allows to add <a href="../classes/CARGO.html#">CARGO</a> on the CLIENT.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#CLIENT:RemoveCargo">CLIENT:RemoveCargo (CargoName)</a></td>
|
|
<td class="summary">RemoveCargo removes <a href="../classes/CARGO.html#">CARGO</a> from the CLIENT.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#CLIENT:SwitchMessages">CLIENT:SwitchMessages (PrmTable)</a></td>
|
|
<td class="summary">SwitchMessages is a local function called by the DCS World Menu system to switch off messages.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#CLIENT:Message">CLIENT:Message (Message, MessageDuration, MessageId, MessageCategory, MessageInterval)</a></td>
|
|
<td class="summary">Message is the key Message driver for the CLIENT class.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br/>
|
|
<br/>
|
|
|
|
|
|
<h2><a name="Tables"></a>Tables</h2>
|
|
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "CLIENT.CLIENT"></a>
|
|
<strong>CLIENT.CLIENT</strong>
|
|
</dt>
|
|
<dd>
|
|
Clients are those Groups defined within the Mission Editor that have the skillset defined as "Client" or "Player".
|
|
These clients are defined within the Mission Orchestration Framework (MOF)
|
|
|
|
|
|
<h3>Fields:</h3>
|
|
<ul>
|
|
<li><span class="parameter">ONBOARDSIDE</span>
|
|
|
|
|
|
|
|
</li>
|
|
<li><span class="parameter">LEFT</span>
|
|
|
|
|
|
|
|
</li>
|
|
<li><span class="parameter">RIGHT</span>
|
|
|
|
|
|
|
|
</li>
|
|
<li><span class="parameter">BACK</span>
|
|
|
|
|
|
|
|
</li>
|
|
<li><span class="parameter">FRONT</span>
|
|
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<h2><a name="Methods"></a>Methods</h2>
|
|
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "CLIENT:New"></a>
|
|
<strong>CLIENT:New (ClientName, ClientBriefing)</strong>
|
|
</dt>
|
|
<dd>
|
|
Use this method to register new Clients within the MOF.
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">ClientName</span>
|
|
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
|
Name of the Group as defined within the Mission Editor. The Group must have a Unit with the type Client.
|
|
</li>
|
|
<li><span class="parameter">ClientBriefing</span>
|
|
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
|
Text that describes the briefing of the mission when a Player logs into the Client.
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><a class="type" href="../classes/CLIENT.html#">CLIENT</a></span>
|
|
|
|
|
|
|
|
</ol>
|
|
|
|
|
|
|
|
<h3>Usage:</h3>
|
|
<ul>
|
|
<pre class="example">
|
|
<span class="comment">-- Create new Clients.
|
|
</span> <span class="keyword">local</span> Mission = MISSIONSCHEDULER.AddMission( <span class="string">'Russia Transport Troops SA-6'</span>, <span class="string">'Operational'</span>, <span class="string">'Transport troops from the control center to one of the SA-6 SAM sites to activate their operation.'</span>, <span class="string">'Russia'</span> )
|
|
Mission:AddGoal( DeploySA6TroopsGoal )
|
|
|
|
Mission:AddClient( CLIENT:New( <span class="string">'RU MI-8MTV2*HOT-Deploy Troops 1'</span> ):Transport() )
|
|
Mission:AddClient( CLIENT:New( <span class="string">'RU MI-8MTV2*RAMP-Deploy Troops 3'</span> ):Transport() )
|
|
Mission:AddClient( CLIENT:New( <span class="string">'RU MI-8MTV2*HOT-Deploy Troops 2'</span> ):Transport() )
|
|
Mission:AddClient( CLIENT:New( <span class="string">'RU MI-8MTV2*RAMP-Deploy Troops 4'</span> ):Transport() )</pre>
|
|
</ul>
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "CLIENT:Reset"></a>
|
|
<strong>CLIENT:Reset (ClientName)</strong>
|
|
</dt>
|
|
<dd>
|
|
Resets a CLIENT.
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">ClientName</span>
|
|
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
|
Name of the Group as defined within the Mission Editor. The Group must have a Unit with the type Client.
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "CLIENT:ClientGroup"></a>
|
|
<strong>CLIENT:ClientGroup ()</strong>
|
|
</dt>
|
|
<dd>
|
|
ClientGroup returns the Group of a Client.
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">Group</span></span>
|
|
|
|
|
|
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "CLIENT:Transport"></a>
|
|
<strong>CLIENT:Transport ()</strong>
|
|
</dt>
|
|
<dd>
|
|
Transport defines that the Client is a Transport.
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><a class="type" href="../classes/CLIENT.html#">CLIENT</a></span>
|
|
|
|
|
|
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "CLIENT:AddBriefing"></a>
|
|
<strong>CLIENT:AddBriefing (ClientBriefing)</strong>
|
|
</dt>
|
|
<dd>
|
|
AddBriefing adds a briefing to a Client when a Player joins a Mission.
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">ClientBriefing</span>
|
|
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
|
is the text defining the Mission briefing.
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><a class="type" href="../classes/CLIENT.html#">CLIENT</a></span>
|
|
|
|
|
|
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "CLIENT:IsTransport"></a>
|
|
<strong>CLIENT:IsTransport ()</strong>
|
|
</dt>
|
|
<dd>
|
|
IsTransport returns if a Client is a transport.
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">bool</span></span>
|
|
|
|
|
|
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "CLIENT:FindCargo"></a>
|
|
<strong>CLIENT:FindCargo (CargoName)</strong>
|
|
</dt>
|
|
<dd>
|
|
FindCargo finds loaded Cargo within a CLIENT instance.
|
|
Cargo is loaded when certain PICK-UP or DEPLOY Tasks are properly executed.
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">CargoName</span>
|
|
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
|
is the name of the cargo.
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><a class="type" href="../classes/CARGO.html#">CARGO_TYPE</a></span>
|
|
|
|
|
|
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "CLIENT:ShowCargo"></a>
|
|
<strong>CLIENT:ShowCargo ()</strong>
|
|
</dt>
|
|
<dd>
|
|
ShowCargo shows the <a href="../classes/CARGO.html#">CARGO</a> within the CLIENT to the Player.
|
|
The <a href="../classes/CARGO.html#">CARGO</a> is shown throught the MESSAGE system of DCS World.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "CLIENT:AddCargo"></a>
|
|
<strong>CLIENT:AddCargo (CargoName, CargoGroupName, CargoType, CargoWeight, CargoGroupTemplate)</strong>
|
|
</dt>
|
|
<dd>
|
|
AddCargo allows to add <a href="../classes/CARGO.html#">CARGO</a> on the CLIENT.
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">CargoName</span>
|
|
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
|
is the name of the <a href="../classes/CARGO.html#">CARGO</a>.
|
|
</li>
|
|
<li><span class="parameter">CargoGroupName</span>
|
|
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
|
is the name of an active Group defined within the Mission Editor or Dynamically Spawned. Note that this is only applicable for Unit <a href="../classes/CARGO.html#">CARGO</a> Types.
|
|
</li>
|
|
<li><span class="parameter">CargoType</span>
|
|
<span class="types"><a class="type" href="../classes/CARGO.html#">CARGO_TYPE</a></span>
|
|
is the Type of the <a href="../classes/CARGO.html#">CARGO</a>.
|
|
</li>
|
|
<li><span class="parameter">CargoWeight</span>
|
|
<span class="types"><span class="type">number</span></span>
|
|
is the weight of the cargo in Kg.
|
|
</li>
|
|
<li><span class="parameter">CargoGroupTemplate</span>
|
|
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
|
is the name of an active Group defined within the Mission Editor with "Late Activation".
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><a class="type" href="../classes/CLIENT.html#">CLIENT</a></span>
|
|
|
|
|
|
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "CLIENT:RemoveCargo"></a>
|
|
<strong>CLIENT:RemoveCargo (CargoName)</strong>
|
|
</dt>
|
|
<dd>
|
|
RemoveCargo removes <a href="../classes/CARGO.html#">CARGO</a> from the CLIENT.
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">CargoName</span>
|
|
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
|
is the name of the <a href="../classes/CARGO.html#">CARGO</a>.
|
|
</li>
|
|
</ul>
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><span class="type">Cargo</span></span>
|
|
|
|
|
|
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "CLIENT:SwitchMessages"></a>
|
|
<strong>CLIENT:SwitchMessages (PrmTable)</strong>
|
|
</dt>
|
|
<dd>
|
|
SwitchMessages is a local function called by the DCS World Menu system to switch off messages.
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">PrmTable</span>
|
|
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "CLIENT:Message"></a>
|
|
<strong>CLIENT:Message (Message, MessageDuration, MessageId, MessageCategory, MessageInterval)</strong>
|
|
</dt>
|
|
<dd>
|
|
Message is the key Message driver for the CLIENT class.
|
|
This function displays various messages to the Player logged into the CLIENT through the DCS World Messaging system.
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">Message</span>
|
|
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
|
is the text describing the message.
|
|
</li>
|
|
<li><span class="parameter">MessageDuration</span>
|
|
<span class="types"><span class="type">number</span></span>
|
|
is the duration in seconds that the Message should be displayed.
|
|
</li>
|
|
<li><span class="parameter">MessageId</span>
|
|
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
|
is a text identifying the Message in the MessageQueue. The Message system overwrites Messages with the same MessageId
|
|
</li>
|
|
<li><span class="parameter">MessageCategory</span>
|
|
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
|
is the category of the message (the title).
|
|
</li>
|
|
<li><span class="parameter">MessageInterval</span>
|
|
<span class="types"><span class="type">number</span></span>
|
|
is the interval in seconds between the display of the Message when the CLIENT is in the air.
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div> <!-- id="content" -->
|
|
</div> <!-- id="main" -->
|
|
<div id="about">
|
|
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
|
<i style="float:right;">Last updated 2015-01-29 21:06:10 </i>
|
|
</div> <!-- id="about" -->
|
|
</div> <!-- id="container" -->
|
|
</body>
|
|
</html>
|