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
2022-04-28 15:05:48 +00:00
parent abacb90d09
commit c5041ce336
34 changed files with 2006 additions and 768 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
Documentation/Sound.UserSound.html
View File

@@ -1603,6 +1603,12 @@ Controls a network of short range air/missile defense groups.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(USERSOUND).ToGroup">USERSOUND:ToGroup(Group, Delay)</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.Group.html">Wrapper.Group</a>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(USERSOUND).ToUnit">USERSOUND:ToUnit(Unit, Delay)</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">
@@ -2449,7 +2455,70 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<h2><strong>Usage:</strong></h2>
<pre class="example"><code> local BlueVictory = USERSOUND:New( "BlueVictory.ogg" )
local PlayerGroup = GROUP:FindByName( "PlayerGroup" ) -- Search for the active group named "PlayerGroup", that contains a human player.
BlueVictory:ToGroup( PlayerGroup ) -- Play the sound that Blue has won to the player group.
BlueVictory:ToGroup( PlayerGroup ) -- Play the victory sound to the player group.
</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(USERSOUND).ToUnit" ><strong>USERSOUND:ToUnit(Unit, Delay)</strong></a></h2>
</div>
<p>Play the usersound to the given <a href="Wrapper.Unit.html">Wrapper.Unit</a>.</p>
<div id= "#Functions##ToUnit" 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.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a>
<strong><strong>Unit</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The <a href="Wrapper.Unit.html">Wrapper.Unit</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>
<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 = UNIT:FindByName( "PlayerUnit" ) -- Search for the active group named "PlayerUnit", that contains a human player.
BlueVictory:ToUnit( PlayerUnit ) -- Play the victory sound to the player unit.
</code></pre>
</div>