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 Music======
----
Stops any [[music]] that's currently playing. An optional fade out (in seconds) can be specified.

====Signature:====
<code python>
stop_music(fade_out_length)
</code>

^Argument^Description^Type^Required^
|fade_out_length|Length of time over which to fade out (in seconds).|[[Number]]|No|

====Example:====
<code bauxite>
stop_music(5);
</code>
//Results:// The [[music]] will be faded out over a duration of five seconds.

<WRAP center round tip 100%>
Use the **Stop Music** function to fade out the current [[map|map's]] default [[music]] before a cutscene starts in preparation for different [[music]] that will play during the cutscene.
</WRAP>

----

<WRAP group>
<WRAP half column>
====Editor Node:====
{{:stop_music_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