ToggleSoundPause

Command History

Available since v3.8

Allows you to stop any playing sound files!

Syntax:

stopSound(id)

Example 1: basic toggle pause/resume audio file method! (!messy)

toggleSoundPause(getSoundId("sounds/example.ogg"))

Example 2: again using sound.id via a variable!

-- let's store the sound.id for example.ogg inside of a variable!
local soundID = getSoundId("sounds/example.ogg")
toggleSoundPause(soundID)

Arguments

id: integer (number)
The id for the currently playing audio file! ("sound.id")

Flags

none

Return

success Returns true or false boolean value depending on if the linked sound was successfully paused or resumed!

---

日本語 – 正體中文 – 한국어 – Dansk – Deutsch – English – Español – Français – Italiano – Nederlands – Polski – Português – Svenska – Русский

Relevant Pages: getSoundId - getSoundProperty - setSoundProperty - startSound - stopSound