Struct GridCommands

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

Build big_space hierarchies more easily, with access to grids.

Implementations§

Source§

impl<'a> GridCommands<'a>

Source

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

Get a reference to the current grid.

Source

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

Insert a component on this grid

Source

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

Spawn an entity in this grid.

Source

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.

Source

pub fn id(&self) -> Entity

Returns the Entity id of the entity.

Source

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.

Source

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.

Source

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.

Source

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

Spawn a grid as a child of the current grid.

Source

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

Spawn a grid as a child of the current grid.

Source

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

Access the underlying commands.

Source

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§

Source§

impl Drop for GridCommands<'_>

Insert the grid on drop.

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for GridCommands<'a>

§

impl<'a> RefUnwindSafe for GridCommands<'a>

§

impl<'a> Send for GridCommands<'a>

§

impl<'a> Sync for GridCommands<'a>

§

impl<'a> Unpin for GridCommands<'a>

§

impl<'a> !UnwindSafe for GridCommands<'a>

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, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,

Source§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.
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> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. 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.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ConditionalSend for T
where T: Send,

Source§

impl<T> Settings for T
where T: 'static + Send + Sync,

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,