RPG in a Box
Official Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

======Stop Sound======
----
Stops an actively playing [[sound|sound effect]]. A sound's unique ID is returned from the [[Play Sound]] function. The second parameter is optional and will fade out the [[sound|sound effect]] over the specified amount of time.

====Signature:====
<code python>
stop_sound(sound_id, fade_out_length)
</code>

^Argument^Description^Type^Required^
|sound_id|Unique ID of the [[sound|sound effect]] to stop (numeric value returned from the [[Play Sound]] function).|[[Number]]|Yes|
|fade_out_length|Length of time over which to fade out (in seconds).|[[Number]]|No|

====Example:====
<code bauxite>
stop_sound(global.property["alarm_id"], 2);
</code>
//Results:// The [[sound|sound effect]] with unique ID equal to that of the value stored in the "alarm_id" [[global_properties|global property]] will be faded out over a duration of two seconds.

<WRAP center round tip 100%>
Use the **Stop Sound** function to stop a looping [[sound]] that was previously triggered, for example to stop a warning alarm from going off when the player interacts with a security computer.
</WRAP>

----

<WRAP group>
<WRAP half column>
====Editor Node:====
{{:stop_sound_node.png?nolink|}}
</WRAP>

<WRAP half column>
</WRAP>
</WRAP>

~~NOTOC~~

RPG in a BoxOfficial Documentation

User Tools

Site Tools

Page Tools

RPG in a Box
Official Documentation