Struct bevy_ecs_tilemap::LayerBuilder

pub struct LayerBuilder<T> {
    pub settings: LayerSettings,
    // some fields omitted
}

Useful for creating and modifying a layer in the same system.

Fields

settings: LayerSettings

Implementations

impl<T> LayerBuilder<T> where
    T: TileBundleTrait, 

pub fn new<I: Into<u16>>(
    commands: &mut Commands<'_>,
    settings: LayerSettings,
    map_id: I,
    layer_id: I
) -> (Self, Entity)

Creates the layer builder using the layer settings.

pub fn new_batch<I: Into<u16>, F: 'static + FnMut(UVec2) -> Option<T>>(
    commands: &mut Commands<'_>,
    settings: LayerSettings,
    meshes: &mut ResMut<'_, Assets<Mesh>>,
    material_handle: Handle<ColorMaterial>,
    map_id: I,
    layer_id: I,
    f: F
) -> Entity

Uses bevy’s spawn_batch to quickly create large amounts of tiles. Note: Limited to T(Bundle + TileBundleTrait) for what gets spawned.

pub fn set_tile(&mut self, tile_pos: UVec2, tile: T) -> Result<(), MapTileError>

Sets a tile’s data at the given position.

pub fn get_tile_entity(
    &mut self,
    tile_pos: UVec2
) -> Result<Entity, MapTileError>

Returns a tile entity.

pub fn get_tile(&self, tile_pos: UVec2) -> Result<&T, MapTileError>

Gets a reference to the tile data using a tile position.

pub fn get_tile_mut(&mut self, tile_pos: UVec2) -> Result<&mut T, MapTileError>

Gets a mutable reference to the tile data using the a tile position.

pub fn for_each_tiles<F>(&mut self, f: F) where
    F: FnMut(Entity, &Option<T>), 

Loops through each tile entity and tile bundle in the builder. Note: The boolean is for visibility.

pub fn for_each_tiles_mut<F>(&mut self, f: F) where
    F: FnMut(Entity, &mut Option<T>), 

Mutably loops through each tile entity and tile bundle in the builder. Note: The boolean is for visibility.

pub fn fill(&mut self, start: UVec2, end: UVec2, tile: T)

Fills a section of the map with tiles.

pub fn set_all(&mut self, tile: T)

Sets all of the tiles in the layer builder.

pub fn get_tile_neighbors(
    &self,
    tile_pos: UVec2
) -> [(IVec2, Option<(Entity, &T)>); 8]

Retrieves a list of neighbors in the following order: N, S, W, E, NW, NE, SW, SE.

The returned neighbors are tuples that have an tilemap coordinate and an Option<(bevy::prelude::Entity, &T)>.

A value of None will be returned for tiles that don’t exist.

Example

let neighbors = map.get_tile_neighbors(UVec2::new(0, 0));
assert!(neighbors[1].1.is_none()); // Outside of tile bounds.
assert!(neighbors[0].1.is_none()); // Entity returned inside bounds.

pub fn build(
    &mut self,
    commands: &mut Commands<'_>,
    meshes: &mut ResMut<'_, Assets<Mesh>>,
    material: Handle<ColorMaterial>
) -> LayerBundle

Creates a layer bundle from the layer builder.