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

    Interface WorldSoundOptions

    Contains additional options for a playSound occurrence.

    interface WorldSoundOptions {
        loopCount?: number;
        pitch?: number;
        volume?: number;
    }
    Index

    Properties

    loopCount? pitch? volume?

    Properties

    loopCount?: number

    Number of additional times to repeat the sound after the initial play. 0 (the default) plays the sound once, -1 loops it forever, and a positive integer N plays the sound N + 1 times in total. For example, loopCount: 1 plays the sound twice. The loop count is fixed when the sound starts and cannot be changed afterward. When using -1, see SoundInstance for handle lifetime requirements.

    pitch?: number

    Pitch of the sound played.

    volume?: number

    Relative volume and space by which this sound is heard.

    Settings

    Member Visibility

    On This Page

    Properties