mirror of
https://github.com/FlightControl-Master/MOOSE_DOCS.git
synced 2025-08-15 10:37:49 +00:00
MOOSE generated documentation [skip ci]
This commit is contained in:
Applevangelist
@@ -2241,7 +2241,7 @@ and any spaces before and after the resulting name are removed.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SPAWN).NewFromTemplate">SPAWN:NewFromTemplate(SpawnTemplate, SpawnTemplatePrefix, SpawnAliasPrefix)</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SPAWN).NewFromTemplate">SPAWN:NewFromTemplate(SpawnTemplate, SpawnTemplatePrefix, SpawnAliasPrefix, MooseNaming)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Creates a new SPAWN instance to create new groups based on the provided template.</p>
|
||||
</td>
|
||||
@@ -2881,6 +2881,24 @@ 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="##(SPAWN)._TranslateRotate">SPAWN:_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="##(SPAWN).frequency">SPAWN.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="##(SPAWN).skill">SPAWN.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="##(SPAWN).uncontrolled">SPAWN.uncontrolled</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@@ -3517,6 +3535,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
|
||||
|
||||
|
||||
|
||||
<p> Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -3572,6 +3593,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#number
|
||||
<a id="#(SPAWN).SpawnCount" ><strong>SPAWN.SpawnCount</strong></a>
|
||||
|
||||
|
||||
|
||||
|
||||
<p> The internal counter of the amount of spawning the has happened since SpawnStart.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -3685,17 +3720,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
|
||||
<a id="#(SPAWN).SpawnInitFreq" ><strong>SPAWN.SpawnInitFreq</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -3751,6 +3775,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#boolean
|
||||
<a id="#(SPAWN).SpawnInitKeepUnitNames" ><strong>SPAWN.SpawnInitKeepUnitNames</strong></a>
|
||||
|
||||
|
||||
|
||||
|
||||
<p> Overwrite unit names by default with group name.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -3776,17 +3814,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
|
||||
<a id="#(SPAWN).SpawnInitModex" ><strong>SPAWN.SpawnInitModex</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -3798,17 +3825,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#string
|
||||
<a id="#(SPAWN).SpawnInitSkill" ><strong>SPAWN.SpawnInitSkill</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -4000,6 +4016,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#boolean
|
||||
<a id="#(SPAWN).SpawnUnControlled" ><strong>SPAWN.SpawnUnControlled</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -4034,7 +4061,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
|
||||
|
||||
|
||||
<p> When the first Spawn executes, all the Groups need to be made visible before start.</p>
|
||||
<p> Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.</p>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -4108,6 +4135,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
|
||||
<a id="#(SPAWN).frequency" ><strong>SPAWN.frequency</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
|
||||
<a id="#(SPAWN).skill" ><strong>SPAWN.skill</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
|
||||
<a id="#(SPAWN).uncontrolled" ><strong>SPAWN.uncontrolled</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -6426,11 +6486,14 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' )</code></pre></li>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(SPAWN).NewFromTemplate" ><strong>SPAWN:NewFromTemplate(SpawnTemplate, SpawnTemplatePrefix, SpawnAliasPrefix)</strong></a></h2>
|
||||
<h2><a id="#(SPAWN).NewFromTemplate" ><strong>SPAWN:NewFromTemplate(SpawnTemplate, SpawnTemplatePrefix, SpawnAliasPrefix, MooseNaming)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Creates a new SPAWN instance to create new groups based on the provided template.</p>
|
||||
|
||||
|
||||
<p>This will also register the template for future use.</p>
|
||||
|
||||
<div id= "#Functions##NewFromTemplate" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
@@ -6447,7 +6510,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' )</code></pre></li>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>is the Template of the Group. This must be a valid Group Template structure!</p>
|
||||
<p>is the Template of the Group. This must be a valid Group Template structure - see <a href="https://wiki.hoggitworld.com/view/DCS_func_addGroup">Hoggit Wiki</a>!</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -6460,7 +6523,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' )</code></pre></li>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>is the name of the Group that will be given at each spawn.</p>
|
||||
<p>[Mandatory] is the name of the template and the prefix of the GROUP on spawn.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -6473,7 +6536,20 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' )</code></pre></li>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>is the name that will be given to the Group at runtime.</p>
|
||||
<p>[Optional] is the prefix that will be given to the GROUP on spawn.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#boolean
|
||||
<strong><strong>MooseNaming</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>[Optional] If false, skip the Moose naming additions (like groupname#001-01) - you need to ensure yourself no duplicate group names exist!</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -6484,19 +6560,109 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' )</code></pre></li>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
|
||||
<p>self</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Usages:</strong></h2>
|
||||
<ul>
|
||||
<li><pre class="example"><code>-- Create a new SPAWN object based on a Group Template defined from scratch.
|
||||
Spawn_BE_KA50 = SPAWN:NewWithAlias( 'BE KA-50@RAMP-Ground Defense', 'Helicopter Attacking a City' )</code></pre></li>
|
||||
<li><pre class="example"><code>
|
||||
-- Create a new CSAR_Spawn object based on a normal Group Template to spawn a soldier.
|
||||
local CSAR_Spawn = SPAWN:NewWithFromTemplate( Template, "CSAR", "Pilot" )
|
||||
</code></pre></li>
|
||||
</ul>
|
||||
<h2><strong>Usage:</strong></h2>
|
||||
<pre class="example"><code>-- Spawn a P51 Mustang from scratch
|
||||
local ttemp =
|
||||
{
|
||||
["modulation"] = 0,
|
||||
["tasks"] =
|
||||
{
|
||||
}, -- end of ["tasks"]
|
||||
["task"] = "Reconnaissance",
|
||||
["uncontrolled"] = false,
|
||||
["route"] =
|
||||
{
|
||||
["points"] =
|
||||
{
|
||||
[1] =
|
||||
{
|
||||
["alt"] = 2000,
|
||||
["action"] = "Turning Point",
|
||||
["alt_type"] = "BARO",
|
||||
["speed"] = 125,
|
||||
["task"] =
|
||||
{
|
||||
["id"] = "ComboTask",
|
||||
["params"] =
|
||||
{
|
||||
["tasks"] =
|
||||
{
|
||||
}, -- end of ["tasks"]
|
||||
}, -- end of ["params"]
|
||||
}, -- end of ["task"]
|
||||
["type"] = "Turning Point",
|
||||
["ETA"] = 0,
|
||||
["ETA_locked"] = true,
|
||||
["y"] = 666285.71428571,
|
||||
["x"] = -312000,
|
||||
["formation_template"] = "",
|
||||
["speed_locked"] = true,
|
||||
}, -- end of [1]
|
||||
}, -- end of ["points"]
|
||||
}, -- end of ["route"]
|
||||
["groupId"] = 1,
|
||||
["hidden"] = false,
|
||||
["units"] =
|
||||
{
|
||||
[1] =
|
||||
{
|
||||
["alt"] = 2000,
|
||||
["alt_type"] = "BARO",
|
||||
["livery_id"] = "USAF 364th FS",
|
||||
["skill"] = "High",
|
||||
["speed"] = 125,
|
||||
["type"] = "TF-51D",
|
||||
["unitId"] = 1,
|
||||
["psi"] = 0,
|
||||
["y"] = 666285.71428571,
|
||||
["x"] = -312000,
|
||||
["name"] = "P51-1-1",
|
||||
["payload"] =
|
||||
{
|
||||
["pylons"] =
|
||||
{
|
||||
}, -- end of ["pylons"]
|
||||
["fuel"] = 340.68,
|
||||
["flare"] = 0,
|
||||
["chaff"] = 0,
|
||||
["gun"] = 100,
|
||||
}, -- end of ["payload"]
|
||||
["heading"] = 0,
|
||||
["callsign"] =
|
||||
{
|
||||
[1] = 1,
|
||||
[2] = 1,
|
||||
["name"] = "Enfield11",
|
||||
[3] = 1,
|
||||
}, -- end of ["callsign"]
|
||||
["onboard_num"] = "010",
|
||||
}, -- end of [1]
|
||||
}, -- end of ["units"]
|
||||
["y"] = 666285.71428571,
|
||||
["x"] = -312000,
|
||||
["name"] = "P51",
|
||||
["communication"] = true,
|
||||
["start_time"] = 0,
|
||||
["frequency"] = 124,
|
||||
}
|
||||
|
||||
|
||||
local mustang = SPAWN:NewFromTemplate(ttemp,"P51D")
|
||||
-- you MUST set the next three:
|
||||
mustang:InitCountry(country.id.FRANCE)
|
||||
mustang:InitCategory(Group.Category.AIRPLANE)
|
||||
mustang:InitCoalition(coalition.side.BLUE)
|
||||
mustang:OnSpawnGroup(
|
||||
function(grp)
|
||||
MESSAGE:New("Group Spawned: "..grp:GetName(),15,"SPAWN"):ToAll()
|
||||
end
|
||||
)
|
||||
mustang:Spawn()
|
||||
</code></pre>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -6551,7 +6717,7 @@ Spawn_BE_KA50 = SPAWN:NewWithAlias( 'BE KA-50@RAMP-Ground Defense', 'Helicopter
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
|
||||
<p>self</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -9043,6 +9209,9 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.</p
|
||||
|
||||
|
||||
|
||||
|
||||
<p> Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -9098,6 +9267,20 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.</p
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#number
|
||||
<a id="#(SPAWN).SpawnCount" ><strong>SPAWN.SpawnCount</strong></a>
|
||||
|
||||
|
||||
|
||||
|
||||
<p> The internal counter of the amount of spawning the has happened since SpawnStart.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -9211,17 +9394,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.</p
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
|
||||
<a id="#(SPAWN).SpawnInitFreq" ><strong>SPAWN.SpawnInitFreq</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -9277,6 +9449,20 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.</p
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#boolean
|
||||
<a id="#(SPAWN).SpawnInitKeepUnitNames" ><strong>SPAWN.SpawnInitKeepUnitNames</strong></a>
|
||||
|
||||
|
||||
|
||||
|
||||
<p> Overwrite unit names by default with group name.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -9302,17 +9488,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.</p
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
|
||||
<a id="#(SPAWN).SpawnInitModex" ><strong>SPAWN.SpawnInitModex</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -9324,17 +9499,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.</p
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#string
|
||||
<a id="#(SPAWN).SpawnInitSkill" ><strong>SPAWN.SpawnInitSkill</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -9526,6 +9690,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.</p
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#boolean
|
||||
<a id="#(SPAWN).SpawnUnControlled" ><strong>SPAWN.SpawnUnControlled</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -9560,7 +9735,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.</p
|
||||
|
||||
|
||||
|
||||
<p> When the first Spawn executes, all the Groups need to be made visible before start.</p>
|
||||
<p> Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.</p>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -9634,6 +9809,39 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.</p
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
|
||||
<a id="#(SPAWN).frequency" ><strong>SPAWN.frequency</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
|
||||
<a id="#(SPAWN).skill" ><strong>SPAWN.skill</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
|
||||
<a id="#(SPAWN).uncontrolled" ><strong>SPAWN.uncontrolled</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user