Struct rs_tiled_json::tileset::Tile

pub struct Tile {
    pub id: u16,
    pub image: Option<String>,
    pub imageheight: u16,
    pub imagewidth: u16,
    pub ttype: Option<String>,
    pub objectgroup: Option<Layer>,
    pub animation: Vec<Frame>,
    pub properties: Vec<Property>,
}

Tile contains data relevant to overrides of the tileset. This is for containing data specific to certain tiles within the tileset, such animations, collisions, different images, and properties.

This struct implements the trait HasProperty, which enables easy access of Tiled properties for Tiles. The relevant functions are:

    tiled_json::Tile::get_property(&self, name: &str) -> Option<&tiled_json::Property>;
    tiled_json::Tile::get_property_vector(&self) -> &Vec<tiled_json::Property>;
    tiled_json::Tile::get_property_value(&self, name: &str) -> Option<&tiled_json::PropertyValue>;
    // See the tiled_json::Property struct to see functionality offered.

Fields

id: u16

image: Option<String>

imageheight: u16

imagewidth: u16

ttype: Option<String>

objectgroup: Option<Layer>

animation: Vec<Frame>

properties: Vec<Property>

Methods

impl Tile

pub fn get_anim(&self, msecs: u32) -> (bool, u16)

This will get you the tileid of the animation frame at msecs (milliseconds) from creation.

The tuple is a boolean (whether we get an animation or not) and a u16, which will be the local id of the tile in the parent tileset.

pub fn id(&self) -> u16

id refers to the local id of the tile in the tileset. This is dissimilar to the gid (global id) used for storing data in tile layers.

pub fn image_height(&self) -> u16

Take the image height in pixels. If this was unspecified in Tiled, this data will be 0.

pub fn image_width(&self) -> u16

Take the image width in pixels. If this was unspecified in Tiled, this data will be 0.

pub fn animation(&self) -> &Vec<Frame>

Access the animation data. This vector can be empty.

pub fn image(&self) -> Option<&String>

Get the filename of the image this refers to.

pub fn get_type(&self) -> Option<&String>

User specified type of tile.

pub fn object_group(&self) -> Option<&Layer>

This will give you the objectgroup layer. This is for determining collisions as defined in the tileset.

Trait Implementations

impl Debug for Tile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Tile

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

Deserialize this value from the given Serde deserializer.

impl HasProperty for Tile

fn get_property_vector(&self) -> &Vec<Property>

Get access to the properties of the Tile object.

fn get_property(&self, name: &str) -> Option<&Property>

Find a property by name.

fn get_property_value(&self, name: &str) -> Option<&PropertyValue>

Get the PropertyValue by name from an obhect that has a list of properties.