User Tools

Site Tools


stop_music

This is an old revision of the document!


Stop Music


Stops an actively playing 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 effect over the specified amount of time.

Signature:

stop_music(fade_out_length)
ArgumentDescriptionTypeRequired
fade_out_lengthLength of time over which to fade out (in seconds).NumberNo

Example:

stop_music(5);

Results: The music will be faded out over a duration of five seconds.

Use the Stop Music function to stop .


Editor Node:

stop_music.1706907881.txt.gz · Last modified: 2024/02/02 13:04 by justin