ToggleSoundPause

From The Official Visionaire Studio: Adventure Game Engine Wiki
Revision as of 14:26, 5 April 2013 by AFRLme (talk)

Command History

Available since v3.8


Allows you to toggle between pause & resume of an active linked sound!


Syntax:

toggleSoundPause(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!


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