Difference between revisions of "ToggleSoundPause"

From The Official Visionaire Studio: Adventure Game Engine Wiki
Line 1: Line 1:
 
==toggleSoundPause==
 
==toggleSoundPause==
  
<div class="command-min-version-info">Available since: <span class="command-min-version">v3.8</span></div>
+
<div class="command-min-version-info">Available since: <span class="command-min-version">v4.0</span></div>
  
 
<div class="command-doc">Pause/resume the specified sound.</div>
 
<div class="command-doc">Pause/resume the specified sound.</div>
Line 20: Line 20:
 
toggleSoundPause(soundID)
 
toggleSoundPause(soundID)
 
</syntaxhighlight>
 
</syntaxhighlight>
[[Category:Player Commands]]
 

Revision as of 21:28, 30 September 2014

toggleSoundPause

Available since: v4.0
Pause/resume the specified sound.

Lua Syntax:

toggleSoundPause(soundID)

Arguments

soundID

int - ID of sound which should be paused/resumed.

Flags

Return Values

status
True if sound was successfully paused/resumed, false otherwise.

Examples

Example 1:

local soundID = getSoundId('vispath:sounds/example.ogg')
toggleSoundPause(soundID)