Class EntityDefinition

Json Definition Data

Properties

| Improve this Doc View Source

AllowOutOfBounds

If enabled, this entity is allowed to stay outside of the current level bounds

Type Description
System.Boolean
| Improve this Doc View Source

Color

Base entity color

Type Description
System.String
| Improve this Doc View Source

Doc

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

Type Description
System.String
| Improve this Doc View Source

ExportToToc

If enabled, all instances of this entity will be listed in the project "Table of content" object.

Type Description
System.Boolean
| Improve this Doc View Source

FieldDefs

Array of field definitions

Type Description
FieldDefinition[]
| Improve this Doc View Source

FillOpacity

Type Description
System.Single
| Improve this Doc View Source

Height

Pixel height

Type Description
System.Int32
| Improve this Doc View Source

Hollow

Type Description
System.Boolean
| Improve this Doc View Source

Identifier

User defined unique identifier

Type Description
System.String
| Improve this Doc View Source

KeepAspectRatio

Only applies to entities resizable on both X/Y. If TRUE, the entity instance width/height will keep the same aspect ratio as the definition.

Type Description
System.Boolean
| Improve this Doc View Source

LimitBehavior

Possible values: DiscardOldOnes, PreventAdding, MoveLastOne

Type Description
LDtkUnity.LimitBehavior
| Improve this Doc View Source

LimitScope

If TRUE, the maxCount is a "per world" limit, if FALSE, it's a "per level". Possible values: PerLayer, PerLevel, PerWorld

Type Description
LDtkUnity.LimitScope
| Improve this Doc View Source

LineOpacity

Type Description
System.Single
| Improve this Doc View Source

MaxCount

Max instances count

Type Description
System.Int32
| Improve this Doc View Source

MaxHeight

Max pixel height (only applies if the entity is resizable on Y)

Type Description
System.Nullable<System.Int32>
| Improve this Doc View Source

MaxWidth

Max pixel width (only applies if the entity is resizable on X)

Type Description
System.Nullable<System.Int32>
| Improve this Doc View Source

MinHeight

Min pixel height (only applies if the entity is resizable on Y)

Type Description
System.Nullable<System.Int32>
| Improve this Doc View Source

MinWidth

Min pixel width (only applies if the entity is resizable on X)

Type Description
System.Nullable<System.Int32>
| Improve this Doc View Source

NineSliceBorders

An array of 4 dimensions for the up/right/down/left borders (in this order) when using 9-slice mode for tileRenderMode.
If the tileRenderMode is not NineSlice, then this array is empty.
See: https://en.wikipedia.org/wiki/9-slice_scaling

Type Description
System.Int32[]
| Improve this Doc View Source

PivotX

Pivot X coordinate (from 0 to 1.0)

Type Description
System.Single
| Improve this Doc View Source

PivotY

Pivot Y coordinate (from 0 to 1.0)

Type Description
System.Single
| Improve this Doc View Source

RenderMode

Possible values: Rectangle, Ellipse, Tile, Cross

Type Description
LDtkUnity.RenderMode
| Improve this Doc View Source

ResizableX

If TRUE, the entity instances will be resizable horizontally

Type Description
System.Boolean
| Improve this Doc View Source

ResizableY

If TRUE, the entity instances will be resizable vertically

Type Description
System.Boolean
| Improve this Doc View Source

ShowName

Display entity name in editor

Type Description
System.Boolean
| Improve this Doc View Source

Tags

An array of strings that classifies this entity

Type Description
System.String[]
| Improve this Doc View Source

TileId

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

Type Description
System.Nullable<System.Int32>
| Improve this Doc View Source

TileOpacity

Type Description
System.Single
| Improve this Doc View Source

TileRect

An object representing a rectangle from an existing Tileset

Type Description
TilesetRectangle
| Improve this Doc View Source

TileRenderMode

An enum describing how the the Entity tile is rendered inside the Entity bounds. Possible values: Cover, FitInside, Repeat, Stretch, FullSizeCropped, FullSizeUncropped, NineSlice

Type Description
LDtkUnity.TileRenderMode
| Improve this Doc View Source

Tileset

Type Description
TilesetDefinition

Reference to the tileset that uses this icon.
Make sure to call LDtkUidBank.CacheUidData(LdtkJson) first!
| Improve this Doc View Source

TilesetId

Tileset ID used for optional tile display

Type Description
System.Nullable<System.Int32>
| Improve this Doc View Source

Uid

Unique Int identifier

Type Description
System.Int32
| Improve this Doc View Source

UiTileRect

This tile overrides the one defined in tileRect in the UI

Type Description
TilesetRectangle
| Improve this Doc View Source

UnityColor

Type Description
UnityEngine.Color

The "color" field converted for use with Unity
| Improve this Doc View Source

UnityNineSliceBorders

Type Description
UnityEngine.Rect

An array of 4 dimensions for the up/right/down/left borders (in this order) when using 9-slice mode for tileRenderMode.
If the tileRenderMode is not NineSlice, then this array is empty.
See: https://en.wikipedia.org/wiki/9-slice_scaling
| Improve this Doc View Source

UnityPivot

Type Description
UnityEngine.Vector2

Pivot coords (from 0 to 1 for both axes)
| Improve this Doc View Source

UnitySize

Type Description
UnityEngine.Vector2Int

Original pixel size
| Improve this Doc View Source

Width

Pixel width

Type Description
System.Int32