Struct bevy_ecs::reflect::ReflectBundle

source ·
pub struct ReflectBundle(/* private fields */);
Expand description

A struct used to operate on reflected Bundle trait of a type.

A ReflectBundle for type T can be obtained via bevy_reflect::TypeRegistration::data.

Implementations§

source§

impl ReflectBundle

source

pub fn insert( &self, entity: &mut EntityWorldMut<'_>, bundle: &dyn Reflect, registry: &TypeRegistry )

Insert a reflected Bundle into the entity like insert().

source

pub fn apply<'a>( &self, entity: impl Into<EntityMut<'a>>, bundle: &dyn Reflect, registry: &TypeRegistry )

Uses reflection to set the value of this Bundle type in the entity to the given value.

§Panics

Panics if there is no Bundle of the given type.

source

pub fn apply_or_insert( &self, entity: &mut EntityWorldMut<'_>, bundle: &dyn Reflect, registry: &TypeRegistry )

Uses reflection to set the value of this Bundle type in the entity to the given value or insert a new one if it does not exist.

source

pub fn remove(&self, entity: &mut EntityWorldMut<'_>)

Removes this Bundle type from the entity. Does nothing if it doesn’t exist.

source

pub fn new(fns: ReflectBundleFns) -> Self

Create a custom implementation of ReflectBundle.

This is an advanced feature, useful for scripting implementations, that should not be used by most users unless you know what you are doing.

Usually you should derive Reflect and add the #[reflect(Bundle)] bundle to generate a ReflectBundle implementation automatically.

See ReflectBundleFns for more information.

source

pub fn fn_pointers(&self) -> &ReflectBundleFns

The underlying function pointers implementing methods on ReflectBundle.

This is useful when you want to keep track locally of an individual function pointer.

Calling TypeRegistry::get followed by TypeRegistration::data::<ReflectBundle> can be costly if done several times per frame. Consider cloning ReflectBundle and keeping it between frames, cloning a ReflectBundle is very cheap.

If you only need a subset of the methods on ReflectBundle, use fn_pointers to get the underlying ReflectBundleFns and copy the subset of function pointers you care about.

Trait Implementations§

source§

impl Clone for ReflectBundle

source§

fn clone(&self) -> ReflectBundle

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<B: Bundle + Reflect> FromType<B> for ReflectBundle

source§

fn from_type() -> Self

Auto Trait Implementations§

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> Downcast for T
where T: Any,

source§

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

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
source§

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

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
source§

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

Convert &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)

Convert &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> DowncastSync for T
where T: Any + Send + Sync,

source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<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> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

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>,

§

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> TypeData for T
where T: 'static + Send + Sync + Clone,

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,