-
-
Notifications
You must be signed in to change notification settings - Fork 3.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Reworked removal detection as events
Formatting Fix some docs Unnecessary imports impl From rather than Into for ToComponentId Try to fix CI errors Fix up test to expect double buffering Fix linnk in docs Simplify component id initializing/fetching Remove from system params Move component id for to component file Move ComponentIdFor to component.rs Deref and don't allow modifying the component id IntoIterator for RemovedComponents Formatting Example for ComponentIdFor Improve documentation MaybeIter inbetween Remove unnecessary type for iterator Improve safety comment, don't box unnecessarily formatting
- Loading branch information
Showing
9 changed files
with
266 additions
and
142 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| //! Alerting events when a component is removed from an entity. | ||
|
|
||
| use crate::{ | ||
| self as bevy_ecs, | ||
| component::{Component, ComponentId, ComponentIdFor}, | ||
| entity::Entity, | ||
| event::{Events, ManualEventIterator, ManualEventReader}, | ||
| prelude::Local, | ||
| storage::SparseSet, | ||
| }; | ||
| use bevy_ecs_macros::SystemParam; | ||
|
|
||
| use std::{ | ||
| fmt::Debug, | ||
| iter, | ||
| marker::PhantomData, | ||
| ops::{Deref, DerefMut}, | ||
| option, | ||
| }; | ||
|
|
||
| /// Wrapper around a [`ManualEventReader<Entity>`] so that we | ||
| /// can differentiate events between components. | ||
| #[derive(Debug)] | ||
| pub struct RemovedComponentReader<T> | ||
| where | ||
| T: Component, | ||
| { | ||
| reader: ManualEventReader<Entity>, | ||
| marker: PhantomData<T>, | ||
| } | ||
|
|
||
| impl<T: Component> Default for RemovedComponentReader<T> { | ||
| fn default() -> Self { | ||
| Self { | ||
| reader: Default::default(), | ||
| marker: PhantomData, | ||
| } | ||
| } | ||
| } | ||
|
|
||
| impl<T: Component> Deref for RemovedComponentReader<T> { | ||
| type Target = ManualEventReader<Entity>; | ||
| fn deref(&self) -> &Self::Target { | ||
| &self.reader | ||
| } | ||
| } | ||
|
|
||
| impl<T: Component> DerefMut for RemovedComponentReader<T> { | ||
| fn deref_mut(&mut self) -> &mut Self::Target { | ||
| &mut self.reader | ||
| } | ||
| } | ||
|
|
||
| /// Wrapper around a map of components to [`Events<Entity>`]. | ||
| /// So that we can find the events without naming the type directly. | ||
| #[derive(Default, Debug)] | ||
| pub struct RemovedComponentEvents { | ||
| event_sets: SparseSet<ComponentId, Events<Entity>>, | ||
| } | ||
|
|
||
| impl RemovedComponentEvents { | ||
| pub fn new() -> Self { | ||
| Self::default() | ||
| } | ||
|
|
||
| pub fn update(&mut self) { | ||
| for (_component_id, events) in self.event_sets.iter_mut() { | ||
| events.update(); | ||
| } | ||
| } | ||
|
|
||
| pub fn get(&self, component_id: impl Into<ComponentId>) -> Option<&Events<Entity>> { | ||
| self.event_sets.get(component_id.into()) | ||
| } | ||
|
|
||
| pub fn send(&mut self, component_id: impl Into<ComponentId>, entity: Entity) { | ||
| self.event_sets | ||
| .get_or_insert_with(component_id.into(), Default::default) | ||
| .send(entity); | ||
| } | ||
| } | ||
|
|
||
| /// A [`SystemParam`] that grants access to the entities that had their `T` [`Component`] removed. | ||
| /// | ||
| /// Note that this does not allow you to see which data existed before removal. | ||
| /// If you need this, you will need to track the component data value on your own, | ||
| /// using a regularly scheduled system that requests `Query<(Entity, &T), Changed<T>>` | ||
| /// and stores the data somewhere safe to later cross-reference. | ||
| /// | ||
| /// If you are using `bevy_ecs` as a standalone crate, | ||
| /// note that the `RemovedComponents` list will not be automatically cleared for you, | ||
| /// and will need to be manually flushed using [`World::clear_trackers`](crate::world::World::clear_trackers) | ||
| /// | ||
| /// For users of `bevy` and `bevy_app`, this is automatically done in `bevy_app::App::update`. | ||
| /// For the main world, [`World::clear_trackers`](crate::world::World::clear_trackers) is run after the main schedule is run and after | ||
| /// `SubApp`'s have run. | ||
| /// | ||
| /// # Examples | ||
| /// | ||
| /// Basic usage: | ||
| /// | ||
| /// ``` | ||
| /// # use bevy_ecs::component::Component; | ||
| /// # use bevy_ecs::system::IntoSystem; | ||
| /// # use bevy_ecs::removal_detection::RemovedComponents; | ||
| /// # | ||
| /// # #[derive(Component)] | ||
| /// # struct MyComponent; | ||
| /// fn react_on_removal(mut removed: RemovedComponents<MyComponent>) { | ||
| /// removed.iter().for_each(|removed_entity| println!("{:?}", removed_entity)); | ||
| /// } | ||
| /// # bevy_ecs::system::assert_is_system(react_on_removal); | ||
| /// ``` | ||
| #[derive(SystemParam)] | ||
| pub struct RemovedComponents<'w, 's, T: Component> { | ||
| component_id: Local<'s, ComponentIdFor<T>>, | ||
| reader: Local<'s, RemovedComponentReader<T>>, | ||
| event_sets: &'w RemovedComponentEvents, | ||
| } | ||
|
|
||
| type RemovedIter<'a> = | ||
| iter::Flatten<option::IntoIter<iter::Cloned<ManualEventIterator<'a, Entity>>>>; | ||
|
|
||
| impl<'w, 's, T: Component> RemovedComponents<'w, 's, T> { | ||
| pub fn iter(&mut self) -> RemovedIter<'_> { | ||
| self.event_sets | ||
| .get(**self.component_id) | ||
| .map(|events| self.reader.iter(events).cloned()) | ||
| .into_iter() | ||
| .flatten() | ||
| } | ||
| } | ||
|
|
||
| impl<'a, 'w, 's: 'a, T> IntoIterator for &'a mut RemovedComponents<'w, 's, T> | ||
| where | ||
| T: Component, | ||
| { | ||
| type Item = Entity; | ||
| type IntoIter = RemovedIter<'a>; | ||
| fn into_iter(self) -> Self::IntoIter { | ||
| self.iter() | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.