Difference between revisions of "GetSoundId"
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 class="bold">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 23: | Line 23: | ||
| − | < | + | <span class="bold underline">Arguments</span> |
| − | < | + | <span class="bold">filename</span>: path <br/> |
The path to the audio file whose ID we want to obtain! ("path/filename.type") | The path to the audio file whose ID we want to obtain! ("path/filename.type") | ||
| − | < | + | <span class="bold underline">Flags</span> |
none | none | ||
| − | < | + | <span class="bold underline">Return</span> |
| − | < | + | <span class="bold">id</span> <br/> |
Returns the sound ID as an integer value. | Returns the sound ID as an integer value. | ||
{{i18n|GetSoundId}} <br/> | {{i18n|GetSoundId}} <br/> | ||
| − | {| | + | {| class="tbl-ds" |
|- | |- | ||
| − | |< | + | |<span class="bold">Relevant Pages</span>: [[GetSoundProperty|getSoundProperty]] - [[SetSoundProperty|setSoundProperty]] - [[StartSound|startSound]] - [[StopSound|stopSound]] - [[ToggleSoundPause|toggleSoundPause]] |
|} | |} | ||
Revision as of 17:45, 2 April 2013
Command History
Available since v3.8
Use this to store the sound.id for an audio file into a variable; which you can use to stop/pause/resume or edit the linked sounds properties!
Syntax:
getSoundId("filename")
-- let's store the sound ID into a variable for later use!
local soundID = getSoundId("sounds/example.ogg")
Arguments
filename: path
The path to the audio file whose ID we want to obtain! ("path/filename.type")
Flags
none
Return
id
Returns the sound ID as an integer value.
|
日本語 – 正體中文 – 한국어 – Dansk – Deutsch – English – Español – Français – Italiano – Nederlands – Polski – Português – Svenska – Русский |
| Relevant Pages: getSoundProperty - setSoundProperty - startSound - stopSound - toggleSoundPause |
