Differences

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

--- stop_sound [2024/02/01 13:20] – justin
+++ stop_sound [2024/02/01 14:01] (current) – justin
@@ Line 9: / Line 9: @@
 ^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:====
@@ Line 16: / Line 16: @@
 stop_sound(global.property["alarm_id"], 2);
 </code>
-//Results:// The [[sound|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.
+//Results:// The [[sound|sound effect]] with unique ID equal to that of the value stored in the "alarm_id" [[global_properties|global property]] will be faded out over a duration of two seconds.
 <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.
 </WRAP>

RPG in a BoxOfficial Documentation