C_Sound.
functionimplementedavailable in: camelot
Plays a sound kit. Returns whether it played, and a handle to the sound. · description by wowlua
function C_Sound.PlaySound( soundKitID: number, uiSoundSubType: UISoundSubType, forceNoDuplicates: boolean, runFinishCallback: boolean, overridePriority: number?, volumeOverride: number?): (boolean?, SoundHandle?)Parameters
| name | type | description |
|---|---|---|
soundKitID | number | Sound Kit ID in . Sounds used in FrameXML are defined in the SOUNDKIT table. |
uiSoundSubType | UISoundSubType | Sound channel to play this file on. Default: "g_defaultSI3UISoundSubTypeForLua". |
forceNoDuplicates | boolean | Do not play the sound when it is already playing. Default: false. |
runFinishCallback | boolean | Fire SOUNDKIT_FINISHED when the sound ends. Default: false. |
overridePriority | number? | A priority that overrides the sound kit's own. |
volumeOverride | number? | A volume that overrides the sound kit's own. |
Returns
| # | name | type |
|---|---|---|
| 1 | success | boolean? |
| 2 | soundHandle | SoundHandle? |
Blizzard's documentation says it may return nothing.
In wowlua's emulated client
implementedwowlua models the system behind it. what the statuses mean
Restrictions
sources
Signature and flags: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (Sound system, camelot 1.60.1). Description: written by wowlua where no documentation describes the entry. Parameter and result notes: warcraft.wiki.gg's API pages ↗, by its contributors, CC BY-SA 4.0 ↗.