Skip to main content

Commands

Struct Commands 

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

Implementations§

Source§

impl<'a> Commands<'a>

Source

pub fn reserve_entities(&mut self, additional: u32)

Reserve storage for additional number of additional entities.

Reserve happens lazily, this can be used in conjunction with spawn but not with id()

fn sys(mut cmd: Commands) {
    cmd.reserve_entities(128);
    for i in 0..128 {
        // this is fine
        cmd.spawn().insert(i);
    }
}
fn sys(mut cmd: Commands) {
    cmd.reserve_entities(128);
    for i in 0..128 {
        // id will return an error, since the reserve has not happened yet
        cmd.spawn().id().unwrap();
    }
}
Source

pub fn entity(&mut self, id: EntityId) -> &mut EntityCommands

Source

pub fn insert_id(&mut self, id: EntityId) -> &mut EntityCommands

Take a pre-made id and insert into the world Will cause an error if the id slot is taken

Source

pub fn spawn(&mut self) -> &mut EntityCommands

Source

pub fn delete(&mut self, id: EntityId)

Source

pub fn insert_resource<T: Component>(&mut self, resource: T)

Source

pub fn remove_resource<T: Component>(&mut self)

Source

pub fn merge_entities(&mut self, src: EntityId, dst: EntityId)

Trait Implementations§

Source§

impl<'a> Send for Commands<'a>

Source§

impl<'a> Sync for Commands<'a>

Source§

impl<'a> WorldQuery<'a> for Commands<'a>

Source§

fn new(w: &'a World, system_idx: usize) -> Self

Source§

fn resources_mut(set: &mut HashSet<TypeId>)

List of resource types this query needs exclusive access to
Source§

fn components_mut(_set: &mut HashSet<TypeId>)

List of component types this query needs exclusive access to
Source§

fn components_const(_set: &mut HashSet<TypeId>)

List of component types this query needs
Source§

fn resources_const(_set: &mut HashSet<TypeId>)

List of resource types this query needs
Source§

fn exclusive() -> bool

Return wether this system should run in isolation
Source§

fn read_only() -> bool

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for Commands<'a>

§

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

§

impl<'a> Freeze for Commands<'a>

§

impl<'a> Unpin for Commands<'a>

§

impl<'a> UnsafeUnpin for Commands<'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> 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> 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> ParallelComponent for T
where T: Send + Sync,

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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> 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