Enum Button 

pub enum Button {
    South,
    East,
    West,
    North,
    LeftShoulder,
    RightShoulder,
    LeftTrigger,
    RightTrigger,
    Select,
    Start,
    LeftStickPress,
    RightStickPress,
    DpadUp,
    DpadDown,
    DpadLeft,
    DpadRight,
    LeftStickUp,
    LeftStickDown,
    LeftStickLeft,
    LeftStickRight,
    RightStickUp,
    RightStickDown,
    RightStickLeft,
    RightStickRight,
    CrankBack,
    CrankForward,
    SystemMenu0,
    SystemMenu1,
    SystemMenu2,
    SystemMenu3,
    SystemMenu4,
    SystemMenu5,
    SystemMenu6,
    SystemMenu7,
}

A controller button, named by its position on an Xbox-shaped pad, whatever is printed on it (game ADR-0034). Each stick’s four directions count as buttons too, and so does a crank wound one notch either way (the Playdate’s, ticket 1035: pressed and let go once per notch), and so does an item of the game’s own in the system’s menu (pressed and let go when the player picks it, ADR-0008 §3). app translates what the platform reports to these; anything else on a pad is ignored, and so are the system’s own buttons (the Playdate’s Menu and Lock, the Deck’s Steam and Quick Access), which no keymap can name.

The first 16 are in the order of the browser Gamepad API’s “standard” mapping.

Variants

South

The bottom face button (Xbox A).

East

The right face button (Xbox B).

West

The left face button (Xbox X).

North

The top face button (Xbox Y).

LeftShoulder

The left shoulder button (Xbox LB).

RightShoulder

The right shoulder button (Xbox RB).

LeftTrigger

The left trigger (Xbox LT), pulled far enough to count as pressed.

RightTrigger

The right trigger (Xbox RT), pulled far enough to count as pressed.

Select

The left centre button (Xbox Back).

Start

The right centre button (Xbox Start).

LeftStickPress

Pressing the left stick in.

RightStickPress

Pressing the right stick in.

DpadUp

D-pad up.

DpadDown

D-pad down.

DpadLeft

D-pad left.

DpadRight

D-pad right.

LeftStickUp

The left stick pushed up.

LeftStickDown

The left stick pushed down.

LeftStickLeft

The left stick pushed left.

LeftStickRight

The left stick pushed right.

RightStickUp

The right stick pushed up.

RightStickDown

The right stick pushed down.

RightStickLeft

The right stick pushed left.

RightStickRight

The right stick pushed right.

CrankBack

The crank wound one notch backwards (counterclockwise).

CrankForward

The crank wound one notch forwards (clockwise).

SystemMenu0

The first item of the game’s own in the system’s menu.

SystemMenu1

The second item of the game’s own in the system’s menu.

SystemMenu2

The third item of the game’s own in the system’s menu.

SystemMenu3

The fourth item of the game’s own in the system’s menu.

SystemMenu4

The fifth item of the game’s own in the system’s menu.

SystemMenu5

The sixth item of the game’s own in the system’s menu.

SystemMenu6

The seventh item of the game’s own in the system’s menu.

SystemMenu7

The eighth item of the game’s own in the system’s menu.

Implementations

impl Button

pub const ALL: &'static [Button]

Every button, in declaration order.

pub fn name(self) -> &'static str

The name used in keymap files (the variant name).

impl Button

pub fn system_menu(slot: u8) -> Option<Button>

The system menu’s item slot (from 0), if a keymap can name it (below SYSTEM_MENU_ITEMS).

pub fn system_menu_slot(self) -> Option<u8>

Which item of the system’s menu this is (from 0), if it is one.

pub fn from_name(name: &str) -> Option<Button>

Looks a button up by its name (exact match).

pub fn parse(s: &str) -> Result<Button, String>

Parses a keymap-file button name: "South", "DpadUp", "LeftStickLeft", …

Trait Implementations

impl Clone for Button

fn clone(&self) -> Button

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Button

impl Debug for Button

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Button

fn deserialize<D>( deserializer: D, ) -> Result<Button, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Button

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

Formats the value using the given formatter.

impl Eq for Button

impl From<Button> for ButtonChord

fn from(button: Button) -> ButtonChord

Converts to this type from the input type.

impl FromIterator<Button> for ButtonSet

fn from_iter<I: IntoIterator<Item = Button>>(buttons: I) -> Self

Creates a value from an iterator.

impl FromStr for Button

type Err = String

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Button, <Button as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Button

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Button

fn cmp(&self, other: &Button) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Button

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<Button> for ButtonChord

A binding is a button when it is that button on its own.

fn eq(&self, button: &Button) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Button

fn partial_cmp(&self, other: &Button) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Button

A button in a data file (a target’s inputs, shuyi_assets::target) and in a baked keymap (pack) is its name.

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Button