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

t string <optional>
l

The source type in CONST.SOURCE_TYPES which defines the behavior of this light

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

dim number <optional>
0

The radius of dim light emitted in distance units, negative values produce darkness

bright number <optional>
0

The radius of bright light emitted in distance units, negative values produce blackness

angle number <optional>
360

The angle of emission of the light source in degrees

tintColor string <optional>

An optional color string which applies coloration to the resulting light source

tintAlpha number <optional>
0.5

The intensity of coloration applied to this light source, a number between 0 and 1

lightAnimation data.AnimationData <optional>

A data object which configures token light animation settings, if one is applied

darknessThreshold number <optional>
0

A value of the Scene darkness level, above which this light source will be active

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()