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

    Interface AmbientSoundData

    interface AmbientSoundData {
        _id: string | null;
        darkness: { max: number; min: number };
        easing: boolean;
        effects: { base: AmbientSoundEffect; muffled: AmbientSoundEffect };
        elevation?: number;
        flags: DocumentFlags;
        hidden: boolean;
        name?: string;
        path: string;
        radius: number;
        repeat?: boolean;
        volume?: number;
        walls: boolean;
        x: number;
        y: number;
    }
    Index

    Properties

    _id darkness easing effects elevation? flags hidden name? path radius repeat? volume? walls x y

    Properties

    _id

    _id: string | null

    The _id which uniquely identifies this AmbientSound document

    darkness: { max: number; min: number }

    A darkness range (min and max) for which the source should be active

    easing: boolean

    Whether to adjust the volume of the sound heard by the listener based on how close the listener is to the center of the sound source. True by default.

    effects: { base: AmbientSoundEffect; muffled: AmbientSoundEffect }

    Special effects to apply to the sound

    elevation?: number

    The elevation

    flags: DocumentFlags

    An object of optional key/value flags

    hidden: boolean

    Is the sound source currently hidden? False by default.

    name?: string

    An optional name.

    path: string

    The audio file path that is played by this sound

    radius: number

    The radius of the emitted sound.

    repeat?: boolean

    Does this sound loop?

    volume?: number

    The audio volume of the sound, from 0 to 1

    walls: boolean

    Whether or not this sound source is constrained by Walls and surfaces. True by default.

    x: number

    The x-coordinate position of the origin of the sound.

    y: number

    The y-coordinate position of the origin of the sound.

    Settings

    Member Visibility

    On This Page

    Properties