Struct ldtk_rust::FieldDefinition

pub struct FieldDefinition {
    pub field_definition_type: String,
    pub accept_file_types: Option<Vec<String>>,
    pub array_max_length: Option<i64>,
    pub array_min_length: Option<i64>,
    pub can_be_null: bool,
    pub default_override: Option<Value>,
    pub editor_always_show: bool,
    pub editor_display_mode: Option<EditorDisplayMode>,
    pub editor_display_pos: Option<EditorDisplayPos>,
    pub identifier: String,
    pub is_array: bool,
    pub max: Option<f64>,
    pub min: Option<f64>,
    pub regex: Option<String>,
    pub purple_type: Option<Value>,
    pub uid: i64,
}

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

Fields

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

accept_file_types: Option<Vec<String>>

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

array_max_length: Option<i64>

Array max length

array_min_length: Option<i64>

Array min length

can_be_null: bool

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

default_override: Option<Value>

Default value if selected value is null or invalid.

editor_always_show: bool

editor_display_mode: Option<EditorDisplayMode>

Possible values: Hidden, ValueOnly, NameAndValue, EntityTile, PointStar, PointPath, RadiusPx, RadiusGrid

editor_display_pos: Option<EditorDisplayPos>

Possible values: Above, Center, Beneath

identifier: String

Unique String identifier

is_array: bool

TRUE if the value is an array of multiple values

max: Option<f64>

Max limit for value, if applicable

min: Option<f64>

Min limit for value, if applicable

regex: Option<String>

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

purple_type: Option<Value>

Internal type enum

uid: i64

Unique Intidentifier

Trait Implementations

impl<'de> Deserialize<'de> for FieldDefinition

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for FieldDefinition

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.