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

Document input focus helper methods (#16875)

Browse Source 
# Objective

I am suspicious of the command / world helpers for input focus, since
they just provide a trivial helper for setting a resource value.

## Solution

Document that there's nothing magic about them. These can live another
day, but I would also remove them completely if y'all convince me it's
the right choice.
This commit is contained in:
Alice Cecile 2024-12-17 16:16:39 -08:00 committed by GitHub
parent fa6cabd432
commit e55f0e74ea
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
crates/bevy_input_focus/src/lib.rs
View File

@ -46,10 +46,17 @@ pub struct InputFocus(pub Option<Entity>);
pub struct InputFocusVisible(pub bool); pub struct InputFocusVisible(pub bool);
/// Helper functions for [`World`], [`DeferredWorld`] and [`Commands`] to set and clear input focus. /// Helper functions for [`World`], [`DeferredWorld`] and [`Commands`] to set and clear input focus.
///
/// These methods are equivalent to modifying the [`InputFocus`] resource directly,
/// but only take effect when commands are applied.
pub trait SetInputFocus { pub trait SetInputFocus {
/// Set input focus to the given entity. /// Set input focus to the given entity.
///
/// This is equivalent to setting the [`InputFocus`]'s entity to `Some(entity)`.
fn set_input_focus(&mut self, entity: Entity); fn set_input_focus(&mut self, entity: Entity);
/// Clear input focus. /// Clear input focus.
///
/// This is equivalent to setting the [`InputFocus`]'s entity to `None`.
fn clear_input_focus(&mut self); fn clear_input_focus(&mut self);
} }
@ -82,6 +89,8 @@ impl<'w> SetInputFocus for DeferredWorld<'w> {
} }
/// Command to set input focus to the given entity. /// Command to set input focus to the given entity.
///
/// Generated via the methods in [`SetInputFocus`].
pub struct SetFocusCommand(Option<Entity>); pub struct SetFocusCommand(Option<Entity>);
impl Command for SetFocusCommand { impl Command for SetFocusCommand {