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

Auto commit by GitHub Actions Workflow

Browse Source
This commit is contained in:
MooseBotter
2023-12-14 11:45:11 +00:00
parent 98900621ce
commit 5cd55371bc
28 changed files with 732 additions and 814 deletions
Download Patch File Download Diff File Expand all files Collapse all files

79
Documentation/Sound.UserSound.html
View File

@@ -1687,6 +1687,12 @@
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(USERSOUND).ToAll">USERSOUND:ToAll()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Play the usersound to all players.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(USERSOUND).ToClient">USERSOUND:ToClient(The, Delay, Client)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Play the usersound to the given <a href="Wrapper.Unit.html">Wrapper.Unit</a>.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2409,6 +2415,79 @@ 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">
<div class="w3-theme-l2">
<h2><a id="#(USERSOUND).ToClient" ><strong>USERSOUND:ToClient(The, Delay, Client)</strong></a></h2>
</div>
<p>Play the usersound to the given <a href="Wrapper.Unit.html">Wrapper.Unit</a>.</p>
<div id= "#Functions##ToClient" 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>USERSOUND</p>
</div>
<h2><strong>Parameters:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a>
<strong><strong>The</strong></strong>
</p>
</div>
<div class="w3-half">
<p><a href="Wrapper.Client.html">Wrapper.Client</a> to play the usersound to.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Delay</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Delay in seconds, before the sound is played. Default 0.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>Client</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="##(USERSOUND)">#USERSOUND</a>:</p>
</div>
<div class="w3-half">
<p>The usersound instance.</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code> local BlueVictory = USERSOUND:New( "BlueVictory.ogg" )
local PlayerUnit = CLIENT:FindByPlayerName("Karl Heinz")-- Search for the active client with playername "Karl Heinz", a human player.
BlueVictory:ToClient( PlayerUnit ) -- Play the victory sound to the player unit.
</code></pre>
</div>
</div>
</div>