# HG changeset patch # User Wuzzy # Date 1520600689 0 # Node ID 75747cc55f41ee021844f0e4de917e5cdd93a5e9 # Parent 141ed1f83d568a0d0f0faa6854fcd8544bb5cacf LuaAPI: Update PlaySound diff -r 141ed1f83d56 -r 75747cc55f41 LuaAPI.wiki --- a/LuaAPI.wiki Fri Mar 09 13:02:44 2018 +0000 +++ b/LuaAPI.wiki Fri Mar 09 13:04:49 2018 +0000 @@ -1320,9 +1320,9 @@ === `PlaySound(soundId, [gearUid [, instaVoice]])` === Plays the specified sound. Possible values for `soundId` are listed on the [Sounds] page. -If `gearUid` (optional argument) is set, you can also play a voice, see [Taunts] for a list. `gearUid` is the hedgehog gear which is used to “speak”. +To play a voice (see [Taunts] for a list], you must also set `gearUid`. `gearUid` is the hedgehog gear which is used to “talk”. -If you play a voice, by default the voice will respect an internal queue and might be played with an delay in order to prevent annoying voice overlapping. Since version 0.9.24, you can disable this behaviour and force Hedgewars to instantly play the voice by also setting `instaVoice` to `true`. +If you play a voice, by default the voice will respect an internal queue and might be played with an delay in order to prevent annoying voice overlapping. Since version 0.9.24, you can disable this behaviour and force Hedgewars to instantly play the voice by also setting `instaVoice` to `true`. Only use `instaVoice` when you really need it. === `SetSoundMask(soundId, isMasked)` (0.9.24) === Disables a given sound (including taunts) from being played by the engine. `soundId` is a valid sound ID on [Sounds] or [Taunts]. `isMasked` is a boolean. If `true`, the sound will not be played by the engine anymore. If `false`, playing this sound is allowed again.