mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-08-15 10:47:21 +00:00
420 lines
9.8 KiB
HTML
420 lines
9.8 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="#Methods">Methods</a></li>
|
|
<li><a href="#Private">Private </a></li>
|
|
<li><a href="#Events">Events </a></li>
|
|
<li><a href="#Scheduled">Scheduled </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><a href="../classes/CLIENT.html">CLIENT</a></li>
|
|
<li><strong>DATABASE</strong></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>DATABASE</code></h1>
|
|
<p>Administers the Initial Sets of the Mission Templates as defined within the Mission Editor.</p>
|
|
<p> Administers the Spawning of new Groups within the DCSRTE and administers these new Groups within the DATABASE object(s).</p>
|
|
|
|
|
|
<h2><a href="#Methods">Methods</a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap><a href="#DATABASE:New">DATABASE:New ()</a></td>
|
|
<td class="summary">Creates a new DATABASE Object to administer the Groups defined and alive within the DCSRTE.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#DATABASE:Spawn">DATABASE:Spawn (SpawnTemplate)</a></td>
|
|
<td class="summary">Instantiate new Groups within the DCSRTE.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#DATABASE:SetStatusGroup">DATABASE:SetStatusGroup (GroupName, Status)</a></td>
|
|
<td class="summary">Set a status to a Group within the Database, this to check crossing events for example.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#DATABASE:GetStatusGroup">DATABASE:GetStatusGroup (GroupName)</a></td>
|
|
<td class="summary">Get a status to a Group within the Database, this to check crossing events for example.</td>
|
|
</tr>
|
|
</table>
|
|
<h2><a href="#Private">Private </a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap><a href="#DATABASE:_RegisterGroup">DATABASE:_RegisterGroup (GroupTemplate)</a></td>
|
|
<td class="summary">Registers new Group Templates within the DATABASE Object.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#DATABASE:_AddPlayerFromUnit">DATABASE:_AddPlayerFromUnit (UnitData)</a></td>
|
|
<td class="summary">Add a new player entering a Unit.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#DATABASE:_AddMissionTaskScore">DATABASE:_AddMissionTaskScore (PlayerUnit, MissionName, Score)</a></td>
|
|
<td class="summary">Registers Scores the players completing a Mission Task.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap><a href="#DATABASE:_AddMissionScore">DATABASE:_AddMissionScore (MissionName, Score)</a></td>
|
|
<td class="summary">Registers Mission Scores for possible multiple players that contributed in the Mission.</td>
|
|
</tr>
|
|
</table>
|
|
<h2><a href="#Events">Events </a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap><a href="#DATABASE:OnDeadOrCrash">DATABASE:OnDeadOrCrash (event)</a></td>
|
|
<td class="summary">Track DCSRTE DEAD or CRASH events for the internal scoring.</td>
|
|
</tr>
|
|
</table>
|
|
<h2><a href="#Scheduled">Scheduled </a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap><a href="#DATABASE:_FollowPlayers">DATABASE:_FollowPlayers ()</a></td>
|
|
<td class="summary">Follows new players entering Clients within the DCSRTE.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br/>
|
|
<br/>
|
|
|
|
|
|
<h2><a name="Methods"></a>Methods</h2>
|
|
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "DATABASE:New"></a>
|
|
<strong>DATABASE:New ()</strong>
|
|
</dt>
|
|
<dd>
|
|
Creates a new DATABASE Object to administer the Groups defined and alive within the DCSRTE.
|
|
|
|
|
|
|
|
<h3>Returns:</h3>
|
|
<ol>
|
|
|
|
<span class="types"><a class="type" href="../classes/DATABASE.html#">DATABASE</a></span>
|
|
|
|
|
|
|
|
</ol>
|
|
|
|
|
|
|
|
<h3>Usage:</h3>
|
|
<ul>
|
|
<pre class="example">
|
|
<span class="comment">-- Define a new DATABASE Object. This DBObject will contain a reference to all Group and Unit Templates defined within the ME and the DCSRTE.
|
|
</span> DBObject = DATABASE:New()</pre>
|
|
</ul>
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "DATABASE:Spawn"></a>
|
|
<strong>DATABASE:Spawn (SpawnTemplate)</strong>
|
|
</dt>
|
|
<dd>
|
|
Instantiate new Groups within the DCSRTE.
|
|
This method expects EXACTLY the same structure as a structure within the ME, and needs 2 additional fields defined:
|
|
SpawnCountryID, SpawnCategoryID
|
|
This method is used by the SPAWN class.
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">SpawnTemplate</span>
|
|
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "DATABASE:SetStatusGroup"></a>
|
|
<strong>DATABASE:SetStatusGroup (GroupName, Status)</strong>
|
|
</dt>
|
|
<dd>
|
|
Set a status to a Group within the Database, this to check crossing events for example.
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">GroupName</span>
|
|
|
|
|
|
|
|
</li>
|
|
<li><span class="parameter">Status</span>
|
|
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "DATABASE:GetStatusGroup"></a>
|
|
<strong>DATABASE:GetStatusGroup (GroupName)</strong>
|
|
</dt>
|
|
<dd>
|
|
Get a status to a Group within the Database, this to check crossing events for example.
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">GroupName</span>
|
|
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<h2><a name="Private"></a>Private </h2>
|
|
|
|
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "DATABASE:_RegisterGroup"></a>
|
|
<strong>DATABASE:_RegisterGroup (GroupTemplate)</strong>
|
|
</dt>
|
|
<dd>
|
|
Registers new Group Templates within the DATABASE Object.
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">GroupTemplate</span>
|
|
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "DATABASE:_AddPlayerFromUnit"></a>
|
|
<strong>DATABASE:_AddPlayerFromUnit (UnitData)</strong>
|
|
</dt>
|
|
<dd>
|
|
Add a new player entering a Unit.
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">UnitData</span>
|
|
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "DATABASE:_AddMissionTaskScore"></a>
|
|
<strong>DATABASE:_AddMissionTaskScore (PlayerUnit, MissionName, Score)</strong>
|
|
</dt>
|
|
<dd>
|
|
Registers Scores the players completing a Mission Task.
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">PlayerUnit</span>
|
|
|
|
|
|
|
|
</li>
|
|
<li><span class="parameter">MissionName</span>
|
|
|
|
|
|
|
|
</li>
|
|
<li><span class="parameter">Score</span>
|
|
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
<dt>
|
|
<a name = "DATABASE:_AddMissionScore"></a>
|
|
<strong>DATABASE:_AddMissionScore (MissionName, Score)</strong>
|
|
</dt>
|
|
<dd>
|
|
Registers Mission Scores for possible multiple players that contributed in the Mission.
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">MissionName</span>
|
|
|
|
|
|
|
|
</li>
|
|
<li><span class="parameter">Score</span>
|
|
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<h2><a name="Events"></a>Events </h2>
|
|
|
|
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "DATABASE:OnDeadOrCrash"></a>
|
|
<strong>DATABASE:OnDeadOrCrash (event)</strong>
|
|
</dt>
|
|
<dd>
|
|
Track DCSRTE DEAD or CRASH events for the internal scoring.
|
|
|
|
|
|
<h3>Parameters:</h3>
|
|
<ul>
|
|
<li><span class="parameter">event</span>
|
|
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<h2><a name="Scheduled"></a>Scheduled </h2>
|
|
|
|
|
|
<dl class="function">
|
|
<dt>
|
|
<a name = "DATABASE:_FollowPlayers"></a>
|
|
<strong>DATABASE:_FollowPlayers ()</strong>
|
|
</dt>
|
|
<dd>
|
|
Follows new players entering Clients within the DCSRTE.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</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>
|