Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    Interface PositionalSoundPlaybackOptions

    interface PositionalSoundPlaybackOptions {
        baseEffect?: any;
        easing?: boolean;
        gmAlways?: boolean;
        muffledEffect?: any;
        playbackOptions?: SoundPlaybackOptions;
        sourceData?: any;
        volume?: number;
        walls?: boolean;
    }
    Index

    Properties

    baseEffect? easing? gmAlways? muffledEffect? playbackOptions? sourceData? volume? walls?

    Properties

    baseEffect?: any

    A base sound effect to apply to playback

    easing?: boolean

    Should volume be attenuated by distance?

    gmAlways?: boolean

    Should the sound always be played for GM users regardless of actively controlled tokens?

    muffledEffect?: any

    A muffled sound effect to apply to playback, a sound may only be muffled if it is not constrained by walls and surfaces

    playbackOptions?: SoundPlaybackOptions

    Additional options passed to Sound#play

    sourceData?: any

    Additional data passed to the SoundSource constructor

    volume?: number

    The maximum volume at which the effect should be played

    walls?: boolean

    Should the sound be constrained by walls and surfaces?

    Settings

    Member Visibility

    On This Page

    Properties