BaseAmbientSound | Foundry Virtual Tabletop - API Documentation

The Document definition for an AmbientSound. Defines the DataSchema and common behaviors for an AmbientSound which are shared between both client and server.

mixes: AmbientSoundData
memberof: documents
param data: Initial data from which to construct the AmbientSound
param context: Construction context options

Hierarchy

Document
- BaseAmbientSound

Index

Constructors

constructor

Properties

metadata

Methods

Constructors

constructor

new BaseAmbientSound(): BaseAmbientSound

Inherited from Document.constructor
Returns BaseAmbientSound

Properties

Static metadata

metadata: any = ...

Default metadata which applies to each instance of this Document type.

Methods

Static defineSchema

defineSchema(): { _id: DocumentIdField; x: NumberField; y: NumberField; radius: NumberField; path: FilePathField; repeat: BooleanField; volume: AlphaField; walls: BooleanField; easing: BooleanField; hidden: BooleanField; darkness: SchemaField; flags: ObjectField }

inheritdoc
Returns { _id: DocumentIdField; x: NumberField; y: NumberField; radius: NumberField; path: FilePathField; repeat: BooleanField; volume: AlphaField; walls: BooleanField; easing: BooleanField; hidden: BooleanField; darkness: SchemaField; flags: ObjectField }
- _id: DocumentIdField
- x: NumberField
- y: NumberField
- radius: NumberField
- path: FilePathField
- repeat: BooleanField
- volume: AlphaField
- walls: BooleanField
- easing: BooleanField
- hidden: BooleanField
- darkness: SchemaField
- flags: ObjectField

Static migrateData

migrateData(data: any): any

inheritdoc
Parameters
- data: any
Returns any

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns BaseAmbientSound

Properties

Static metadata

Methods

Static defineSchema

Returns { _id: DocumentIdField; x: NumberField; y: NumberField; radius: NumberField; path: FilePathField; repeat: BooleanField; volume: AlphaField; walls: BooleanField; easing: BooleanField; hidden: BooleanField; darkness: SchemaField; flags: ObjectField }

_id: DocumentIdField

x: NumberField

y: NumberField

radius: NumberField

path: FilePathField

repeat: BooleanField

volume: AlphaField

walls: BooleanField

easing: BooleanField

hidden: BooleanField

darkness: SchemaField

flags: ObjectField

Static migrateData

Parameters

data: any

Returns any