Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Merged by Bors] - Fix unsound EntityMut::remove_children. Add EntityMut::world_scope #6464

Closed
wants to merge 6 commits into from
Closed

[Merged by Bors] - Fix unsound EntityMut::remove_children. Add EntityMut::world_scope #6464

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4dc6e04
Well, that was a lie.
tim-blackbird Nov 1, 2022
06f2774
Remove unhelpful safety comments.
tim-blackbird Nov 1, 2022
5fe9581
reworded
tim-blackbird Nov 1, 2022
9483f1a
reworded again
tim-blackbird Nov 4, 2022
4453650
remove unnecessary unsafe
tim-blackbird Nov 4, 2022
201a3f9
Add `EntityMut::world_scope`
tim-blackbird Nov 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions crates/bevy_hierarchy/src/child_builder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -461,8 +461,7 @@ impl<'w> BuildWorldChildren for EntityMut<'w> {
let mut builder = WorldChildBuilder {
current_entity: None,
parent_entities: vec![entity],
// SAFETY: self.update_location() is called below. It is impossible to make EntityMut
// function calls on `self` within the scope defined here
// SAFETY: The EntityLocation is updated before any other methods are called on self.
world: unsafe { self.world_mut() },
};

Expand All @@ -475,10 +474,9 @@ impl<'w> BuildWorldChildren for EntityMut<'w> {
fn push_children(&mut self, children: &[Entity]) -> &mut Self {
let parent = self.id();
{
// SAFETY: parent entity is not modified and its location is updated manually
// SAFETY: The EntityLocation is updated before any other methods are called on self.
let world = unsafe { self.world_mut() };
update_old_parents(world, parent, children);
// Inserting a bundle in the children entities may change the parent entity's location if they were of the same archetype
self.update_location();
}
if let Some(mut children_component) = self.get_mut::<Children>() {
Expand All @@ -495,10 +493,9 @@ impl<'w> BuildWorldChildren for EntityMut<'w> {
fn insert_children(&mut self, index: usize, children: &[Entity]) -> &mut Self {
let parent = self.id();
{
// SAFETY: parent entity is not modified and its location is updated manually
// SAFETY: The EntityLocation is updated before any other methods are called on self.
let world = unsafe { self.world_mut() };
update_old_parents(world, parent, children);
// Inserting a bundle in the children entities may change the parent entity's location if they were of the same archetype
self.update_location();
}

Expand All @@ -515,9 +512,10 @@ impl<'w> BuildWorldChildren for EntityMut<'w> {

fn remove_children(&mut self, children: &[Entity]) -> &mut Self {
let parent = self.id();
// SAFETY: This doesn't change the parent's location
// SAFETY: The EntityLocation is updated before any other methods are called on self.
let world = unsafe { self.world_mut() };
remove_children(parent, children, world);
self.update_location();
self
}
}
Expand Down