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();
        stop(): void;
    }
    Index

    Constructors

    constructor

    Methods

    stop

    Constructors

    Methods

    • 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
    Methods