Struct ldtk_rust::Project[−][src]

pub struct Project {
    pub backup_limit: i64,
    pub backup_on_save: bool,
    pub bg_color: String,
    pub default_grid_size: i64,
    pub default_level_bg_color: String,
    pub default_level_height: i64,
    pub default_level_width: i64,
    pub default_pivot_x: f64,
    pub default_pivot_y: f64,
    pub defs: Definitions,
    pub export_png: bool,
    pub export_tiled: bool,
    pub external_levels: bool,
    pub flags: Vec<Flag>,
    pub json_version: String,
    pub level_name_pattern: String,
    pub levels: Vec<Level>,
    pub minify_json: bool,
    pub next_uid: i64,
    pub png_file_pattern: Option<String>,
    pub world_grid_height: i64,
    pub world_grid_width: i64,
    pub world_layout: WorldLayout,
}

This file is a JSON schema of files created by LDtk level editor (https://ldtk.io).

This is the root of any Project JSON file. It contains: - the project settings, - an array of levels, - and a definition object (that can probably be safely ignored for most users).

Fields

backup_limit: i64

Number of backup files to keep, if the backupOnSave is TRUE

backup_on_save: bool

If TRUE, an extra copy of the project will be created in a sub folder, when saving.

bg_color: String

Project background color

default_grid_size: i64

Default grid size for new layers

default_level_bg_color: String

Default background color of levels

default_level_height: i64

Default new level height

default_level_width: i64

Default new level width

default_pivot_x: f64

Default X pivot (0 to 1) for new entities

default_pivot_y: f64

Default Y pivot (0 to 1) for new entities

defs: Definitions

A structure containing all the definitions of this project

export_png: bool

If TRUE, all layers in all levels will also be exported as PNG along with the project file (default is FALSE)

export_tiled: bool

If TRUE, a Tiled compatible file will also be generated along with the LDtk JSON file (default is FALSE)

external_levels: bool

If TRUE, one file will be saved for the project (incl. all its definitions) and one file in a sub-folder for each level.

flags: Vec<Flag>

An array containing various advanced flags (ie. options or other states). Possible values: DiscardPreCsvIntGrid, IgnoreBackupSuggest

json_version: String

File format version

level_name_pattern: String

The default naming convention for level identifiers.

levels: Vec<Level>

All levels. The order of this array is only relevant in LinearHorizontal and linearVertical world layouts (see worldLayout value). Otherwise, you should refer to the worldX,worldY coordinates of each Level.

minify_json: bool

If TRUE, the Json is partially minified (no indentation, nor line breaks, default is FALSE)

next_uid: i64

Next Unique integer ID available

png_file_pattern: Option<String>

File naming pattern for exported PNGs

world_grid_height: i64

Height of the world grid in pixels.

world_grid_width: i64

Width of the world grid in pixels.

world_layout: WorldLayout

An enum that describes how levels are organized in this project (ie. linearly or in a 2D space). Possible values: Free, GridVania, LinearHorizontal, LinearVertical

Implementations

impl Project[src]

pub fn new(f: String) -> Self[src]

pub fn load_project(f: String) -> Self[src]

pub fn clear_levels(&mut self)[src]

pub fn load_external_levels(&mut self, f: String)[src]

pub fn get_level(&self, uid: i64) -> Option<&Level>[src]

Trait Implementations

impl<'de> Deserialize<'de> for Project[src]

impl Serialize for Project[src]

Auto Trait Implementations

impl RefUnwindSafe for Project

impl Send for Project

impl Sync for Project

impl Unpin for Project

impl UnwindSafe for Project

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

impl<T> DeserializeOwned for T where
    T: for<'de> Deserialize<'de>, [src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.