View source

class SoundMessages

package defold

import defold.Sound

@:publicFields
  • Messages related to the Sound module.

Static variables

@:value(new Message<SoundMessagePlaySound>("play_sound"))staticread onlyplay_sound:Message<SoundMessagePlaySound> = new Message<SoundMessagePlaySound>("play_sound")

  • Plays a sound.

Post this message to a sound-component to make it play its sound. Multiple voices is supported. The limit is set to 32 voices per sound component.

@:value(new Message<SoundMessageSetGain>("set_gain"))staticread onlyset_gain:Message<SoundMessageSetGain> = new Message<SoundMessageSetGain>("set_gain")

  • Set sound gain.

Post this message to a sound-component to set gain on all active playing voices.

@:value(new Message<SoundMessageSoundDone>("sound_done"))staticread onlysound_done:Message<SoundMessageSoundDone> = new Message<SoundMessageSoundDone>("sound_done")

  • This message is sent back to the sender of a play_sound message, if the sound could be played to completion.

@:value(new Message<SoundMessageSoundStopped>("sound_stopped"))staticread onlysound_stopped:Message<SoundMessageSoundStopped> = new Message<SoundMessageSoundStopped>("sound_stopped")

  • This message is sent back to the sender of a play_sound message, if the sound has been manually stopped.

@:value(new Message<Void>("stop_sound"))staticread onlystop_sound:Message<Void> = new Message<Void>("stop_sound")

  • Stop a playing a sound(s).

Post this message to a sound-component to make it stop playing all active voices