BaseTile | Foundry Virtual Tabletop - API Documentation

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

mixes: TileData
memberof: documents
param data: Initial data from which to construct the Tile
param context: Construction context options

Hierarchy

Document
- BaseTile

Index

Constructors

constructor

Properties

metadata

Methods

Constructors

constructor

new BaseTile(): BaseTile

Inherited from Document.constructor
Returns BaseTile

Properties

Static metadata

metadata: any = ...

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

Methods

Static defineSchema

defineSchema(): { _id: DocumentIdField; texture: TextureData; width: NumberField; height: NumberField; x: NumberField; y: NumberField; z: NumberField; rotation: AngleField; alpha: AlphaField; hidden: BooleanField; locked: BooleanField; overhead: BooleanField; roof: BooleanField; occlusion: SchemaField; video: SchemaField; flags: ObjectField }

inheritdoc
Returns { _id: DocumentIdField; texture: TextureData; width: NumberField; height: NumberField; x: NumberField; y: NumberField; z: NumberField; rotation: AngleField; alpha: AlphaField; hidden: BooleanField; locked: BooleanField; overhead: BooleanField; roof: BooleanField; occlusion: SchemaField; video: SchemaField; flags: ObjectField }
- _id: DocumentIdField
- texture: TextureData
- width: NumberField
- height: NumberField
- x: NumberField
- y: NumberField
- z: NumberField
- rotation: AngleField
- alpha: AlphaField
- hidden: BooleanField
- locked: BooleanField
- overhead: BooleanField
- roof: BooleanField
- occlusion: SchemaField
- video: SchemaField
- flags: ObjectField

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 BaseTile

Properties

Static metadata

Methods

Static defineSchema

_id: DocumentIdField

texture: TextureData

width: NumberField

height: NumberField

x: NumberField

y: NumberField

z: NumberField

rotation: AngleField

alpha: AlphaField

hidden: BooleanField

locked: BooleanField

overhead: BooleanField

roof: BooleanField

occlusion: SchemaField

video: SchemaField

flags: ObjectField

Static migrateData

Parameters

data: any

Returns any

Static shimData

Parameters

data: any

options: any

Returns any