forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update ChildOf deprecation advice to match new layout (#18089)

Browse Source 
https://github.com/bevyengine/bevy/pull/17905 replaced `ChildOf(entity)`
with `ChildOf { parent: entity }`, but some deprecation advice was
overlooked. Also corrected formatting in documentation.

## Testing

Added a `set_parent` to a random example. Confirmed that the deprecation
warning shows and the advice can be pasted in.
This commit is contained in:
Greeble 2025-02-28 23:15:23 +00:00 committed by GitHub
parent e43b28c1ec
commit 780f658f2c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
crates/bevy_ecs/src/hierarchy.rs
View File

@ -52,9 +52,9 @@ use log::warn;
/// # use bevy_ecs::prelude::*;
/// # let mut world = World::new();
/// let root = world.spawn_empty().id();
/// let child1 = world.spawn(ChildOf {parent: root}).id();
/// let child2 = world.spawn(ChildOf {parent: root}).id();
/// let grandchild = world.spawn(ChildOf {parent: child1}).id();
/// let child1 = world.spawn(ChildOf { parent: root }).id();
/// let child2 = world.spawn(ChildOf { parent: root }).id();
/// let grandchild = world.spawn(ChildOf { parent: child1 }).id();
///
/// assert_eq!(&**world.entity(root).get::<Children>().unwrap(), &[child1, child2]);
/// assert_eq!(&**world.entity(child1).get::<Children>().unwrap(), &[grandchild]);
@ -200,7 +200,10 @@ impl<'w> EntityWorldMut<'w> {
}
/// Inserts the [`ChildOf`] component with the given `parent` entity, if it exists.
#[deprecated(since = "0.16.0", note = "Use entity_mut.insert(ChildOf(entity))")]
#[deprecated(
since = "0.16.0",
note = "Use entity_mut.insert(ChildOf { parent: entity })"
)]
pub fn set_parent(&mut self, parent: Entity) -> &mut Self {
self.insert(ChildOf { parent });
self
@ -246,7 +249,10 @@ impl<'a> EntityCommands<'a> {
}
/// Inserts the [`ChildOf`] component with the given `parent` entity, if it exists.
#[deprecated(since = "0.16.0", note = "Use entity_commands.insert(ChildOf(entity))")]
#[deprecated(
since = "0.16.0",
note = "Use entity_commands.insert(ChildOf { parent: entity })"
)]
pub fn set_parent(&mut self, parent: Entity) -> &mut Self {
self.insert(ChildOf { parent });
self