BaseScene

documents. BaseScene

The base Scene model definition which defines common behavior of an Scene document between both client and server.

Constructor

new BaseScene()

Properties:
Name Type Description
data data.SceneData

The constructed data object for the document.

Extends

  • Document

Members

(static) metadata

(static) schema

drawings

A reference to the Collection of Drawing instances in the Scene document, indexed by _id.

lights

A reference to the Collection of AmbientLight instances in the Scene document, indexed by _id.

notes

A reference to the Collection of Note instances in the Scene document, indexed by _id.

sounds

A reference to the Collection of AmbientSound instances in the Scene document, indexed by _id.

templates

A reference to the Collection of MeasuredTemplate instances in the Scene document, indexed by _id.

tiles

A reference to the Collection of Tile instances in the Scene document, indexed by _id.

tokens

A reference to the Collection of Token instances in the Scene document, indexed by _id.

walls

A reference to the Collection of Wall instances in the Scene document, indexed by _id.

Methods

(static) getDimensions() → {object}

Get the Canvas dimensions which would be used to display this Scene. Apply padding to enlarge the playable space and round to the nearest 2x grid size to ensure symmetry.

Returns:

An object describing the configured dimensions

Type
object