6ec6a55645
# Objective
- Crate-level prelude modules, such as `bevy_ecs::prelude`, are plagued
with inconsistency! Let's fix it!
## Solution
Format all preludes based on the following rules:
1. All preludes should have brief documentation in the format of:
> The _name_ prelude.
>
> This includes the most common types in this crate, re-exported for
your convenience.
2. All documentation should be outer, not inner. (`///` instead of
`//!`.)
3. No prelude modules should be annotated with `#[doc(hidden)]`. (Items
within them may, though I'm not sure why this was done.)
## Testing
- I manually searched for the term `mod prelude` and updated all
occurrences by hand. 🫠
---------
Co-authored-by: Gino Valente <49806985+MrGVSV@users.noreply.github.com>
104 lines
3.2 KiB
Rust
Executable File
104 lines
3.2 KiB
Rust
Executable File
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
|
#![forbid(unsafe_code)]
|
|
#![doc(
|
|
html_logo_url = "https://bevyengine.org/assets/icon.png",
|
|
html_favicon_url = "https://bevyengine.org/assets/icon.png"
|
|
)]
|
|
|
|
//! Parent-child relationships for Bevy entities.
|
|
//!
|
|
//! You should use the tools in this crate
|
|
//! whenever you want to organize your entities in a hierarchical fashion,
|
|
//! to make groups of entities more manageable,
|
|
//! or to propagate properties throughout the entity hierarchy.
|
|
//!
|
|
//! This crate introduces various tools, including a [plugin]
|
|
//! for managing parent-child relationships between entities.
|
|
//! It provides two components, [`Parent`] and [`Children`],
|
|
//! to store references to related entities.
|
|
//! It also provides [command and world] API extensions
|
|
//! to set and clear those relationships.
|
|
//!
|
|
//! More advanced users may also appreciate
|
|
//! [query extension methods] to traverse hierarchies,
|
|
//! and [events] to notify hierarchical changes.
|
|
//! There is also a [diagnostic plugin] to validate property propagation.
|
|
//!
|
|
//! # Hierarchy management
|
|
//!
|
|
//! The methods defined in this crate fully manage
|
|
//! the components responsible for defining the entity hierarchy.
|
|
//! Mutating these components manually may result in hierarchy invalidation.
|
|
//!
|
|
//! Hierarchical relationships are always managed symmetrically.
|
|
//! For example, assigning a child to an entity
|
|
//! will always set the parent in the other,
|
|
//! and vice versa.
|
|
//! Similarly, unassigning a child in the parent
|
|
//! will always unassign the parent in the child.
|
|
//!
|
|
//! ## Despawning entities
|
|
//!
|
|
//! The commands and methods provided by `bevy_ecs` to despawn entities
|
|
//! are not capable of automatically despawning hierarchies of entities.
|
|
//! In most cases, these operations will invalidate the hierarchy.
|
|
//! Instead, you should use the provided [hierarchical despawn extension methods].
|
|
//!
|
|
//! [command and world]: BuildChildren
|
|
//! [diagnostic plugin]: ValidParentCheckPlugin
|
|
//! [events]: HierarchyEvent
|
|
//! [hierarchical despawn extension methods]: DespawnRecursiveExt
|
|
//! [plugin]: HierarchyPlugin
|
|
//! [query extension methods]: HierarchyQueryExt
|
|
|
|
mod components;
|
|
pub use components::*;
|
|
|
|
mod hierarchy;
|
|
pub use hierarchy::*;
|
|
|
|
mod child_builder;
|
|
pub use child_builder::*;
|
|
|
|
mod events;
|
|
pub use events::*;
|
|
|
|
mod valid_parent_check_plugin;
|
|
pub use valid_parent_check_plugin::*;
|
|
|
|
mod query_extension;
|
|
pub use query_extension::*;
|
|
|
|
/// The hierarchy prelude.
|
|
///
|
|
/// This includes the most common types in this crate, re-exported for your convenience.
|
|
pub mod prelude {
|
|
#[doc(hidden)]
|
|
pub use crate::{child_builder::*, components::*, hierarchy::*, query_extension::*};
|
|
|
|
#[doc(hidden)]
|
|
#[cfg(feature = "bevy_app")]
|
|
pub use crate::{HierarchyPlugin, ValidParentCheckPlugin};
|
|
}
|
|
|
|
#[cfg(feature = "bevy_app")]
|
|
use bevy_app::prelude::*;
|
|
|
|
/// Provides hierarchy functionality to a Bevy app.
|
|
///
|
|
/// Check the [crate-level documentation] for all the features.
|
|
///
|
|
/// [crate-level documentation]: crate
|
|
#[cfg(feature = "bevy_app")]
|
|
#[derive(Default)]
|
|
pub struct HierarchyPlugin;
|
|
|
|
#[cfg(feature = "bevy_app")]
|
|
impl Plugin for HierarchyPlugin {
|
|
fn build(&self, app: &mut App) {
|
|
app.register_type::<Children>()
|
|
.register_type::<Parent>()
|
|
.add_event::<HierarchyEvent>();
|
|
}
|
|
}
|