Struct micro_ldtk::ldtk::LayerInstance

pub struct LayerInstance {

    pub c_hei: i64,
    pub c_wid: i64,
    pub grid_size: i64,
    pub identifier: String,
    pub opacity: f64,
    pub px_total_offset_x: i64,
    pub px_total_offset_y: i64,
    pub tileset_def_uid: Option<i64>,
    pub tileset_rel_path: Option<String>,
    pub layer_instance_type: String,
    pub auto_layer_tiles: Vec<TileInstance>,
    pub entity_instances: Vec<EntityInstance>,
    pub grid_tiles: Vec<TileInstance>,
    pub iid: String,
    pub int_grid: Option<Vec<IntGridValueInstance>>,
    pub int_grid_csv: Vec<i64>,
    pub layer_def_uid: i64,
    pub level_id: i64,
    pub optional_rules: Vec<i64>,
    pub override_tileset_uid: Option<i64>,
    pub px_offset_x: i64,
    pub px_offset_y: i64,
    pub seed: i64,
    pub visible: bool,
}

Fields

c_hei: i64

Grid-based height

c_wid: i64

Grid-based width

grid_size: i64

Grid size

identifier: String

Layer definition identifier

opacity: f64

Layer opacity as Float [0-1]

px_total_offset_x: i64

Total layer X pixel offset, including both instance and definition offsets.

px_total_offset_y: i64

Total layer Y pixel offset, including both instance and definition offsets.

tileset_def_uid: Option<i64>

The definition UID of corresponding Tileset, if any.

tileset_rel_path: Option<String>

The relative path to corresponding Tileset, if any.

layer_instance_type: String

Layer type (possible values: IntGrid, Entities, Tiles or AutoLayer)

auto_layer_tiles: Vec<TileInstance>

An array containing all tiles generated by Auto-layer rules. The array is already sorted in display order (ie. 1st tile is beneath 2nd, which is beneath 3rd etc.).

Note: if multiple tiles are stacked in the same cell as the result of different rules, all tiles behind opaque ones will be discarded.

entity_instances: Vec<EntityInstance>

grid_tiles: Vec<TileInstance>

iid: String

Unique layer instance identifier

int_grid: Option<Vec<IntGridValueInstance>>

WARNING: this deprecated value is no longer exported since version 1.0.0 Replaced by: intGridCsv

int_grid_csv: Vec<i64>

A list of all values in the IntGrid layer, stored in CSV format (Comma Separated Values).
Order is from left to right, and top to bottom (ie. first row from left to right, followed by second row, etc).
0 means “empty cell” and IntGrid values start at 1.
The array size is __cWid x __cHei cells.

layer_def_uid: i64

Reference the Layer definition UID

level_id: i64

Reference to the UID of the level containing this layer instance

optional_rules: Vec<i64>

An Array containing the UIDs of optional rules that were enabled in this specific layer instance.

override_tileset_uid: Option<i64>

This layer can use another tileset by overriding the tileset UID here.

px_offset_x: i64

X offset in pixels to render this layer, usually 0 (IMPORTANT: this should be added to the LayerDef optional offset, so you should probably prefer using __pxTotalOffsetX which contains the total offset value)

px_offset_y: i64

Y offset in pixels to render this layer, usually 0 (IMPORTANT: this should be added to the LayerDef optional offset, so you should probably prefer using __pxTotalOffsetX which contains the total offset value)

seed: i64

Random seed used for Auto-Layers rendering

visible: bool

Layer instance visibility

Trait Implementations

impl AsRef<LayerInstance> for LdtkLayer

fn as_ref(&self) -> &LayerInstance

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for LayerInstance

fn clone(&self) -> LayerInstance

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LayerInstance

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LayerInstance

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&LayerInstance> for LayerType

fn from(value: &LayerInstance) -> Self

Converts to this type from the input type.

impl PartialEq for LayerInstance

fn eq(&self, other: &LayerInstance) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for LayerInstance

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for LayerInstance