RelatedSpawner

Struct RelatedSpawner 

Source
pub struct RelatedSpawner<'w, R: Relationship> { /* private fields */ }
Expand description

Directly spawns related “source” entities with the given Relationship, targeting a specific entity.

Implementations§

Source§

impl<'w, R: Relationship> RelatedSpawner<'w, R>

Source

pub fn new(world: &'w mut World, target: Entity) -> Self

Creates a new instance that will spawn entities targeting the target entity.

Source

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

Spawns an entity with the given bundle and an R relationship targeting the target entity this spawner was initialized with.

Source

pub fn spawn_empty(&mut self) -> EntityWorldMut<'_>

Spawns an entity with an R relationship targeting the target entity this spawner was initialized with.

Source

pub fn target_entity(&self) -> Entity

Returns the “target entity” used when spawning entities with an R Relationship.

Source

pub fn world(&self) -> &World

Returns a reference to the underlying World.

Source

pub fn world_mut(&mut self) -> &mut World

Returns a mutable reference to the underlying World.

Auto Trait Implementations§

§

impl<'w, R> Freeze for RelatedSpawner<'w, R>

§

impl<'w, R> !RefUnwindSafe for RelatedSpawner<'w, R>

§

impl<'w, R> Send for RelatedSpawner<'w, R>

§

impl<'w, R> Sync for RelatedSpawner<'w, R>

§

impl<'w, R> Unpin for RelatedSpawner<'w, R>
where R: Unpin,

§

impl<'w, R> !UnwindSafe for RelatedSpawner<'w, R>

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, 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> IntoResult<T> for T

Source§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
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> ConditionalSend for T
where T: Send,