Struct Map

pub struct Map {

    pub background_color: Color,
    pub hex_side_length: Option<u32>,
    pub infinite: bool,
    pub layers: Vec<Layer>,
    pub orientation: Orientation,
    pub render_order: Option<RenderOrder>,
    pub stagger_axis: Option<StaggerAxis>,
    pub stagger_index: Option<StaggerIndex>,
    pub tile_height: u32,
    pub tile_width: u32,
    pub height: u32,
    pub width: u32,
    pub tile_sets: Vec<TileSet>,
    pub properties: HashMap<String, TiledValue>,
}

The base structure which contains all data - as in the root of a tree

Fields

background_color: Color

The background colour is translated from the hex representation

hex_side_length: Option<u32>

Length of the side of a hex tile in pixels

infinite: bool

Whether the map has infinite dimensions

layers: Vec<Layer>

Layers are generally stored in order. So that the first layer in the array will be drawn first and so on. Nested layers follow the same principle.

orientation: Orientation

Orthogonal, Isometric, Staggered or Hexagonal

render_order: Option<RenderOrder>

Rendering direction (orthogonal maps only)

stagger_axis: Option<StaggerAxis>

X or Y (staggered / hexagonal maps only)

stagger_index: Option<StaggerIndex>

Odd or Even (staggered / hexagonal maps only)

tile_height: u32

Height in pixels for tiles in this map

tile_width: u32

Width in pixels for tiles in this map

height: u32

The number of tile rows for the map

width: u32

The number of tile columns for the map

tile_sets: Vec<TileSet>

properties: HashMap<String, TiledValue>

Implementations

impl Map

pub fn load_from_file(path: &Path) -> Result<Self, Error>

pub fn load_from_str(s: &str) -> Result<Layer, Error>

pub fn tileset_image_path(&self, tile_gid: u32) -> Option<&Path>

Returns the image path for the image the tile is using

pub fn tileset_name(&self, tile_gid: u32) -> Option<&str>

Return the name of the tileset the tile is from

pub fn tile_position_on_image(&self, tile_gid: u32) -> TileRect

Returns the position and dimensions of the tile GID on its associated image. Used for drawing tiles, eg; using SDL2 to blit this tile from an image surface.

pub fn tile_position_on_map(&self, count: u32, tile_gid: u32) -> Vec2<u32>

Returns the tile position in pixels on the current map

Trait Implementations

impl Clone for Map

fn clone(&self) -> Map

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Map

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Map

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Map

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Map