User Tools

Site Tools


stop_sound

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
Last revisionBoth sides next revision
stop_sound [2024/02/01 13:44] justinstop_sound [2024/02/01 14:00] justin
Line 9: Line 9:
  
 ^Argument^Description^Type^Required^ ^Argument^Description^Type^Required^
-|sound_id|Unique ID of the [[sound|sound effect]] to stop (value returned from the [[Play Sound]] function).|[[Number]]|Yes| +|sound_id|Unique ID of the [[sound|sound effect]] to stop (numeric value returned from the [[Play Sound]] function).|[[Number]]|Yes| 
-|fade_out_length| |[[Number]]|No|+|fade_out_length|Length of time over which to fade out (in seconds).|[[Number]]|No|
  
 ====Example:==== ====Example:====
Line 19: Line 19:
  
 <WRAP center round tip 100%> <WRAP center round tip 100%>
-Use the **Stop Sound** function to...+Use the **Stop Sound** function to stop a looping [[sound]] that was previously triggered, for example to stop a security alarm from going off when the player interacts with a computer.
 </WRAP> </WRAP>
  
stop_sound.txt · Last modified: 2024/02/01 14:01 by justin