Stop Sound
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_sound(sound_id, fade_out_length)
| Argument | Description | Type | Required |
|---|---|---|---|
| sound_id | Unique ID of the sound effect to stop (numeric value returned from the Play Sound function). | Number | Yes |
| fade_out_length | Length of time over which to fade out (in seconds). | Number | No |
Example:
stop_sound(global.property["alarm_id"], 2);
Results: The sound effect with unique ID equal to that of the value stored in the “alarm_id” global property will be faded out over a duration of two seconds.
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.
Editor Node:
