Struct PadBindings 

pub struct PadBindings<A: ActionSet> { /* private fields */ }

The player-edited controller buttons: every rebindable action’s button slots, each holding a button or a button chord (ticket 1034; a chord and its buttons on their own are different bindings). One setup for both keyboard layouts (docs/design/controls.md, Rebinding buttons); no button is reserved, and both sticks’ directions count as buttons.

The pure editing API for the Key bindings screen (0816), the same shape as LayoutBindings: bind, clear, defaults (restore defaults), unmapped_required.

Implementations

impl<A: ActionSet> PadBindings<A>

pub fn defaults(def: &KeymapDef<A>) -> Self

The default buttons from keymap.ron’s pad table, each action’s buttons in its slots in file order.

pub fn slots(&self, action: A) -> ButtonSlots

action’s button slots (all empty for Debug, which has none).

pub fn find( &self, group: A::Group, button: impl Into<ButtonChord>, ) -> Option<(A, usize)>

The slot of one of group’s actions holding button (a button or a button chord), if any.

pub fn bind( &mut self, action: A, i: usize, button: impl Into<ButtonChord>, ) -> Result<Option<(A, usize)>, BindError<A>>

Puts button (a button or a button chord) in action’s slot i, replacing what was there. If button was in another slot (of any action of action’s group, including action), that slot is emptied and returned: the button moves, which may leave that action with no button. An action of another group keeps it.

pub fn clear(&mut self, action: A, i: usize)

Empties action’s slot i (nothing happens for a slot that doesn’t exist).

pub fn is_unmapped(&self, action: A) -> bool

Whether every slot of action is empty (shows ! not mapped).

pub fn unmapped_required(&self) -> Vec<A>

The required actions with no button, in ActionSet::ALL order. The Key bindings screen can’t be left while this isn’t empty.

pub fn pairs(&self) -> impl Iterator<Item = (ButtonChord, A)> + '_

Every bound button and button chord with its action, for Keymap::with_pad: in action then slot order.

Trait Implementations

impl<A: Clone + ActionSet> Clone for PadBindings<A>

fn clone(&self) -> PadBindings<A>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<A: Debug + ActionSet> Debug for PadBindings<A>

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

Formats the value using the given formatter.

impl<A: Eq + ActionSet> Eq for PadBindings<A>

impl<A: PartialEq + ActionSet> PartialEq for PadBindings<A>

fn eq(&self, other: &PadBindings<A>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<A: PartialEq + ActionSet> StructuralPartialEq for PadBindings<A>