76744bf58c
# Objective As discussed in #15341, ghost nodes are a contentious and experimental feature. In the interest of enabling ecosystem experimentation, we've decided to keep them in Bevy 0.15. That said, we don't use them internally, and don't expect third-party crates to support them. If the experimentation returns a negative result (they aren't very useful, an alternative design is preferred etc) they will be removed. We should clearly communicate this status to users, and make sure that users don't use ghost nodes in their projects without a very clear understanding of what they're getting themselves into. ## Solution To make life easy for users (and Bevy), `GhostNode` and all associated helpers remain public and are always available. However, actually constructing these requires enabling a feature flag that's clearly marked as experimental. To do so, I've added a meaningless private field. When the feature flag is enabled, our constructs (`new` and `default`) can be used. I've added a `new` constructor, which should be preferred over `Default::default` as that can be readily deprecated, allowing us to prompt users to swap over to the much nicer `GhostNode` syntax once this is a unit struct again. Full credit: this was mostly @cart's design: I'm just implementing it! ## Testing I've run the ghost_nodes example and it fails to compile without the feature flag. With the feature flag, it works fine :) --------- Co-authored-by: Zachary Harrold <zac@harrold.com.au>
18 lines
658 B
Rust
18 lines
658 B
Rust
//! Experimental features are not yet stable and may change or be removed in the future.
|
|
//!
|
|
//! These features are not recommended for production use, but are available to ease experimentation
|
|
//! within Bevy's ecosystem. Please let us know how you are using these features and what you would
|
|
//! like to see improved!
|
|
//!
|
|
//! These may be feature-flagged: check the `Cargo.toml` for `bevy_ui` to see what options
|
|
//! are available.
|
|
//!
|
|
//! # Warning
|
|
//!
|
|
//! Be careful when using these features, especially in concert with third-party crates,
|
|
//! as they may not be fully supported, functional or stable.
|
|
|
|
mod ghost_hierarchy;
|
|
|
|
pub use ghost_hierarchy::*;
|