Struct ReflectBundle 

pub struct ReflectBundle(/* private fields */);

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

impl ReflectBundle

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

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

pub fn apply<'a>( &self, entity: impl Into<EntityMut<'a>>, bundle: &(dyn PartialReflect + 'static), 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.

pub fn apply_or_insert_mapped( &self, entity: &mut EntityWorldMut<'_>, bundle: &(dyn PartialReflect + 'static), registry: &TypeRegistry, mapper: &mut dyn EntityMapper, relationship_hook_mode: RelationshipHookMode, )

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.

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

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

pub fn take(&self, entity: &mut EntityWorldMut<'_>) -> Option<Box<dyn Reflect>>

Removes all components in the Bundle from the entity and returns their previous values.

Note: If the entity does not have every component in the bundle, this method will not remove any of them.

pub fn new(fns: ReflectBundleFns) -> ReflectBundle

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.

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

impl Clone for ReflectBundle

fn clone(&self) -> ReflectBundle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<B> FromType<B> for ReflectBundle

where B: Bundle + Reflect + TypePath + BundleFromComponents,

fn from_type() -> ReflectBundle

Creates an instance of Self for type T.

fn insert_dependencies(_type_registration: &mut TypeRegistration)

Inserts [TypeData] dependencies of this [TypeData]. This is especially useful for trait [TypeData] that has a supertrait (ex: A: B). When the [TypeData] for A is inserted, the B [TypeData] will also be inserted.