Skip to main content

KeyBindings

Struct KeyBindings 

Source
pub struct KeyBindings { /* private fields */ }
Expand description

Central key binding registry.

Manages multiple binding groups and provides a unified query interface. Game systems query actions (not raw keys) each frame via is_active().

Implementations§

Source§

impl KeyBindings

Source

pub fn new() -> Self

Source

pub fn add_group(&mut self, group: BindingGroup)

Add a binding group.

Source

pub fn set_group_enabled(&mut self, name: &str, enabled: bool)

Enable or disable a named group.

Source

pub fn is_group_enabled(&self, name: &str) -> bool

Source

pub fn bind(&mut self, action: impl Into<Action>, key: Key)

Add a simple key binding to the default (first enabled) group.

Source

pub fn key_for(&self, action: &str) -> Option<Key>

Query the key for a named action.

Source

pub fn update( &mut self, held: &HashSet<Key>, just_pressed: &HashSet<Key>, just_released: &HashSet<Key>, mouse_delta: (f32, f32), scroll: f32, time: f32, dt: f32, )

Update internal state from raw input this frame. Must be called once per frame before any is_active queries.

Source

pub fn is_active( &self, action: &str, trigger: Trigger, held: &HashSet<Key>, just_pressed: &HashSet<Key>, just_released: &HashSet<Key>, ) -> bool

Returns true if the named action is currently active with the given trigger type.

Source

pub fn just_pressed( &self, action: &str, held: &HashSet<Key>, just_pressed: &HashSet<Key>, just_released: &HashSet<Key>, ) -> bool

Convenience: just pressed.

Source

pub fn is_held( &self, action: &str, held: &HashSet<Key>, just_pressed: &HashSet<Key>, just_released: &HashSet<Key>, ) -> bool

Convenience: held.

Source

pub fn axis(&self, name: &str) -> f32

Get the current value of an analog axis (-1..1).

Source

pub fn all_actions(&self) -> Vec<&str>

List all known actions across all groups.

Source

pub fn display_binding(&self, action: &str) -> Option<&str>

Get the display string for the primary binding of an action.

Source

pub fn remap(&mut self, action: &str, new_key: Key)

Remap an action’s primary binding.

Source

pub fn chord_just_fired(&self, action: &str) -> bool

Check if a chord action fired this frame.

Trait Implementations§

Source§

impl Default for KeyBindings

Source§

fn default() -> KeyBindings

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,