core/com.lehaine.littlekt.file.ldtk/LDtkLayerDefinition

LDtkLayerDefinition

@Serializable

data class LDtkLayerDefinition(val type: String, val autoRuleGroups: JsonArray, val autoSourceLayerDefUid: Int? = null, val autoTilesetDefUid: Int? = null, val displayOpacity: Float, val excludedTags: List<String>, val gridSize: Int, val identifier: String, val intGridValues: List<LDtkIntGridValueDefinition>, val pxOffsetX: Int, val pxOffsetY: Int, val requiredTags: List<String>, val tilePivotX: Float, val tilePivotY: Float, val tilesetDefUid: Int? = null, val layerDefinitionType: LDtkLayerType, val uid: Int, val parallaxFactorX: Float = 0.0f, val parallaxFactorY: Float = 0.0f, val parallaxScaling: Boolean = false)

Constructors

LDtkLayerDefinition

fun LDtkLayerDefinition(type: String, autoRuleGroups: JsonArray, autoSourceLayerDefUid: Int? = null, autoTilesetDefUid: Int? = null, displayOpacity: Float, excludedTags: List<String>, gridSize: Int, identifier: String, intGridValues: List<LDtkIntGridValueDefinition>, pxOffsetX: Int, pxOffsetY: Int, requiredTags: List<String>, tilePivotX: Float, tilePivotY: Float, tilesetDefUid: Int? = null, layerDefinitionType: LDtkLayerType, uid: Int, parallaxFactorX: Float = 0.0f, parallaxFactorY: Float = 0.0f, parallaxScaling: Boolean = false)

Properties

val autoRuleGroups: JsonArray

Contains all the auto-layer rule definitions.

autoSourceLayerDefUid

val autoSourceLayerDefUid: Int? = null

autoTilesetDefUid

val ~~autoTilesetDefUid~~: Int? = null

Reference to the Tileset UID being used by this auto-layer rules

val displayOpacity: Float

Opacity of the layer (0 to 1.0)

val excludedTags: List<String>

An array of tags to forbid some Entities in this layer

val gridSize: Int

Width and height of the grid in pixels

val identifier: String

Unique String identifier

val intGridValues: List<LDtkIntGridValueDefinition>

A list that defines extra optional info for each IntGrid value.

layerDefinitionType

val layerDefinitionType: LDtkLayerType

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

parallaxFactorX

val parallaxFactorX: Float = 0.0f

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

parallaxFactorY

val parallaxFactorY: Float = 0.0f

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

parallaxScaling

val parallaxScaling: Boolean = false

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

val pxOffsetX: Int

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

val pxOffsetY: Int

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

val requiredTags: List<String>

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

val tilePivotX: Float

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.

val tilePivotY: Float

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.

val tilesetDefUid: Int? = null

Reference to the Tileset UID being used by this Tile layer

val type: String

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

val uid: Int

Unique Int identifier