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

LDtkFieldDefinition

@Serializable

data class LDtkFieldDefinition(val type: String, val acceptFileTypes: List<String>? = null, val arrayMaxLength: Int? = null, val arrayMinLength: Int? = null, val canBeNull: Boolean, val defaultOverride: DefaultOverrideInfo? = null, val identifier: String, val isArray: Boolean, val max: Float? = null, val min: Float? = null, val regex: String? = null, val uid: Int)

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

Constructors

LDtkFieldDefinition

fun LDtkFieldDefinition(type: String, acceptFileTypes: List<String>? = null, arrayMaxLength: Int? = null, arrayMinLength: Int? = null, canBeNull: Boolean, defaultOverride: DefaultOverrideInfo? = null, identifier: String, isArray: Boolean, max: Float? = null, min: Float? = null, regex: String? = null, uid: Int)

Properties

acceptFileTypes

val acceptFileTypes: List<String>? = null

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

arrayMaxLength

val arrayMaxLength: Int? = null

Array max length

arrayMinLength

val arrayMinLength: Int? = null

Array min length

canBeNull

val canBeNull: Boolean

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

defaultOverride

val defaultOverride: DefaultOverrideInfo? = null

Default value if selected value is null or invalid.

identifier

val identifier: String

Unique String identifier

isArray

val isArray: Boolean

TRUE if the value is an array of multiple values

max

val max: Float? = null

Max limit for value, if applicable

min

val min: Float? = null

Min limit for value, if applicable

regex

val regex: String? = null

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

type

val type: String

Human readable value type (eg. Int, Float, Point, etc.). If the field is an array, this field will look like Array<...> (eg. Array<Int>, Array<Point> etc.)

uid

val uid: Int

Unique Intidentifier