rednode API - v0.50.0
    Preparing search index...

    Interface PlayOptions

    Settings for audio.play. They override the ones in the manifest.

    interface PlayOptions {
        category?: SoundCategory;
        delay?: number;
        end?: number;
        fadeIn?: number;
        loop?: boolean;
        pan?: number;
        pauseInMenu?: boolean;
        rate?: number;
        semitones?: number;
        start?: number;
        stream?: boolean;
        volume?: number;
    }
    Index
    category? delay? end? fadeIn? loop? pan? pauseInMenu? rate? semitones? start? stream? volume?
    category?: SoundCategory

    The slider it follows. Default "sfx".

    delay?: number

    Wait this many milliseconds before starting.

    end?: number

    Stop, or loop back, this many seconds into the file. Default: the file's end.

    fadeIn?: number

    Fade in over this many milliseconds.

    loop?: boolean

    Repeat from start to end until stopped. Default false.

    pan?: number

    Stereo position, -1 left to 1 right. Default 0.

    pauseInMenu?: boolean

    Pause while a game menu is open. Default true.

    rate?: number

    Playback speed: 2 plays twice as fast and an octave higher. Default 1.

    semitones?: number

    Pitch shift in semitones, as a speed: 12 is rate: 2. Combines with rate.

    start?: number

    Start this many seconds into the file. A loop repeats from here.

    stream?: boolean

    Read the file as it plays instead of loading it first. Default true for music, false otherwise.

    volume?: number

    Volume, 1 as recorded. Default 1.

    Settings
    Member Visibility

    On This Page
    Properties