Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GroupLayer

A layer that groups several other layers.

Hierarchy

Index

Constructors

constructor

Properties

Readonly asset

asset: Asset

The asset this object is part of, or null.

className

className: string

Class name of the object.

Replaced the "type" of MapObject and Tile in Tiled 1.9.

since

1.9

Readonly id

id: number

Unique (map-wide) ID of the layer

since

1.5

Readonly isGroupLayer

isGroupLayer: boolean

Whether this layer is a GroupLayer.

Readonly isImageLayer

isImageLayer: boolean

Whether this layer is an ImageLayer.

Readonly isObjectLayer

isObjectLayer: boolean

Whether this layer is an ObjectGroup.

Readonly isTileLayer

isTileLayer: boolean

Whether this layer is a TileLayer.

Readonly layerCount

layerCount: number

Number of child layers the group layer has.

Readonly layers

layers: Layer[]

The child layers of this group layer.

since

1.8

locked

locked: boolean

Whether the layer is locked (affects whether child layers are locked for group layers).

Readonly map

map: null | TileMap

Map that this layer is part of, or null in case of a standalone layer.

name

name: string

Name of the layer.

offset

offset: point

Offset in pixels that is applied when this layer is rendered.

opacity

opacity: any

Opacity of the layer, from 0 (fully transparent) to 1 (fully opaque).

parallaxFactor

parallaxFactor: point

The parallax factor of this layer.

Readonly parentLayer

parentLayer: null | GroupLayer

The group layer this layer is part of, or null in case the layer is not grouped.

Readonly readOnly

readOnly: boolean

Whether the object is read-only.

selected

selected: boolean

Whether the layer is selected.

tintColor

tintColor: color

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

since

1.8

visible

visible: boolean

Whether the layer is visible (affects child layer visibility for group layers).

Methods

addLayer

  • addLayer(layer: Layer): void
  • 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).

insertLayerAt

  • insertLayerAt(index: number, layer: Layer): void
  • 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).

layerAt

  • layerAt(index: number): Layer
  • Returns a reference to the child layer at the given index.

properties

  • 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).

property

  • 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.

removeLayer

  • removeLayer(layer: Layer): void
  • Removes the given layer from the group. If this group wasn't standalone, the reference to the layer becomes a standalone copy.

removeLayerAt

  • removeLayerAt(index: number): void
  • 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.

removeProperty

  • removeProperty(name: string): void

resolvedProperties

  • 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.

resolvedProperty

  • 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.

setProperties

  • Replaces all currently set custom properties with a new set of properties.

setProperty

  • Sets the value of the custom property with the given name. Supported types are bool, number, string, FilePath, ObjectRef and MapObject.

    When setting a number, the property type will be set to either int or float, depending on whether it is a whole number.

    note

    Support for setting color properties is currently missing.

Generated using TypeDoc