https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3APlaySoundAPI:PlaySound - Revision history2026-10-17T16:13:09ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:PlaySound&diff=30633&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:47:39Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Game}}<br />
Plays a sound effect by ID.<br />
<br />
<pre><br />
PlaySound(soundId)<br />
</pre><br />
<br />
== Arguments ==<br />
;soundId : <code>number</code> – ID of the sound. The stock UI uses the <code>GameData.Sound</code> values (through the <code>Sound</code> constants in <code>soundutils.lua</code>).<br />
<br />
== Returns ==<br />
Nothing.<br />
<br />
== Details ==<br />
* The sound is played as an interface sound, not at a position in the world.<br />
* Nothing is played if the client's sound system is turned off or not ready. The client also skips the sound when one of its audio state flags is set or during one particular game state.<br />
* Exactly one argument must be passed. A fractional ID is cut toward zero.<br />
<br />
== Errors ==<br />
None besides the generic ''Invalid Parameters'' message when the argument is missing or not a number.<br />
<br />
== Example ==<br />
<code>Sound.Play</code> from <code>default/easystem_utils/source/soundutils.lua</code>:<br />
<pre><br />
if( id ~= nil ) then<br />
PlaySound( id )<br />
else<br />
DEBUG( L"EASystem_Utils//Source//SoundUtils.lua: Sound.Play() called with nil ID (maybe a type-o in constant name)" )<br />
</pre><br />
<br />
== See also ==<br />
* [[API:TakeScreenShot|TakeScreenShot]]</div>Maintenance script