feat: CommandBuffer::despawn_recursive

ten3roberts · Nov 6, 2024 · e92527c · e92527c
1 parent e684eb1
commit e92527c
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 3 deletions.
diff --git a/src/commands.rs b/src/commands.rs
@@ -5,9 +5,9 @@ use anyhow::Context;
 
 use crate::{
     buffer::MultiComponentBuffer,
-    component::{ComponentDesc, ComponentValue},
+    component::{dummy, ComponentDesc, ComponentValue},
     writer::{MissingDyn, SingleComponentWriter, WriteDedupDyn},
-    BatchSpawn, Component, Entity, EntityBuilder, World,
+    BatchSpawn, Component, Entity, EntityBuilder, RelationExt, World,
 };
 
 type DeferFn = Box<dyn Fn(&mut World) -> anyhow::Result<()> + Send + Sync>;
@@ -40,6 +40,7 @@ enum Command {
     },
     /// Despawn an entity
     Despawn(Entity),
+    DespawnRecursive(ComponentDesc, Entity),
     /// Remove a component from an entity
     Remove {
         id: Entity,
@@ -86,6 +87,12 @@ impl fmt::Debug for Command {
                 .field("offset", offset)
                 .finish(),
             Self::Despawn(arg0) => f.debug_tuple("Despawn").field(arg0).finish(),
+            Self::DespawnRecursive(relation, arg0) => f
+                .debug_tuple("DespawnRecursive")
+                .field(relation)
+                .field(arg0)
+                .finish(),
+            // Self::DespawnRecursive(arg0) => f.debug_tuple("Despawn").field(arg0).finish(),
             Self::Remove {
                 id,
                 desc: component,
@@ -253,6 +260,17 @@ impl CommandBuffer {
         self
     }
 
+    /// Despawn an entity by id recursively
+    pub fn despawn_recursive<T: ComponentValue>(
+        &mut self,
+        relation: impl RelationExt<T>,
+        id: Entity,
+    ) -> &mut Self {
+        self.commands
+            .push(Command::DespawnRecursive(relation.of(dummy()).desc(), id));
+        self
+    }
+
     /// Defer a function to execute upon the world.
     ///
     /// Errors will be propagated.
@@ -326,6 +344,10 @@ impl CommandBuffer {
                     .despawn(id)
                     .map_err(|v| v.into_anyhow())
                     .context("Failed to despawn entity")?,
+                Command::DespawnRecursive(relation, id) => world
+                    .despawn_recursive_untyped(id, relation.key().id())
+                    .map_err(|v| v.into_anyhow())
+                    .context("Failed to despawn entity")?,
                 Command::Remove { id, desc } => world
                     .remove_dyn(id, desc)
                     .map_err(|v| v.into_anyhow())

diff --git a/src/world.rs b/src/world.rs
@@ -419,12 +419,27 @@ impl World {
         Ok(())
     }
 
+    /// Despawns an entity and all connected entities through the supplied
+    /// relation
+    pub fn despawn_recursive_untyped(&mut self, id: Entity, relation: Entity) -> Result<()> {
+        profile_function!();
+        self.despawn_children_untyped(id, relation)?;
+        self.despawn(id)?;
+
+        Ok(())
+    }
+
     /// Despawns all children of an entity recursively
     pub fn despawn_children<T: ComponentValue>(
         &mut self,
         id: Entity,
         relation: impl RelationExt<T>,
     ) -> Result<()> {
+        self.despawn_children_untyped(id, relation.id())
+    }
+
+    /// Despawns all children of an entity recursively
+    pub fn despawn_children_untyped(&mut self, id: Entity, relation: Entity) -> Result<()> {
         profile_function!();
         self.flush_reserved();
 
@@ -436,7 +451,7 @@ impl World {
             archetypes.extend(
                 self.archetypes
                     .index
-                    .find(relation.of(id).key())
+                    .find(ComponentKey::new(relation, Some(id)))
                     .into_iter()
                     .flat_map(|v| v.keys().copied()),
             );