Struct TileSet

pub struct TileSet {

    pub columns: u32,
    pub first_gid: u32,
    pub image: PathBuf,
    pub image_width: u32,
    pub image_height: u32,
    pub margin: u32,
    pub spacing: u32,
    pub name: String,
    pub properties: HashMap<String, TiledValue>,
    pub terrains: Option<Vec<Terrain>>,
    pub tile_count: u32,
    pub tile_height: u32,
    pub tile_width: u32,
    pub tile_offset: Option<Vec2<i32>>,
    pub tiles: Option<Vec<Tile>>,
    pub transparent_color: Color,
    pub wang_sets: Option<Vec<WangSet>>,
}

A tileset that associates information with each tile.

A tileset associates information with each tile such as image path or terrain type, may include a tiles array property. Each tile in the tiles member has a local id property which specifies the local ID within the tileset.

Tile sets may be internal to the map, or external files.

Fields

columns: u32

The number of tile columns in the tileset. Eg; dividing the associated image in to columns where each column is the width of the tile.

first_gid: u32

GID corresponding to the first tile in the set

image: PathBuf

Path to the image used for tiles in this set

image_width: u32

image_height: u32

margin: u32

Buffer between image edge and first tile in pixels

spacing: u32

Spacing between adjacent tiles in image in pixels

name: String

properties: HashMap<String, TiledValue>

terrains: Option<Vec<Terrain>>

tile_count: u32

The tile count + the first GID enable finding the tile location on the image

tile_height: u32

tile_width: u32

tile_offset: Option<Vec2<i32>>

used to specify an offset in pixels, to be applied when drawing a tile from this tileset

tiles: Option<Vec<Tile>>

Holds extra information for tiles such as terrain or animation

transparent_color: Color

Defaults to 0,0,0,0 (rgba)

wang_sets: Option<Vec<WangSet>>

Implementations

impl TileSet

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

Returns the tile position and extents for it’s location on the source image. Useful for creating textures/blits.

Trait Implementations

impl Clone for TileSet

fn clone(&self) -> TileSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TileSet

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TileSet

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TileSet

fn eq(&self, other: &TileSet) -> 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 TileSet