This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
stop_sound [2024/01/31 23:52] – created justin | stop_sound [2024/02/01 14:01] (current) – justin | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ======Add Item To Tile====== | + | ======Stop Sound====== |
---- | ---- | ||
- | (WIP) | + | Stops an actively playing [[sound|sound effect]]. A sound' |
====Signature: | ====Signature: | ||
Line 9: | Line 9: | ||
^Argument^Description^Type^Required^ | ^Argument^Description^Type^Required^ | ||
- | |sound_id| |[[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 16: | Line 16: | ||
stop_sound(global.property[" | stop_sound(global.property[" | ||
</ | </ | ||
- | // | + | // |
<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 warning alarm from going off when the player interacts with a security computer. |
</ | </ | ||