Constructs a new group layer.
The asset this object is part of, or null
.
Unique (map-wide) ID of the layer
Whether this layer is a GroupLayer.
Whether this layer is an ImageLayer.
Whether this layer is an ObjectGroup.
Whether this layer is a TileLayer.
Number of child layers the group layer has.
The child layers of this group layer.
Whether the layer is locked (affects whether child layers are locked for group layers).
Map that this layer is part of, or null
in case of a standalone layer.
Name of the layer.
Offset in pixels that is applied when this layer is rendered.
Opacity of the layer, from 0 (fully transparent) to 1 (fully opaque).
The parallax factor of this layer.
The group layer this layer is part of, or null
in case the layer is not
grouped.
Whether the object is read-only.
Whether the layer is selected.
Tint color of the layer. Will be used to tint any images rendered by this layer or by any child layers. Affects tile layers, image layers and tile objects.
Since Tiled 1.8.5, this property is #ffffff when no tint color has been set on this layer (before it was #000000 in that case).
Whether the layer is visible (affects child layer visibility for group layers).
Adds the layer to the group, above all existing layers. The layer can't already be part of a map.
When adding a TileLayer to a map, the layer's width and height are automatically initialized to the size of the map (since Tiled 1.4.2).
Inserts the layer at the given index. The layer can't already be part of a map.
When adding a TileLayer to a map, the layer's width and height are automatically initialized to the size of the map (since Tiled 1.4.2).
Returns a reference to the child layer at the given index.
Returns all custom properties set on this object.
Modifications to the properties will not affect the original object. Does not include inherited values (see resolvedProperties).
Returns the value of the custom property with the given name, or
undefined
if no such property is set on the object. Does not
include inherited values (see resolvedProperty).
file
properties are returned as FilePath.
object
properties are returned as MapObject when possible,
or ObjectRef when the object could not be found.
Removes the given layer from the group. If this group wasn't standalone, the reference to the layer becomes a standalone copy.
Removes the child layer at the given index. When a reference to the layer still exists and this group layer isn't already standalone, that reference becomes a standalone copy of the layer.
Removes the custom property with the given name.
Returns all custom properties set on this object. Modifications to the properties will not affect the original object. Includes values inherited from object types, templates and tiles where applicable.
Returns the value of the custom property with the given name, or
undefined
if no such property is set. Includes values inherited
from object types, templates and tiles where applicable.
Sets the value of the custom property with the given name to the given color value.
The color is specified as a string "#RGB", "#RRGGBB" or "#AARRGGBB".
Sets the value of the custom property with the given name to the given color value.
The color is specified by its red, green, blue and alpha components. Each component takes a value from 0 to 255. When not provided, the alpha defaults to 255.
Sets the value of the custom property with the given name to the given float value.
This function is provided as alternative to setProperty, since
that function will set whole numbers as int
properties.
Replaces all currently set custom properties with a new set of properties.
Sets the value of the custom property with the given name.
Supported types are bool
, number
, string
, color,
FilePath, ObjectRef, MapObject and
PropertyValue.
Sets the value of an object's property identified by the given path to the given value.
The path is a list of property names, where each name identifies a member of the previous member's value. The last name in the list identifies the property to set.
Supported types are bool
, number
, string
, color,
FilePath, ObjectRef, MapObject and
PropertyValue.
Generated using TypeDoc
A layer that groups several other layers.