MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2023-02-19 11:44:09 +00:00
parent 4580946807
commit 16f32c513d
28 changed files with 618 additions and 822 deletions
+56 -6
View File
@@ -1791,6 +1791,12 @@ If the DCS Unit object does not exist or is nil, the CLIENT methods will return
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).FindByName">CLIENT:FindByName(ClientName, ClientBriefing, Error)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Finds a CLIENT from the _DATABASE using the relevant Client Unit Name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).FindByPlayerName">CLIENT:FindByPlayerName(Name)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Finds a CLIENT from the _DATABASE using the relevant player name.</p>
</td>
</tr>
<tr class="w3-border">
@@ -4938,16 +4944,60 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>-- Create new Clients.
local Mission = MISSIONSCHEDULER.AddMission( 'Russia Transport Troops SA-6', 'Operational', 'Transport troops from the control center to one of the SA-6 SAM sites to activate their operation.', 'Russia' )
Mission:AddGoal( DeploySA6TroopsGoal )
local Mission = MISSIONSCHEDULER.AddMission( 'Russia Transport Troops SA-6', 'Operational', 'Transport troops from the control center to one of the SA-6 SAM sites to activate their operation.', 'Russia' )
Mission:AddGoal( DeploySA6TroopsGoal )
Mission:AddClient( CLIENT:FindByName( 'RU MI-8MTV2*HOT-Deploy Troops 1' ):Transport() )
Mission:AddClient( CLIENT:FindByName( 'RU MI-8MTV2*RAMP-Deploy Troops 3' ):Transport() )
Mission:AddClient( CLIENT:FindByName( 'RU MI-8MTV2*HOT-Deploy Troops 2' ):Transport() )
Mission:AddClient( CLIENT:FindByName( 'RU MI-8MTV2*RAMP-Deploy Troops 4' ):Transport() )</code></pre>
Mission:AddClient( CLIENT:FindByName( 'RU MI-8MTV2*HOT-Deploy Troops 1' ):Transport() )
Mission:AddClient( CLIENT:FindByName( 'RU MI-8MTV2*RAMP-Deploy Troops 3' ):Transport() )
Mission:AddClient( CLIENT:FindByName( 'RU MI-8MTV2*HOT-Deploy Troops 2' ):Transport() )
Mission:AddClient( CLIENT:FindByName( 'RU MI-8MTV2*RAMP-Deploy Troops 4' ):Transport() )</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).FindByPlayerName" ><strong>CLIENT:FindByPlayerName(Name)</strong></a></h2>
</div>
<p>Finds a CLIENT from the _DATABASE using the relevant player name.</p>
<div id= "#Functions##FindByPlayerName" 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>CLIENT</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>
#string
<strong><strong>Name</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Name of the player</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="##(CLIENT)">#CLIENT</a>:</p>
</div>
<div class="w3-half">
<p>or nil if not found</p>
</div>
</div>
</div>
</div>
</div>