Interface ISound

An abstract representation of a sound

We use ISound so that the rest of JetLag doesn't need to know about Howler, but an ISound is really just a Howl object.

TODO: pause() is a reasonable choice for background music, but sound effects don't currently pause when a pause screen is showing.

interface ISound {
    pause(id?): void;
    play(): number;
    playing(id?): boolean;
    stop(id?): void;
}

Methods

pause play playing stop

Methods

pause

  • pause(id?): void

  • Pause the sound, so we can resume it later

    Parameters

    • Optional id: number

    Returns void

play

  • play(): number

  • Play the sound

    Returns number

playing

  • playing(id?): boolean

  • Report if the sound is currently playing

    Parameters

    • Optional id: number

    Returns boolean

stop

  • stop(id?): void

  • Stop playing the sound

    Parameters

    • Optional id: number

    Returns void

Settings

Member Visibility

Theme

On This Page