Script API - v1.26.40.20
    Preparing search index...

    Class SoundInstance

    Represents a handle to a sound that has been played. The handle is required to control the sound while it is playing (for example, to call stop, setVolume, setPitch, fade, or seekTo). Infinitely-looping sounds (started with loop: -1) stop automatically when the last SoundInstance reference is dropped; retain the handle for as long as the sound should keep playing.

    export class SoundInstance {
        private constructor();
        readonly durationInfo?: SoundDurationInfo;
        readonly id: string;
        readonly recipient?: Player;
        readonly soundEventId: string;
        fade(duration: number, targetVolume: number): void;
        pause(): void;
        resume(): void;
        seekTo(seconds: number): void;
        setPitch(pitch: number): void;
        setVolume(volume: number): void;
        stop(): void;
    }
    Index

    Constructors

    constructor

    Properties

    durationInfo? id recipient? soundEventId

    Methods

    fade pause resume seekTo setPitch setVolume stop

    Constructors

    Properties

    durationInfo?: SoundDurationInfo

    Gets duration and playback information for this sound.

    This property can't be read in early-execution mode.

    id: string

    Unique identifier of this sound instance.

    This property can't be read in early-execution mode.

    recipient?: Player

    Gets the player this sound was played for.

    This property can't be read in early-execution mode.

    soundEventId: string

    Gets the identifier of the sound event this instance was started with.

    This property can't be read in early-execution mode.

    Methods

    • Beta

      Parameters

      • duration: number

        Duration of the fade in seconds. Must be non-negative. Minimum value: 0

      • targetVolume: number

        Volume to fade to. Must be non-negative. Minimum value: 0

      Returns void

      Fades this sound instance from its current volume to the target volume over the specified duration. To fade in from silence, call setVolume(0.0) first; to fade out, pass a target volume of 0.0.

      This function can't be called in restricted-execution mode.

      This function can't be called in early-execution mode.

    • Beta

      Returns void

      Pauses this sound.

      This function can't be called in restricted-execution mode.

      This function can't be called in early-execution mode.

    • Beta

      Returns void

      Resumes this sound after a pause.

      This function can't be called in restricted-execution mode.

      This function can't be called in early-execution mode.

    • Beta

      Parameters

      • seconds: number

        Position to seek to in seconds. Must be non-negative. Minimum value: 0

      Returns void

      Sets the playback position of this sound instance.

      This function can't be called in restricted-execution mode.

      This function can't be called in early-execution mode.

    • Beta

      Parameters

      • pitch: number

        Pitch multiplier between 0.01 and 10.0. A value of 1.0 is normal pitch. Bounds: [0.009999999776482582, 10]

      Returns void

      Sets the pitch of this sound instance.

      This function can't be called in restricted-execution mode.

      This function can't be called in early-execution mode.

    • Beta

      Parameters

      • volume: number

        Volume level between 0.0 and 10.0. Bounds: [0, 10]

      Returns void

      Sets the volume of this sound instance.

      This function can't be called in restricted-execution mode.

      This function can't be called in early-execution mode.

    • Rc

      Returns void

      Stops this sound instance from playing.

      This function can't be called in restricted-execution mode.

      This function can't be called in early-execution mode.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods