weyne/MOOSE_DOCS
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE_DOCS.git synced 2026-08-21 11:01:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

MOOSE generated documentation [skip ci]

Browse Source
This commit is contained in:
Applevangelist
2023-07-25 10:14:52 +00:00
parent e0bff0bae8
commit 660dba5858
30 changed files with 877 additions and 944 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Documentation/AI.AI_Escort.html
+50 -161
View File
@@ -1801,10 +1801,13 @@ Note that this is really fantastic, as you now have the dynamic of taking contro
-- First find the GROUP object and the CLIENT object.
local EscortUnit = CLIENT:FindByName( "Unit Name" ) -- The Unit Name is the name of the unit flagged with the skill Client in the mission editor.
local EscortGroup = GROUP:FindByName( "Group Name" ) -- The Group Name is the name of the group that will escort the Escort Client.
local EscortGroup = SET_GROUP:New():FilterPrefixes("Escort"):FilterOnce() -- The the group name of the escorts contains "Escort".
-- Now use these 2 objects to construct the new EscortPlanes object.
EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the mission. You are escorted by a plane with code name 'Desert', which can be instructed through the F10 radio menu." )
EscortPlanes:MenusAirplanes() -- create menus for airplanes
EscortPlanes:__Start(2)
</code></pre>
</div>
@@ -1877,12 +1880,6 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_ESCORT).EscortName">AI_ESCORT.EscortName</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="##(AI_ESCORT).FlightMenu">AI_ESCORT.FlightMenu</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -1901,12 +1898,6 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_ESCORT).GetFlightReportType">AI_ESCORT:GetFlightReportType()</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="##(AI_ESCORT).MainMenu">AI_ESCORT.MainMenu</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -2252,11 +2243,9 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_ESCORT)._AssistTarget">AI_ESCORT._AssistTarget(EscortGroup, DetectedItem, self)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_ESCORT)._AssistTarget">AI_ESCORT:_AssistTarget(EscortGroup, DetectedItem)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<ul>
<li>@param #AI_ESCORT self</li>
</ul>
</td>
</tr>
<tr class="w3-border">
@@ -3956,17 +3945,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="#(AI_ESCORT).FlightMenu" ><strong>AI_ESCORT.FlightMenu</strong></a>
</div>
</div>
@@ -3989,17 +3967,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="#(AI_ESCORT).MainMenu" ><strong>AI_ESCORT.MainMenu</strong></a>
</div>
</div>
@@ -5848,10 +5815,14 @@ Note that if a report targets menu is not specified, no targets will be detected
-- First find the GROUP object and the CLIENT object.
local EscortUnit = CLIENT:FindByName( "Unit Name" ) -- The Unit Name is the name of the unit flagged with the skill Client in the mission editor.
local EscortGroup = GROUP:FindByName( "Group Name" ) -- The Group Name is the name of the group that will escort the Escort Client.
local EscortGroup = SET_GROUP:New():FilterPrefixes("Escort"):FilterOnce() -- The the group name of the escorts contains "Escort".
-- Now use these 2 objects to construct the new EscortPlanes object.
EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the mission. You are escorted by a plane with code name 'Desert', which can be instructed through the F10 radio menu." )</code></pre>
EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the mission. You are escorted by a plane with code name 'Desert', which can be instructed through the F10 radio menu." )
EscortPlanes:MenusAirplanes() -- create menus for airplanes
EscortPlanes:__Start(2)
</code></pre>
</div>
@@ -6487,12 +6458,10 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(AI_ESCORT)._AssistTarget" ><strong>AI_ESCORT._AssistTarget(EscortGroup, DetectedItem, self)</strong></a></h2>
<h2><a id="#(AI_ESCORT)._AssistTarget" ><strong>AI_ESCORT:_AssistTarget(EscortGroup, DetectedItem)</strong></a></h2>
</div>
<ul>
<li>@param #AI_ESCORT self</li>
</ul>
<div id= "#Functions##_AssistTarget" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -6525,16 +6494,6 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>self</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
@@ -6548,6 +6507,11 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
<p> @param #AI_ESCORT self
@param Wrapper.Group#GROUP EscortGroup The escort group that will attack the detected item.
@param Functional.Detection#DETECTION_BASE.DetectedItem DetectedItem</p>
<div id= "#Functions##_AttackTarget" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
@@ -6558,20 +6522,16 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
<strong><strong>EscortGroup</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The escort group that will attack the detected item.</p>
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Functional.Detection.html##(DETECTION_BASE.DetectedItem)">Functional.Detection#DETECTION_BASE.DetectedItem</a>
<strong><strong>DetectedItem</strong></strong>
</p>
</div>
@@ -7025,6 +6985,12 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
<p> @param #AI_ESCORT self
@param Wrapper.Group#GROUP OrbitGroup
@param #number OrbitHeight
@param #number OrbitSeconds</p>
<div id= "#Functions##_FlightHoldPosition" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
@@ -7035,7 +7001,6 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
<strong><strong>OrbitGroup</strong></strong>
</p>
</div>
@@ -7046,7 +7011,6 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>OrbitHeight</strong></strong>
</p>
</div>
@@ -7057,7 +7021,6 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>OrbitSeconds</strong></strong>
</p>
</div>
@@ -7536,6 +7499,13 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
<p> @param #AI_ESCORT self
@param Wrapper.Group#GROUP OrbitGroup
@param Wrapper.Group#GROUP EscortGroup
@param #number OrbitHeight
@param #number OrbitSeconds</p>
<div id= "#Functions##_HoldPosition" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
@@ -7546,7 +7516,6 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
<strong><strong>OrbitGroup</strong></strong>
</p>
</div>
@@ -7557,7 +7526,6 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
<strong><strong>EscortGroup</strong></strong>
</p>
</div>
@@ -7568,7 +7536,6 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>OrbitHeight</strong></strong>
</p>
</div>
@@ -7579,7 +7546,6 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>OrbitSeconds</strong></strong>
</p>
</div>
@@ -7880,6 +7846,11 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
<p> @param #AI_ESCORT self
@param Wrapper.Group#GROUP EscortGroup
@param #number WayPoint</p>
<div id= "#Functions##_ResumeMission" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
@@ -7890,7 +7861,6 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
<strong><strong>EscortGroup</strong></strong>
</p>
</div>
@@ -7901,7 +7871,6 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>WayPoint</strong></strong>
</p>
</div>
@@ -8033,6 +8002,10 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
<p> @param Wrapper.Group#GROUP EscortGroup
@param #AI_ESCORT self</p>
<div id= "#Functions##___Resume" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
@@ -8043,7 +8016,6 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
<strong><strong>EscortGroup</strong></strong>
</p>
</div>
@@ -8054,7 +8026,6 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="##(AI_ESCORT)">#AI_ESCORT</a>
<strong><strong>self</strong></strong>
</p>
</div>
@@ -8075,6 +8046,10 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
<p> @param #AI_ESCORT self
@param Core.Set#SET_GROUP EscortGroupSet</p>
<div id= "#Functions##onafterStart" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
@@ -8085,7 +8060,6 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a>
<strong><strong>EscortGroupSet</strong></strong>
</p>
</div>
@@ -8106,6 +8080,10 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
<p> @param #AI_ESCORT self
@param Core.Set#SET_GROUP EscortGroupSet</p>
<div id= "#Functions##onafterStop" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
@@ -8116,7 +8094,6 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a>
<strong><strong>EscortGroupSet</strong></strong>
</p>
</div>
@@ -8221,17 +8198,6 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(AI_ESCORT).FlightMenu" ><strong>AI_ESCORT.FlightMenu</strong></a>
</div>
</div>
@@ -8254,17 +8220,6 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(AI_ESCORT).MainMenu" ><strong>AI_ESCORT.MainMenu</strong></a>
</div>
</div>
@@ -14916,17 +14871,6 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(AI_ESCORT).FlightMenu" ><strong>AI_ESCORT.FlightMenu</strong></a>
</div>
</div>
@@ -14949,17 +14893,6 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(AI_ESCORT).MainMenu" ><strong>AI_ESCORT.MainMenu</strong></a>
</div>
</div>
@@ -15247,17 +15180,6 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(AI_ESCORT).FlightMenu" ><strong>AI_ESCORT.FlightMenu</strong></a>
</div>
</div>
@@ -15280,17 +15202,6 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(AI_ESCORT).MainMenu" ><strong>AI_ESCORT.MainMenu</strong></a>
</div>
</div>
@@ -16861,17 +16772,6 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(AI_ESCORT).FlightMenu" ><strong>AI_ESCORT.FlightMenu</strong></a>
</div>
</div>
@@ -16894,17 +16794,6 @@ EscortPlanes = AI_ESCORT:New( EscortUnit, EscortGroup, "Desert", "Welcome to the
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(AI_ESCORT).MainMenu" ><strong>AI_ESCORT.MainMenu</strong></a>
</div>
</div>