Class LayerDefinition

Json Definition Data

Properties

AutoRuleGroups

Contains all the auto-layer rule definitions.

Type	Description
AutoLayerRuleGroup[]

AutoSourceLayerDefinition

Type	Description
LayerDefinition	Reference to the AutoLayer source definition. Make sure to call LDtkUidBank.CacheUidData(LdtkJson) first!

AutoSourceLayerDefUid

Type	Description
System.Nullable<System.Int32>

AutoTilesetDefUid

WARNING: this deprecated value is no longer exported since version 1.2.0 Replaced by: tilesetDefUid

Type	Description
System.Nullable<System.Int32>

AutoTilesKilledByOtherLayerUid

Type	Description
System.Nullable<System.Int32>

BiomeFieldUid

Type	Description
System.Nullable<System.Int32>

CanSelectWhenInactive

Allow editor selections when the layer is not currently active.

Type	Description
System.Boolean

DisplayOpacity

Opacity of the layer (0 to 1.0)

Type	Description
System.Single

Doc

User defined documentation for this element to provide help/tips to level designers.

Type	Description
System.String

ExcludedTags

An array of tags to forbid some Entities in this layer

Type	Description
System.String[]

GridSize

Width and height of the grid in pixels

Type	Description
System.Int32

GuideGridHei

Height of the optional "guide" grid in pixels

Type	Description
System.Int32

GuideGridSize

Size of the optional "guide" grid in pixels

Type	Description
UnityEngine.Vector2Int

GuideGridWid

Width of the optional "guide" grid in pixels

Type	Description
System.Int32

HideFieldsWhenInactive

Type	Description
System.Boolean

HideInList

Hide the layer from the list on the side of the editor view.

Type	Description
System.Boolean

Identifier

User defined unique identifier

Type	Description
System.String

InactiveOpacity

Alpha of this layer when it is not the active one.

Type	Description
System.Single

IntGridValues

An array that defines extra optional info for each IntGrid value.
WARNING: the array order is not related to actual IntGrid values! As user can re-order IntGrid values freely, you may value "2" before value "1" in this array.

Type	Description
IntGridValueDefinition[]

IntGridValuesGroups

Group informations for IntGrid values

Type	Description
IntGridValueGroupDefinition[]

IsAutoLayer

Type	Description
System.Boolean	Returns true if this layer is an Auto Layer.

IsEntitiesLayer

Type	Description
System.Boolean	Returns true if this layer is an Entities layer.

IsIntGridLayer

Type	Description
System.Boolean	Returns true if this layer is an IntGrid layer.

IsTilesLayer

Type	Description
System.Boolean	Returns true if this layer is a Tiles layer.

LayerDefinitionType

Type of the layer as Haxe Enum Possible values: IntGrid, Entities, Tiles, AutoLayer

Type	Description
LDtkUnity.TypeEnum

ParallaxFactor

Type	Description
UnityEngine.Vector2	Parallax factor (from -1 to 1, defaults to 0) which affects the scrolling speed of this layer, creating a fake 3D (parallax) effect.

ParallaxFactorX

Parallax horizontal factor (from -1 to 1, defaults to 0) which affects the scrolling speed of this layer, creating a fake 3D (parallax) effect.

Type	Description
System.Single

ParallaxFactorY

Parallax vertical factor (from -1 to 1, defaults to 0) which affects the scrolling speed of this layer, creating a fake 3D (parallax) effect.

Type	Description
System.Single

ParallaxScaling

If true (default), a layer with a parallax factor will also be scaled up/down accordingly.

Type	Description
System.Boolean

PxOffset

Type	Description
UnityEngine.Vector2Int	Offset of the layer, in pixels (IMPORTANT: this should be added to the LayerInstance optional offset)

PxOffsetX

X offset of the layer, in pixels (IMPORTANT: this should be added to the LayerInstance optional offset)

Type	Description
System.Int32

PxOffsetY

Y offset of the layer, in pixels (IMPORTANT: this should be added to the LayerInstance optional offset)

Type	Description
System.Int32

RenderInWorldView

If TRUE, the content of this layer will be used when rendering levels in a simplified way for the world view

Type	Description
System.Boolean

RequiredTags

An array of tags to filter Entities that can be added to this layer

Type	Description
System.String[]

TilePivot

Type	Description
UnityEngine.Vector2	If the tiles are smaller or larger than the layer grid, the pivot value will be used to position the tile relatively its grid cell.

TilePivotX

If the tiles are smaller or larger than the layer grid, the pivot value will be used to position the tile relatively its grid cell.

Type	Description
System.Single

TilePivotY

If the tiles are smaller or larger than the layer grid, the pivot value will be used to position the tile relatively its grid cell.

Type	Description
System.Single

TilesetDefinition

Type	Description
TilesetDefinition	Reference to the tileset definition being used by this Tile layer. Make sure to call LDtkUidBank.CacheUidData(LdtkJson) first!

TilesetDefUid

Reference to the default Tileset UID being used by this layer definition.
WARNING: some layer instances might use a different tileset. So most of the time, you should probably use the __tilesetDefUid value found in layer instances.
Note: since version 1.0.0, the old autoTilesetDefUid was removed and merged into this value.

Type	Description
System.Nullable<System.Int32>

Type

Type of the layer (IntGrid, Entities, Tiles or AutoLayer)

Type	Description
System.String

UiColor

User defined color for the UI

Type	Description
System.String

Uid

Unique Int identifier

Type	Description
System.Int32

UiFilterTags

Display tags

Type	Description
System.String[]

UnityUiColor

User defined color for the UI

Type	Description
UnityEngine.Color

UseAsyncRender

Asynchronous rendering option for large/complex layers

Type	Description
System.Boolean