User Tools

Site Tools


stop_music

Stop Music


Stops any music that's currently playing. An optional fade out (in seconds) can be specified.

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 fade out the current map's default music before a cutscene starts in preparation for different music that will play during the cutscene.


Editor Node:

stop_music.txt · Last modified: 2024/02/02 13:18 by justin