gameforge - v0.1.27
    Preparing search index...

    Interface PlayOptions

    Options used for sound playback.

    interface PlayOptions {
        complete?: CompleteCallback;
        end?: number;
        filters?: PixiSound.Filter[];
        loaded?: LoadedCallback;
        loop?: boolean;
        muted?: boolean;
        singleInstance?: boolean;
        speed?: number;
        sprite?: string;
        start?: number;
        volume?: number;
    }
    Index

    Properties

    complete? end? filters? loaded? loop? muted? singleInstance? speed? sprite? start? volume?

    Properties

    complete?: CompleteCallback

    When completed.

    end?: number

    End time in seconds.

    filters?: PixiSound.Filter[]

    Filters that apply to play. Only supported with WebAudio.

    loaded?: LoadedCallback

    If not already preloaded, callback when finishes load.

    loop?: boolean

    Override default loop, default to the Sound's loop setting.

    muted?: boolean

    If sound instance is muted by default.

    false
    singleInstance?: boolean

    Setting true will stop any playing instances. This is the same as the singleInstance property on Sound, but is play-specific.

    speed?: number

    Override default speed, default to the Sound's speed setting.

    sprite?: string

    The sprite to play.

    start?: number

    Start time offset in seconds.

    0
    volume?: number

    Override default volume, default to the Sound's volume setting.

    Settings

    Member Visibility

    On This Page

    Properties