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

    Interface _VFXPositionalSoundData

    interface _VFXPositionalSoundData {
        angle?: number;
        baseEffect?: { intensity: number; type: string } | null;
        channel: string;
        duration?: number;
        elevation: number;
        fade: number;
        gmAlways: boolean;
        muffledEffect?: { intensity: number; type: string } | null;
        rotation?: number;
        x: number;
        y: number;
    }
    Index

    Properties

    angle? baseEffect? channel duration? elevation fade gmAlways muffledEffect? rotation? x y

    Properties

    angle?: number

    The angle of the sound cone in degrees

    baseEffect?: { intensity: number; type: string } | null

    Audio effect applied when the sound is not muffled

    channel: string

    Audio channel for playback (default "environment")

    duration?: number

    Component duration in milliseconds; defaults to the sound's natural duration

    elevation: number

    The elevation of the sound origin

    fade: number

    Fade-in duration in milliseconds (default 0)

    gmAlways: boolean

    Whether the GM always hears the sound regardless of position (default true)

    muffledEffect?: { intensity: number; type: string } | null

    Audio effect applied when the sound is muffled

    rotation?: number

    The direction of sound emission in degrees

    x: number

    The x coordinate of the sound origin

    y: number

    The y coordinate of the sound origin

    Settings

    Member Visibility

    On This Page

    Properties