LuaAPI: PlayMusicSound, StopMusicSound
Fri, 26 Oct 2018 16:14:01 +0100
changeset 1592 9d79881c31b1
parent 1591 a2986bfc8764
child 1593 fb9756c246e5
LuaAPI: PlayMusicSound, StopMusicSound
--- a/	Fri Oct 26 15:46:12 2018 +0100
+++ b/	Fri Oct 26 16:14:01 2018 +0100
@@ -1470,6 +1470,17 @@
 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.
+=== `PlayMusicSound(soundId)` (0.9.25)` ===
+Plays a sound as replacement for the background music. The sound is played once. The main music is paused and the sound is played instead. The main background music does not resume automatically, so you should call `StopMusicSound` after a while.
+<code language="lua">
+PlayMusicSound(sndRideOfTheValkyries) -- Replace the background music the Ride of the Valkyries
+=== `StopMusicSound(soundId)` (0.9.25)` ===
+Stops the specified “music sound” (if it was still playing) and resumes the main background music.
 === `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.