Complete test suite for world methods

Author: makspll

crates/bevy_mod_scripting_core/src/bindings/world.rs

@@ -185,6 +185,11 @@ impl WorldCallbackAccess {
         world.has_resource(resource_id)
     }
 
+    pub fn has_entity(&self, entity: Entity) -> bool {
+        let world = self.read().unwrap_or_else(|| panic!("{STALE_WORLD_MSG}"));
+        world.has_entity(entity)
+    }
+
     pub fn get_children(&self, entity: Entity) -> ScriptResult<Vec<Entity>> {
         let world = self.read().unwrap_or_else(|| panic!("{STALE_WORLD_MSG}"));
         world.get_children(entity)
@@ -588,6 +593,11 @@ impl<'w> WorldAccessGuard<'w> {
             ))
         }
     }
+
+    /// checks if a given entity exists and is valid
+    pub fn is_valid_entity(&self, entity: Entity) -> bool {
+        self.cell.get_entity(entity).is_some()
+    }
 }
 
 /// Impl block for higher level world methods
@@ -773,7 +783,18 @@ impl<'w> WorldAccessGuard<'w> {
         res_ptr.is_some()
     }
 
+    pub fn has_entity(&self, entity: Entity) -> bool {
+        self.is_valid_entity(entity)
+    }
+
     pub fn get_children(&self, entity: Entity) -> ScriptResult<Vec<Entity>> {
+        if !self.is_valid_entity(entity) {
+            return Err(ScriptError::new_runtime_error(format!(
+                "Entity does not exist or is not valid: {:?}",
+                entity
+            )));
+        }
+
         let access = self
             .get_component_access_typed::<Children>()
             .unwrap_or_else(|| panic!("{CONCURRENT_ACCESS_MSG}"));
@@ -785,6 +806,13 @@ impl<'w> WorldAccessGuard<'w> {
     }
 
     pub fn get_parent(&self, entity: Entity) -> ScriptResult<Option<Entity>> {
+        if !self.is_valid_entity(entity) {
+            return Err(ScriptError::new_runtime_error(format!(
+                "Entity does not exist or is not valid: {:?}",
+                entity
+            )));
+        }
+
         let access = self
             .get_component_access_typed::<Parent>()
             .unwrap_or_else(|| panic!("{CONCURRENT_ACCESS_MSG}"));
@@ -795,6 +823,22 @@ impl<'w> WorldAccessGuard<'w> {
     }
 
     pub fn push_children(&self, parent: Entity, children: &[Entity]) -> ScriptResult<()> {
+        // verify entities exist
+        if !self.is_valid_entity(parent) {
+            return Err(ScriptError::new_runtime_error(format!(
+                "The parent Entity does not exist or is not valid: {:?}",
+                parent
+            )));
+        }
+        for c in children {
+            if !self.is_valid_entity(*c) {
+                return Err(ScriptError::new_runtime_error(format!(
+                    "the Entity does not exist or is not valid: {:?}",
+                    c
+                )));
+            }
+        }
+
         if let Some(world) = self.get_whole_world_access() {
             let mut queue = CommandQueue::default();
             let mut commands = Commands::new(&mut queue, world);
@@ -808,6 +852,22 @@ impl<'w> WorldAccessGuard<'w> {
     }
 
     pub fn remove_children(&self, parent: Entity, children: &[Entity]) -> ScriptResult<()> {
+        if !self.is_valid_entity(parent) {
+            return Err(ScriptError::new_runtime_error(format!(
+                "The parent Entity does not exist or is not valid: {:?}",
+                parent
+            )));
+        }
+
+        for c in children {
+            if !self.is_valid_entity(*c) {
+                return Err(ScriptError::new_runtime_error(format!(
+                    "the Entity does not exist or is not valid: {:?}",
+                    c
+                )));
+            }
+        }
+
         if let Some(world) = self.get_whole_world_access() {
             let mut queue = CommandQueue::default();
             let mut commands = Commands::new(&mut queue, world);
@@ -826,6 +886,22 @@ impl<'w> WorldAccessGuard<'w> {
         index: usize,
         children: &[Entity],
     ) -> ScriptResult<()> {
+        if !self.is_valid_entity(parent) {
+            return Err(ScriptError::new_runtime_error(format!(
+                "parent Entity does not exist or is not valid: {:?}",
+                parent
+            )));
+        }
+
+        for c in children {
+            if !self.is_valid_entity(*c) {
+                return Err(ScriptError::new_runtime_error(format!(
+                    "the Entity does not exist or is not valid: {:?}",
+                    c
+                )));
+            }
+        }
+
         if let Some(world) = self.get_whole_world_access() {
             let mut queue = CommandQueue::default();
             let mut commands = Commands::new(&mut queue, world);
@@ -838,11 +914,18 @@ impl<'w> WorldAccessGuard<'w> {
         Ok(())
     }
 
-    pub fn despawn_recursive(&self, entity: Entity) -> ScriptResult<()> {
+    pub fn despawn_recursive(&self, parent: Entity) -> ScriptResult<()> {
+        if !self.is_valid_entity(parent) {
+            return Err(ScriptError::new_runtime_error(format!(
+                "parent Entity does not exist or is not valid: {:?}",
+                parent
+            )));
+        }
+
         if let Some(world) = self.get_whole_world_access() {
             let mut queue = CommandQueue::default();
             let mut commands = Commands::new(&mut queue, world);
-            commands.entity(entity).despawn_recursive();
+            commands.entity(parent).despawn_recursive();
             queue.apply(world);
         } else {
             panic!("{CONCURRENT_WORLD_ACCESS_MSG}")
@@ -852,6 +935,13 @@ impl<'w> WorldAccessGuard<'w> {
     }
 
     pub fn despawn(&self, entity: Entity) -> ScriptResult<()> {
+        if !self.is_valid_entity(entity) {
+            return Err(ScriptError::new_runtime_error(format!(
+                "Entity does not exist or is not valid: {:?}",
+                entity
+            )));
+        }
+
         if let Some(world) = self.get_whole_world_access() {
             let mut queue = CommandQueue::default();
             let mut commands = Commands::new(&mut queue, world);
@@ -864,11 +954,18 @@ impl<'w> WorldAccessGuard<'w> {
         Ok(())
     }
 
-    pub fn despawn_descendants(&self, entity: Entity) -> ScriptResult<()> {
+    pub fn despawn_descendants(&self, parent: Entity) -> ScriptResult<()> {
+        if !self.is_valid_entity(parent) {
+            return Err(ScriptError::new_runtime_error(format!(
+                "parent Entity does not exist or is not valid: {:?}",
+                parent
+            )));
+        }
+
         if let Some(world) = self.get_whole_world_access() {
             let mut queue = CommandQueue::default();
             let mut commands = Commands::new(&mut queue, world);
-            commands.entity(entity).despawn_descendants();
+            commands.entity(parent).despawn_descendants();
             queue.apply(world);
         } else {
             panic!("{CONCURRENT_WORLD_ACCESS_MSG}")

crates/languages/bevy_mod_scripting_lua/src/bindings/world.rs

@@ -236,6 +236,20 @@ impl TealData for LuaWorld {
             },
         );
 
+        methods.add_method(
+            "has_entity",
+            |_, this, entity: LuaReflectValProxy<Entity>| {
+                let world = this.0.read().ok_or_else(|| {
+                    mlua::Error::external(ScriptError::new_reflection_error("Stale world access"))
+                })?;
+                let out: bool = world
+                    .proxy_call(entity, |entity| world.has_entity(entity))
+                    .map_err(mlua::Error::external)?;
+
+                Ok(out)
+            },
+        );
+
         methods.add_method(
             "get_children",
             |_, this, entity: LuaReflectValProxy<Entity>| {
@@ -315,7 +329,7 @@ impl TealData for LuaWorld {
                 })?;
                 let out: Result<(), ErrorProxy<ScriptError>> = world
                     .proxy_call(args, |(parent, index, children)| {
-                        world.insert_children(parent, index, &children)
+                        world.insert_children(parent, index - 1, &children)
                     })
                     .map_err(mlua::Error::external)?;
 

crates/languages/bevy_mod_scripting_lua/tests/data/despawn/despawns_only_root.lua

@@ -0,0 +1,7 @@
+local entity = world:spawn()
+local child = world:spawn()
+world:push_children(entity, {child})
+world:despawn(entity)
+
+assert(world:has_entity(entity) == false, "Parent should be despawned")
+assert(world:has_entity(child) == true, "Child should not be despawned")

crates/languages/bevy_mod_scripting_lua/tests/data/despawn/invalid_entity_errors.lua

@@ -0,0 +1,3 @@
+assert_throws(function()
+    world:despawn_recursive(Entity.from_raw(9999))
+end, "parent Entity does not exist")

crates/languages/bevy_mod_scripting_lua/tests/data/despawn_descendants/despawns_only_child.lua

@@ -0,0 +1,7 @@
+local entity = world:spawn()
+local child = world:spawn()
+world:push_children(entity, {child})
+world:despawn_descendants(entity)
+
+assert(world:has_entity(entity) == true, "Parent should not be despawned")
+assert(world:has_entity(child) == false, "Child should be despawned")

crates/languages/bevy_mod_scripting_lua/tests/data/despawn_descendants/invalid_entity_errors.lua

@@ -0,0 +1,3 @@
+assert_throws(function()
+    world:despawn_recursive(Entity.from_raw(9999))
+end, "parent Entity does not exist")

crates/languages/bevy_mod_scripting_lua/tests/data/despawn_recursive/despawns_recursively.lua

@@ -0,0 +1,7 @@
+local entity = world:spawn()
+local child = world:spawn()
+world:push_children(entity, {child})
+world:despawn_recursive(entity)
+
+assert(world:has_entity(entity) == false, "Parent should be despawned")
+assert(world:has_entity(child) == false, "Child should be despawned")

crates/languages/bevy_mod_scripting_lua/tests/data/despawn_recursive/invalid_entity_errors.lua

@@ -0,0 +1,3 @@
+assert_throws(function()
+    world:despawn_recursive(Entity.from_raw(9999))
+end, "parent Entity does not exist")

crates/languages/bevy_mod_scripting_lua/tests/data/get_children/has_children_returns_them.lua

@@ -0,0 +1,9 @@
+local entity = world:spawn()
+local child = world:spawn(entity)
+
+world:push_children(entity, {child})
+
+local children = world:get_children(entity)
+
+assert(#children == 1, "Expected 1 child")
+assert(children[1]:index() == child:index(), "Child is the wrong entity")

crates/languages/bevy_mod_scripting_lua/tests/data/get_children/invalid_entity_errors.lua

@@ -0,0 +1,4 @@
+
+assert_throws(function() 
+    world:get_children(Entity.from_raw(9999))
+end, "Entity does not exist")