6ddd0f16a8
# Objective I set out with one simple goal: clearly document the differences between each of the component lifecycle events via module docs. Unfortunately, no such module existed: the various lifecycle code was scattered to the wind. Without a unified module, it's very hard to discover the related types, and there's nowhere good to put my shiny new documentation. ## Solution 1. Unify the assorted types into a single `bevy_ecs::component_lifecycle` module. 2. Write docs. 3. Write a migration guide. ## Testing Thanks CI! ## Follow-up 1. The lifecycle event names are pretty confusing, especially `OnReplace`. We should consider renaming those. No bikeshedding in my PR though! 2. Observers need real module docs too :( 3. Any additional functional changes should be done elsewhere; this is a simple docs and re-org PR. --------- Co-authored-by: theotherphil <phil.j.ellison@gmail.com>
31 lines
988 B
Rust
31 lines
988 B
Rust
//! Contains the [`AutoFocus`] component and related machinery.
|
|
|
|
use bevy_ecs::{lifecycle::HookContext, prelude::*, world::DeferredWorld};
|
|
|
|
use crate::InputFocus;
|
|
|
|
#[cfg(feature = "bevy_reflect")]
|
|
use bevy_reflect::{prelude::*, Reflect};
|
|
|
|
/// Indicates that this widget should automatically receive [`InputFocus`].
|
|
///
|
|
/// This can be useful for things like dialog boxes, the first text input in a form,
|
|
/// or the first button in a game menu.
|
|
///
|
|
/// The focus is swapped when this component is added
|
|
/// or an entity with this component is spawned.
|
|
#[derive(Debug, Default, Component, Copy, Clone)]
|
|
#[cfg_attr(
|
|
feature = "bevy_reflect",
|
|
derive(Reflect),
|
|
reflect(Debug, Default, Component, Clone)
|
|
)]
|
|
#[component(on_add = on_auto_focus_added)]
|
|
pub struct AutoFocus;
|
|
|
|
fn on_auto_focus_added(mut world: DeferredWorld, HookContext { entity, .. }: HookContext) {
|
|
if let Some(mut input_focus) = world.get_resource_mut::<InputFocus>() {
|
|
input_focus.set(entity);
|
|
}
|
|
}
|