This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
play_sound [2024/01/31 22:11] – justin | play_sound [2024/01/31 22:20] (current) – justin | ||
---|---|---|---|
Line 2: | Line 2: | ||
---- | ---- | ||
- | Plays the specified [[sound|sound effect]]. If set to loop, the [[sound|sound effect]] will continue to play at the given interval of time (e.g. once per second) until stopped via the [[Stop Sound]] function. | + | Plays the specified [[sound|sound effect]]. If the optional loop argument is set to true, the [[sound|sound effect]] will continue to play at the given interval of time (e.g. once per second) until stopped via the [[Stop Sound]] function. |
====Signature: | ====Signature: | ||
Line 12: | Line 12: | ||
|sound_name|Name of the [[sound|sound effect]] to play.|[[String]]|Yes| | |sound_name|Name of the [[sound|sound effect]] to play.|[[String]]|Yes| | ||
|loop|Whether or not the [[sound|sound effect]] will loop or play only once. When true, it will loop until stopped via the [[Stop Sound]] function.|[[Boolean]]|No| | |loop|Whether or not the [[sound|sound effect]] will loop or play only once. When true, it will loop until stopped via the [[Stop Sound]] function.|[[Boolean]]|No| | ||
- | |interval|Interval of time to wait between each playing of the [[sound|sound effect]] (only applicable when the "loop" | + | |interval|Interval of time in seconds |
^Return Value^Description^Type^ | ^Return Value^Description^Type^ |