Mirrors/bevy
2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2024-11-22 04:33:37 +00:00
Code Issues Projects Releases Packages Wiki Activity

ReflectBundle::remove improvement (#16139)

Browse source 
# Objective

Fixes #15676

## Solution

`remove` returns the removed item

Add `take`

## Testing

None yet

## Migration Guide

If you don't need the returned value from `remove`, discard it.
This commit is contained in:
Benjamin Brienen 2024-10-28 23:29:05 +01:00 committed by GitHub
parent e58670102e
commit f005a96dd4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 22 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
crates/bevy_ecs/src/reflect/bundle.rs
View file

@ -28,14 +28,16 @@ pub struct ReflectBundle(ReflectBundleFns);
/// The also [`super::component::ReflectComponentFns`]. /// The also [`super::component::ReflectComponentFns`].
#[derive(Clone)] #[derive(Clone)]
pub struct ReflectBundleFns { pub struct ReflectBundleFns {
/// Function pointer implementing [`ReflectBundle::insert()`]. /// Function pointer implementing [`ReflectBundle::insert`].
pub insert: fn(&mut EntityWorldMut, &dyn PartialReflect, &TypeRegistry), pub insert: fn(&mut EntityWorldMut, &dyn PartialReflect, &TypeRegistry),
/// Function pointer implementing [`ReflectBundle::apply()`]. /// Function pointer implementing [`ReflectBundle::apply`].
pub apply: fn(EntityMut, &dyn PartialReflect, &TypeRegistry), pub apply: fn(EntityMut, &dyn PartialReflect, &TypeRegistry),
/// Function pointer implementing [`ReflectBundle::apply_or_insert()`]. /// Function pointer implementing [`ReflectBundle::apply_or_insert`].
pub apply_or_insert: fn(&mut EntityWorldMut, &dyn PartialReflect, &TypeRegistry), pub apply_or_insert: fn(&mut EntityWorldMut, &dyn PartialReflect, &TypeRegistry),
/// Function pointer implementing [`ReflectBundle::remove()`]. /// Function pointer implementing [`ReflectBundle::remove`].
pub remove: fn(&mut EntityWorldMut), pub remove: fn(&mut EntityWorldMut),
/// Function pointer implementing [`ReflectBundle::take`].
pub take: fn(&mut EntityWorldMut) -> Option<Box<dyn Reflect>>,
} }
impl ReflectBundleFns { impl ReflectBundleFns {
@ -85,8 +87,17 @@ impl ReflectBundle {
} }
/// Removes this [`Bundle`] type from the entity. Does nothing if it doesn't exist. /// Removes this [`Bundle`] type from the entity. Does nothing if it doesn't exist.
pub fn remove(&self, entity: &mut EntityWorldMut) { pub fn remove(&self, entity: &mut EntityWorldMut) -> &ReflectBundle {
(self.0.remove)(entity); (self.0.remove)(entity);
self
}
/// 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.
#[must_use]
pub fn take(&self, entity: &mut EntityWorldMut) -> Option<Box<dyn Reflect>> {
(self.0.take)(entity)
} }
/// Create a custom implementation of [`ReflectBundle`]. /// Create a custom implementation of [`ReflectBundle`].
@ -168,7 +179,7 @@ impl<B: Bundle + Reflect + TypePath> FromType<B> for ReflectBundle {
.iter_fields() .iter_fields()
.for_each(|field| apply_or_insert_field(entity, field, registry)), .for_each(|field| apply_or_insert_field(entity, field, registry)),
_ => panic!( _ => panic!(
"expected bundle `{}` to be named struct or tuple", "expected bundle `{}` to be a named struct or tuple",
// FIXME: once we have unique reflect, use `TypePath`. // FIXME: once we have unique reflect, use `TypePath`.
core::any::type_name::<B>(), core::any::type_name::<B>(),
), ),
@ -178,6 +189,11 @@ impl<B: Bundle + Reflect + TypePath> FromType<B> for ReflectBundle {
remove: |entity| { remove: |entity| {
entity.remove::<B>(); entity.remove::<B>();
}, },
take: |entity| {
entity
.take::<B>()
.map(|bundle| Box::new(bundle).into_reflect())
},
}) })
} }
} }