AmbientLightData

data. AmbientLightData

The data schema for a AmbientLight embedded document.

Constructor

new AmbientLightData(data, documentopt)

See:
  • BaseAmbientLight
Properties:
Name Type Attributes Default Description
_id string

The _id which uniquely identifies this BaseAmbientLight embedded document

x number <optional>
0

The x-coordinate position of the origin of the light

y number <optional>
0

The y-coordinate position of the origin of the light

rotation number <optional>
0

The angle of rotation for the tile between 0 and 360

walls boolean <optional>
true

Whether or not this light source is constrained by Walls

vision boolean <optional>
false

Whether or not this light source provides a source of vision

config LightData

Light configuration data

hidden boolean <optional>
false

Is the light source currently hidden?

flags object <optional>
{}

An object of optional key/value flags

Parameters:
Name Type Attributes Description
data object

Initial data used to construct the data object

document BaseAmbientLight <optional>

The embedded document to which this data object belongs

Extends

  • DocumentData

Methods

_initialize()

_initializeSource()

Migrate AmbientLightData attributes to the new inner LightData structure. This can be safely removed after several major versions have passed. Maybe V12?