ObjectLayer

Struct ObjectLayer 

Source
pub struct ObjectLayer<'map> { /* private fields */ }
Expand description

Also called an “object group”. Used for storing Objects in a map.

Implementations§

Source§

impl<'map> ObjectLayer<'map>

Source

pub fn map(&self) -> &'map Map

Get the map this object is from.

Source§

impl<'map> ObjectLayer<'map>

Source

pub fn get_object(&self, idx: usize) -> Option<Object<'map>>

Obtains the object corresponding to the index given.

Source

pub fn objects(&self) -> impl ExactSizeIterator<Item = Object<'map>> + 'map

Returns an iterator over the objects present in this layer, in the order they were declared in in the TMX file.

§Example
use tiled::Object;

let spawnpoints: Vec<Object> = map
    .layers()
    .filter_map(|layer| match layer.layer_type() {
        tiled::LayerType::Objects(layer) => Some(layer),
        _ => None,
    })
    .flat_map(|layer| layer.objects())
    .filter(|object| object.user_type == "spawn")
    .collect();

dbg!(spawnpoints);

Methods from Deref<Target = ObjectLayerData>§

Source

pub fn object_data(&self) -> &[ObjectData]

Returns the data belonging to the objects contained within the layer, in the order they were declared in the TMX file.

Trait Implementations§

Source§

impl<'map> Clone for ObjectLayer<'map>

Source§

fn clone(&self) -> ObjectLayer<'map>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'map> Debug for ObjectLayer<'map>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'map> Deref for ObjectLayer<'map>

Source§

type Target = ObjectLayerData

The resulting type after dereferencing.
Source§

fn deref(&self) -> &'map Self::Target

Dereferences the value.
Source§

impl<'map> PartialEq for ObjectLayer<'map>

Source§

fn eq(&self, other: &ObjectLayer<'map>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl<'map> Copy for ObjectLayer<'map>

Source§

impl<'map> StructuralPartialEq for ObjectLayer<'map>

Auto Trait Implementations§

§

impl<'map> Freeze for ObjectLayer<'map>

§

impl<'map> RefUnwindSafe for ObjectLayer<'map>

§

impl<'map> Send for ObjectLayer<'map>

§

impl<'map> Sync for ObjectLayer<'map>

§

impl<'map> Unpin for ObjectLayer<'map>

§

impl<'map> UnwindSafe for ObjectLayer<'map>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.