Struct bevy_ecs_tilemap::Map

pub struct Map {
    pub map_entity: Entity,
    pub id: u16,
    // some fields omitted
}

A simple component used to keep track of layer entities.

Fields

map_entity: Entity

id: u16

Implementations

impl Map

pub fn new<T: Into<u16>>(id: T, map_entity: Entity) -> Self

Creates a new map component

pub fn add_layer<T: Into<u16>>(
    &mut self,
    commands: &mut Commands<'_>,
    layer_id: T,
    layer_entity: Entity
)

Creates a new layer.

pub fn add_layers<I: Into<u16>>(
    &mut self,
    commands: &mut Commands<'_>,
    layers: IntoIter<(I, Entity)>
)

Adds multiple layers to the map.

pub fn remove_layer<I: Into<u16>>(
    &mut self,
    commands: &mut Commands<'_>,
    layer_id: I
)

Removes the layer from the map and despawns the layer entity. Note: Does not despawn the tile entities. Please use MapQuery instead.

pub fn remove_layers<I: Into<u16>>(
    &mut self,
    commands: &mut Commands<'_>,
    layers: IntoIter<I>
)

Removes the layers from the map and despawns the layer entities. Note: Does not despawn the tile entities. Please use MapQuery instead.

pub fn get_layer_entity<T: Into<u16>>(&self, layer_id: T) -> Option<&Entity>

Retrieves the entity for a given layer id.

pub fn despawn(&self, commands: &mut Commands<'_>)

Despawns a map. Better to call map_query.despawn_map as it will despawn layers/tiles as well.

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.