Class FieldDefinition

This section is mostly only intended for the LDtk editor app itself. You can safely ignore it.

Properties

| Improve this Doc View Source

AcceptFileTypes

Optional list of accepted file extensions for FilePath value type. Includes the dot: .ext

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

AllowedRefs

Possible values: Any, OnlySame, OnlyTags, OnlySpecificEntity

Type Description
LDtkUnity.AllowedRefs
| Improve this Doc View Source

AllowedRefsEntityUid

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

AllowedRefTags

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

AllowOutOfLevelRef

Type Description
System.Boolean
| Improve this Doc View Source

ArrayMaxLength

Array max length

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

ArrayMinLength

Array min length

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

AutoChainRef

Type Description
System.Boolean
| Improve this Doc View Source

CanBeNull

TRUE if the value can be null. For arrays, TRUE means it can contain null values (exception: array of Points can't have null values).

Type Description
System.Boolean
| Improve this Doc View Source

DefaultOverride

Default value if selected value is null or invalid.

Type Description
System.Object
| Improve this Doc View Source

Doc

User defined documentation for this field to provide help/tips to level designers about accepted values.

Type Description
System.String
| Improve this Doc View Source

EditorAlwaysShow

Type Description
System.Boolean
| Improve this Doc View Source

EditorCutLongValues

Type Description
System.Boolean
| Improve this Doc View Source

EditorDisplayColor

Type Description
System.String
| Improve this Doc View Source

EditorDisplayMode

Possible values: Hidden, ValueOnly, NameAndValue, EntityTile, LevelTile, Points, PointStar, PointPath, PointPathLoop, RadiusPx, RadiusGrid, ArrayCountWithLabel, ArrayCountNoLabel, RefLinkBetweenPivots, RefLinkBetweenCenters

Type Description
LDtkUnity.EditorDisplayMode
| Improve this Doc View Source

EditorDisplayPos

Possible values: Above, Center, Beneath

Type Description
LDtkUnity.EditorDisplayPos
| Improve this Doc View Source

EditorDisplayScale

Type Description
System.Single
| Improve this Doc View Source

EditorLinkStyle

Possible values: ZigZag, StraightArrow, CurvedArrow, ArrowsLine, DashedLine

Type Description
EditorLinkStyle
| Improve this Doc View Source

EditorShowInWorld

Type Description
System.Boolean
| Improve this Doc View Source

EditorTextPrefix

Type Description
System.String
| Improve this Doc View Source

EditorTextSuffix

Type Description
System.String
| Improve this Doc View Source

ExportToToc

If TRUE, the field value will be exported to the toc project JSON field. Only applies to Entity fields.

Type Description
System.Boolean
| Improve this Doc View Source

FieldDefinitionType

Internal enum representing the possible field types. Possible values: F_Int, F_Float, F_String, F_Text, F_Bool, F_Color, F_Enum(...), F_Point, F_Path, F_EntityRef, F_Tile

Type Description
System.String
| Improve this Doc View Source

Identifier

User defined unique identifier

Type Description
System.String
| Improve this Doc View Source

IsArray

TRUE if the value is an array of multiple values

Type Description
System.Boolean
| Improve this Doc View Source

Max

Max limit for value, if applicable

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

Min

Min limit for value, if applicable

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

Regex

Optional regular expression that needs to be matched to accept values. Expected format: /some_reg_ex/g, with optional "i" flag.

Type Description
System.String
| Improve this Doc View Source

Searchable

If enabled, this field will be searchable through LDtk command palette

Type Description
System.Boolean
| Improve this Doc View Source

SymmetricalRef

Type Description
System.Boolean
| Improve this Doc View Source

TextLanguageMode

Possible values: <null>, LangPython, LangRuby, LangJS, LangLua, LangC, LangHaxe, LangMarkdown, LangJson, LangXml, LangLog

Type Description
System.Nullable<LDtkUnity.TextLanguageMode>
| 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

TilesetUid

UID of the tileset used for a Tile

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

Type

Human readable value type. Possible values: Int, Float, String, Bool, Color, ExternEnum.XXX, LocalEnum.XXX, Point, FilePath.

Type Description
System.String
| Improve this Doc View Source

Uid

Unique Int identifier

Type Description
System.Int32
| Improve this Doc View Source

UnityEditorDisplayColor

Type Description
UnityEngine.Color
| Improve this Doc View Source

UseForSmartColor

If TRUE, the color associated with this field will override the Entity or Level default color in the editor UI. For Enum fields, this would be the color associated to their values.

Type Description
System.Boolean