Skip to main content

KeyMap

Struct KeyMap 

Source
pub struct KeyMap {
    pub forward: InputKey,
    pub backward: InputKey,
    pub left: InputKey,
    pub right: InputKey,
    pub sprint: InputKey,
    pub jump: InputKey,
    pub interact: InputKey,
}
Expand description

The canonical action -> key map. Persisted in ControlsSettings and pushed to the active backend. Each field is #[serde(default)] so adding an action in a future build never invalidates an existing settings file (a missing field falls back to its default rather than failing the whole load).

Fields§

§forward: InputKey

InputKey bound to Bindable::Forward.

§backward: InputKey

InputKey bound to Bindable::Backward.

§left: InputKey

InputKey bound to Bindable::Left.

§right: InputKey

InputKey bound to Bindable::Right.

§sprint: InputKey

InputKey bound to Bindable::Sprint.

§jump: InputKey

InputKey bound to Bindable::Jump.

§interact: InputKey

InputKey bound to Bindable::Interact.

Implementations§

Source§

impl KeyMap

Source

pub const DEFAULT: KeyMap

The default bindings: the keys that were hardcoded before rebinding.

Source

pub fn get(self, action: Bindable) -> InputKey

The key currently bound to an action.

Source

pub fn set(&mut self, action: Bindable, key: InputKey)

Bind an action to a key directly (no conflict handling).

Source

pub fn action_for_key(self, key: InputKey) -> Option<Bindable>

The action a key is bound to, or None if unbound. The map keeps each key bound to at most one action (the invariant rebind maintains), so this is the unique holder.

Source

pub fn rebind(&mut self, action: Bindable, new_key: InputKey)

Bind action to new_key, swapping with whichever action already holds new_key so every action stays bound. Rebinding an action to its own key is a no-op.

Trait Implementations§

Source§

impl Clone for KeyMap

Source§

fn clone(&self) -> KeyMap

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for KeyMap

Source§

impl Debug for KeyMap

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for KeyMap

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for KeyMap

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for KeyMap

Source§

impl PartialEq for KeyMap

Source§

fn eq(&self, other: &KeyMap) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for KeyMap

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for KeyMap

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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.