Skip to content

Document return behavior for child "spawning" commands. #21933

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+2 −0
Open

Document return behavior for child "spawning" commands. #21933

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions crates/bevy_ecs/src/hierarchy.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,7 @@ impl<'w> EntityWorldMut<'w> {
}

/// Spawns the passed bundle and adds it to this entity as a child.
/// Returns &mut [`EntityWorldMut`] for parent.
Copy link
Member

@mockersf mockersf Nov 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is called on entity, and spawn the bundle as its child. so if we use the "parent" word here, it would be the parent of the first entity which doesn't make sense

Copy link
Contributor Author

@newclarityex newclarityex Nov 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How do you think this could be better described?

Copy link
Member

@mockersf mockersf Nov 26, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe "original entity" would be better than parent there? or "initial entity"?

///
/// For efficient spawning of multiple children, use [`with_children`].
///
Expand Down Expand Up @@ -480,6 +481,7 @@ impl<'a> EntityCommands<'a> {
}

/// Spawns the passed bundle and adds it to this entity as a child.
/// Returns &mut [`EntityCommands`] for parent.
Copy link
Member

@mockersf mockersf Nov 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same

///
/// For efficient spawning of multiple children, use [`with_children`].
///
Expand Down