weyne/MOOSE_DOCS
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE_DOCS.git synced 2025-08-15 10:37:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

MOOSE generated documentation [skip ci]

Browse Source
This commit is contained in:
Applevangelist
2023-07-13 14:31:45 +00:00
parent c77c0f2558
commit ba4cd885db
28 changed files with 1325 additions and 621 deletions
Download Patch File Download Diff File Expand all files Collapse all files

237
Documentation/Functional.RAT.html
View File

@@ -3468,12 +3468,6 @@ manager:Stop(7200)
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RAT).termtype">RAT.termtype</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Type of terminal to be used when spawning at an airbase.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RAT).type">RAT.type</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -3708,6 +3702,18 @@ and any spaces before and after the resulting name are removed.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RAT).InitModex">RAT:InitModex(modex)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Sets the modex of the first unit of the group.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RAT).InitPositionCoordinate">RAT:InitPositionCoordinate(Coordinate)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>This method sets a spawn position for the group that is different from the location of the template.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RAT).InitPositionVec2">RAT:InitPositionVec2(Vec2)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>This method sets a spawn position for the group that is different from the location of the template.</p>
</td>
</tr>
<tr class="w3-border">
@@ -3943,6 +3949,12 @@ and any spaces before and after the resulting name are removed.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RAT).SpawnFromCoordinate">RAT:SpawnFromCoordinate(Coordinate, SpawnIndex)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Will spawn a group from a Coordinate in 3D space.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RAT).SpawnFromNewPosition">RAT.SpawnFromNewPosition</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -4117,6 +4129,12 @@ and any spaces before and after the resulting name are removed.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RAT).SpawnInitModu">RAT.SpawnInitModu</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RAT).SpawnInitPosition">RAT.SpawnInitPosition</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -4465,6 +4483,12 @@ and any spaces before and after the resulting name are removed.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RAT)._Scheduler">RAT:_Scheduler()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>This function is called automatically by the Spawning scheduler.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RAT)._SetInitialPosition">RAT:_SetInitialPosition(SpawnIndex)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Private method that sets the DCS#Vec2 where the Group will be spawned.</p>
</td>
</tr>
<tr class="w3-border">
@@ -4477,30 +4501,6 @@ and any spaces before and after the resulting name are removed.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RAT)._TranslateRotate">RAT:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RAT).frequency">RAT.frequency</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RAT).livery_id">RAT.livery_id</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RAT).skill">RAT.skill</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(RAT).uncontrolled">RAT.uncontrolled</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
</table>
@@ -6892,17 +6892,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>Type of terminal to be used when spawning at an airbase.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(RAT).type" ><strong>RAT.type</strong></a>
</div>
</div>
@@ -14783,17 +14772,6 @@ Initializes the ratcraft array and group menu.</p>
<p>Type of terminal to be used when spawning at an airbase.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(RAT).type" ><strong>RAT.type</strong></a>
</div>
</div>
@@ -16164,6 +16142,94 @@ This parameter accepts the value 0, which defines that there are no maximum grou
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(RAT).InitPositionCoordinate" ><strong>RAT:InitPositionCoordinate(Coordinate)</strong></a></h2>
</div>
<p>This method sets a spawn position for the group that is different from the location of the template.</p>
<div id= "#Functions##InitPositionCoordinate" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Spawn.html##(SPAWN)">Core.Spawn#SPAWN</a></p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
<strong><strong>Coordinate</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The position to spawn from</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(SPAWN)">#SPAWN</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(RAT).InitPositionVec2" ><strong>RAT:InitPositionVec2(Vec2)</strong></a></h2>
</div>
<p>This method sets a spawn position for the group that is different from the location of the template.</p>
<div id= "#Functions##InitPositionVec2" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Spawn.html##(SPAWN)">Core.Spawn#SPAWN</a></p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="DCS.html##(Vec2)">DCS#Vec2</a>
<strong><strong>Vec2</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The position to spawn from</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(SPAWN)">#SPAWN</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
</div>
@@ -16779,7 +16845,7 @@ In other words, this method randomizes between a defined set of groups the templ
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
@@ -18919,7 +18985,7 @@ The variation is a number between 0 and 1, representing the % of variation to be
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="##(boolen)">#boolen</a>
#boolean
<strong><strong>WithDelay</strong></strong>
</p>
</div>
@@ -19346,6 +19412,10 @@ It will return nil of no prefix was found.</p>
<p> @param #SPAWN self
@param Core.Event#EVENTDATA EventData</p>
<div id= "#Functions##_OnBirth" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
@@ -19356,7 +19426,6 @@ It will return nil of no prefix was found.</p>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
<strong><strong>EventData</strong></strong>
</p>
</div>
@@ -19377,6 +19446,10 @@ It will return nil of no prefix was found.</p>
<p> @param #SPAWN self
@param Core.Event#EVENTDATA EventData</p>
<div id= "#Functions##_OnDeadOrCrash" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
@@ -19387,7 +19460,6 @@ It will return nil of no prefix was found.</p>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
<strong><strong>EventData</strong></strong>
</p>
</div>
@@ -19705,6 +19777,48 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.</p
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(RAT)._SetInitialPosition" ><strong>RAT:_SetInitialPosition(SpawnIndex)</strong></a></h2>
</div>
<p>Private method that sets the DCS#Vec2 where the Group will be spawned.</p>
<div id= "#Functions##_SetInitialPosition" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Spawn.html##(SPAWN)">Core.Spawn#SPAWN</a></p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>SpawnIndex</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(SPAWN)">#SPAWN</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
</div>
@@ -20954,17 +21068,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.</p
<p>Type of terminal to be used when spawning at an airbase.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(RAT).type" ><strong>RAT.type</strong></a>
</div>
</div>