Struct GridCommands

pub struct GridCommands<'a> { /* private fields */ }

Build big_space hierarchies more easily, with access to grids.

Implementations

impl<'a> GridCommands<'a>

pub fn grid(&mut self) -> &Grid

Get a reference to the current grid.

pub fn insert(&mut self, bundle: impl Bundle) -> &mut Self

Insert a component on this grid

pub fn spawn(&mut self, bundle: impl Bundle) -> SpatialEntityCommands<'_>

Spawn an entity in this grid.

pub fn spawn_spatial( &mut self, bundle: impl Bundle, ) -> SpatialEntityCommands<'_>

Add a high-precision spatial entity (GridCell) to this grid, and insert the provided bundle.

pub fn id(&self) -> Entity

Returns the Entity id of the entity.

pub fn with_spatial( &mut self, spatial: impl FnOnce(&mut SpatialEntityCommands<'_>), ) -> &mut Self

Add a high-precision spatial entity (GridCell) to this grid, and apply entity commands to it via the closure. This allows you to insert bundles on this new spatial entities, and add more children to it.

pub fn with_grid( &mut self, new_grid: Grid, builder: impl FnOnce(&mut GridCommands<'_>), ) -> &mut Self

Add a high-precision spatial entity (GridCell) to this grid, and apply entity commands to it via the closure. This allows you to insert bundles on this new spatial entities, and add more children to it.

pub fn with_grid_default( &mut self, builder: impl FnOnce(&mut GridCommands<'_>), ) -> &mut Self

Same as Self::with_grid, but using the default Grid value.

pub fn spawn_grid( &mut self, new_grid: Grid, bundle: impl Bundle, ) -> GridCommands<'_>

Spawn a grid as a child of the current grid.

pub fn spawn_grid_default(&mut self, bundle: impl Bundle) -> GridCommands<'_>

Spawn a grid as a child of the current grid.

pub fn commands(&mut self) -> &mut Commands<'a, 'a>

Access the underlying commands.

pub fn with_child<B: Bundle>(&mut self, bundle: B) -> &mut Self

Spawns the passed bundle which provides this grid, and adds it to this entity as a child.

Trait Implementations

impl Drop for GridCommands<'_>

Insert the grid on drop.

fn drop(&mut self)

Executes the destructor for this type.