Struct IsFocusedHelper

pub struct IsFocusedHelper<'w, 's> { /* private fields */ }

A system param that helps get information about the current focused entity.

When working with the entire World, consider using the IsFocused instead.

Trait Implementations

impl IsFocused for IsFocusedHelper<'_, '_>

fn is_focused(&self, entity: Entity) -> bool

Returns true if the given entity has input focus.

fn is_focus_within(&self, entity: Entity) -> bool

Returns true if the given entity or any of its descendants has input focus.

fn is_focus_visible(&self, entity: Entity) -> bool

Returns true if the given entity has input focus and the focus indicator should be visible.

fn is_focus_within_visible(&self, entity: Entity) -> bool

Returns true if the given entity, or any descendant, has input focus and the focus indicator should be visible.

impl SystemParam for IsFocusedHelper<'_, '_>

type State = FetchState

Used to store data which persists across invocations of a system.

type Item<'w, 's> = IsFocusedHelper<'w, 's>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes.

fn init_state(world: &mut World, system_meta: &mut SystemMeta) -> Self::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.

unsafe fn new_archetype( state: &mut Self::State, archetype: &Archetype, system_meta: &mut SystemMeta, )

For the specified Archetype, registers the components accessed by this SystemParam (if applicable).a

fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)

Applies any deferred mutations stored in this SystemParam’s state. This is used to apply Commands during ApplyDeferred.

fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )

Queues any deferred mutations to be applied at the next ApplyDeferred.

unsafe fn validate_param<'w, 's>( state: &'s Self::State, _system_meta: &SystemMeta, _world: UnsafeWorldCell<'w>, ) -> Result<(), SystemParamValidationError>

Validates that the param can be acquired by the get_param.

unsafe fn get_param<'w, 's>( state: &'s mut Self::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick, ) -> Self::Item<'w, 's>

Creates a parameter to be passed into a SystemParamFunction.

impl<'w, 's> ReadOnlySystemParam for IsFocusedHelper<'w, 's>

where Query<'w, 's, &'static ChildOf>: ReadOnlySystemParam, Option<Res<'w, InputFocus>>: ReadOnlySystemParam, Option<Res<'w, InputFocusVisible>>: ReadOnlySystemParam,