User Tools

Site Tools


stop_music

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
stop_music [2024/02/02 13:04] justinstop_music [2024/02/02 13:18] (current) justin
Line 1: Line 1:
 ======Stop Music====== ======Stop Music======
 ---- ----
-Stops an actively playing [[sound|sound effect]]. A sound'unique ID is returned from the [[Play Sound]] functionThe second parameter is optional and will fade out the [[sound|sound effect]] over the specified amount of time.+Stops any [[music]] that'currently playingAn optional fade out (in seconds) can be specified.
  
 ====Signature:==== ====Signature:====
Line 15: Line 15:
 stop_music(5); stop_music(5);
 </code> </code>
-//Results:// The music will be faded out over a duration of five seconds.+//Results:// The [[music]] will be faded out over a duration of five seconds.
  
 <WRAP center round tip 100%> <WRAP center round tip 100%>
-Use the **Stop Music** function to stop .+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>
  
stop_music.1706907881.txt.gz · Last modified: 2024/02/02 13:04 by justin