Difference between revisions of "ToggleSoundPause"
From The Official Visionaire Studio: Adventure Game Engine Wiki
| Line 1: | Line 1: | ||
| − | <div class="toccolours mw-collapsible mw-collapsed | + | <div class="toccolours mw-collapsible mw-collapsed tbl-ds"> |
| − | < | + | <span>Command History</span> |
<div class="mw-collapsible-content"> | <div class="mw-collapsible-content"> | ||
| − | <div | + | <div class="alt-bg">Available since v3.8</div> |
</div></div> | </div></div> | ||
| Line 29: | Line 29: | ||
| − | < | + | <span class="bold underline">Arguments</span> |
| − | < | + | <span class="bold">id</span>: integer (number) <br/> |
The id for the currently playing audio file! ("sound.id") | The id for the currently playing audio file! ("sound.id") | ||
| − | < | + | <span class="bold underline">Flags</span> |
none | none | ||
| − | < | + | <span class="bold underline>Return</span> |
| − | < | + | <span class="bold">success</span> <br/> |
Returns true or false boolean value depending on if the linked sound was successfully paused or resumed! | Returns true or false boolean value depending on if the linked sound was successfully paused or resumed! | ||
{{i18n|ToggleSoundPause}} <br/> | {{i18n|ToggleSoundPause}} <br/> | ||
| − | {| | + | {| class="tbl-ds" |
|- | |- | ||
| − | |< | + | |<span class="bold">Relevant Pages</span>: [[GetSoundId|getSoundId]] - [[GetSoundProperty|getSoundProperty]] - [[SetSoundProperty|setSoundProperty]] - [[StartSound|startSound]] - [[StopSound|stopSound]] |
|} | |} | ||
Revision as of 13:26, 5 April 2013
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!
|
日本語 – 正體中文 – 한국어 – Dansk – Deutsch – English – Español – Français – Italiano – Nederlands – Polski – Português – Svenska – Русский |
| Relevant Pages: getSoundId - getSoundProperty - setSoundProperty - startSound - stopSound |
