Interface PositionalSoundPlaybackOptions

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

Properties

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

Properties

OptionalbaseEffect

baseEffect?: any

A base sound effect to apply to playback

Optionaleasing

easing?: boolean

Should volume be attenuated by distance?

OptionalgmAlways

gmAlways?: boolean

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

OptionalmuffledEffect

muffledEffect?: any

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

OptionalplaybackOptions

playbackOptions?: SoundPlaybackOptions

Additional options passed to Sound#play

OptionalsourceData

sourceData?: any

Additional data passed to the SoundSource constructor

Optionalvolume

volume?: number

The maximum volume at which the effect should be played

Optionalwalls

walls?: boolean

Should the sound be constrained by walls?

Settings

Member Visibility

On This Page

Properties