BaseScene | Foundry Virtual Tabletop - API Documentation

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

mixes: SceneData
memberof: documents
param data: Initial data from which to construct the Scene
param context: Construction context options

Hierarchy

Document
- BaseScene

Index

Constructors

constructor

Properties

metadata

Methods

Constructors

constructor

new BaseScene(): BaseScene

Inherited from Document.constructor
Returns BaseScene

Properties

Static metadata

metadata: any = ...

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

Methods

Static defineSchema

defineSchema(): { _id: DocumentIdField; name: StringField; active: BooleanField; navigation: BooleanField; navOrder: NumberField; navName: HTMLField; background: TextureData; foreground: FilePathField; foregroundElevation: NumberField; thumb: FilePathField; width: NumberField; height: NumberField; padding: NumberField; initial: SchemaField; backgroundColor: ColorField; grid: SchemaField; tokenVision: BooleanField; fogExploration: BooleanField; fogReset: NumberField; globalLight: BooleanField; globalLightThreshold: AlphaField; darkness: AlphaField; fogOverlay: FilePathField; fogExploredColor: ColorField; fogUnexploredColor: ColorField; drawings: EmbeddedCollectionField; tokens: EmbeddedCollectionField; lights: EmbeddedCollectionField; notes: EmbeddedCollectionField; sounds: EmbeddedCollectionField; templates: EmbeddedCollectionField; tiles: EmbeddedCollectionField; walls: EmbeddedCollectionField; playlist: ForeignDocumentField; playlistSound: ForeignDocumentField; journal: ForeignDocumentField; journalEntryPage: ForeignDocumentField; weather: StringField; folder: ForeignDocumentField; sort: IntegerSortField; ownership: DocumentOwnershipField; flags: ObjectField; _stats: DocumentStatsField }

inheritdoc
Returns { _id: DocumentIdField; name: StringField; active: BooleanField; navigation: BooleanField; navOrder: NumberField; navName: HTMLField; background: TextureData; foreground: FilePathField; foregroundElevation: NumberField; thumb: FilePathField; width: NumberField; height: NumberField; padding: NumberField; initial: SchemaField; backgroundColor: ColorField; grid: SchemaField; tokenVision: BooleanField; fogExploration: BooleanField; fogReset: NumberField; globalLight: BooleanField; globalLightThreshold: AlphaField; darkness: AlphaField; fogOverlay: FilePathField; fogExploredColor: ColorField; fogUnexploredColor: ColorField; drawings: EmbeddedCollectionField; tokens: EmbeddedCollectionField; lights: EmbeddedCollectionField; notes: EmbeddedCollectionField; sounds: EmbeddedCollectionField; templates: EmbeddedCollectionField; tiles: EmbeddedCollectionField; walls: EmbeddedCollectionField; playlist: ForeignDocumentField; playlistSound: ForeignDocumentField; journal: ForeignDocumentField; journalEntryPage: ForeignDocumentField; weather: StringField; folder: ForeignDocumentField; sort: IntegerSortField; ownership: DocumentOwnershipField; flags: ObjectField; _stats: DocumentStatsField }
- _id: DocumentIdField
- name: StringField
- active: BooleanField
- navigation: BooleanField
- navOrder: NumberField
- navName: HTMLField
- background: TextureData
- foreground: FilePathField
- foregroundElevation: NumberField
- thumb: FilePathField
- width: NumberField
- height: NumberField
- padding: NumberField
- initial: SchemaField
- backgroundColor: ColorField
- grid: SchemaField
- tokenVision: BooleanField
- fogExploration: BooleanField
- fogReset: NumberField
- globalLight: BooleanField
- globalLightThreshold: AlphaField
- darkness: AlphaField
- fogOverlay: FilePathField
- fogExploredColor: ColorField
- fogUnexploredColor: ColorField
- drawings: EmbeddedCollectionField
- tokens: EmbeddedCollectionField
- lights: EmbeddedCollectionField
- notes: EmbeddedCollectionField
- sounds: EmbeddedCollectionField
- templates: EmbeddedCollectionField
- tiles: EmbeddedCollectionField
- walls: EmbeddedCollectionField
- playlist: ForeignDocumentField
- playlistSound: ForeignDocumentField
- journal: ForeignDocumentField
- journalEntryPage: ForeignDocumentField
- weather: StringField
- folder: ForeignDocumentField
- sort: IntegerSortField
- ownership: DocumentOwnershipField
- flags: ObjectField
- _stats: DocumentStatsField

Static migrateData

migrateData(data: any): any

inheritdoc
Parameters
- data: any
Returns any

Static shimData

shimData(data: any, options: any): any

inheritdoc
Parameters
- data: any
- options: any
Returns any

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns BaseScene

Properties

Static metadata

Methods

Static defineSchema

_id: DocumentIdField

name: StringField

active: BooleanField

navigation: BooleanField

navOrder: NumberField

navName: HTMLField

background: TextureData

foreground: FilePathField

foregroundElevation: NumberField

thumb: FilePathField

width: NumberField

height: NumberField

padding: NumberField

initial: SchemaField

backgroundColor: ColorField

grid: SchemaField

tokenVision: BooleanField

fogExploration: BooleanField

fogReset: NumberField

globalLight: BooleanField

globalLightThreshold: AlphaField

darkness: AlphaField

fogOverlay: FilePathField

fogExploredColor: ColorField

fogUnexploredColor: ColorField

drawings: EmbeddedCollectionField

tokens: EmbeddedCollectionField

lights: EmbeddedCollectionField

notes: EmbeddedCollectionField

sounds: EmbeddedCollectionField

templates: EmbeddedCollectionField

tiles: EmbeddedCollectionField

walls: EmbeddedCollectionField

playlist: ForeignDocumentField

playlistSound: ForeignDocumentField

journal: ForeignDocumentField

journalEntryPage: ForeignDocumentField

weather: StringField

folder: ForeignDocumentField

sort: IntegerSortField

ownership: DocumentOwnershipField

flags: ObjectField

_stats: DocumentStatsField

Static migrateData

Parameters

data: any

Returns any

Static shimData

Parameters

data: any

options: any

Returns any