Struct Scheme 

pub struct Scheme {

    pub jump: &'static [Key],
    pub jump_pad: &'static [Button],
    pub dash: &'static [Key],
    pub dash_pad: &'static [Button],
    pub grab: &'static [Key],
    pub grab_pad: &'static [Button],
    pub cast: &'static [Key],
    pub cast_pad: &'static [Button],
    pub sprint: &'static [Key],
    pub sprint_pad: &'static [Button],
    pub super_dash: &'static [Key],
    pub super_dash_pad: &'static [Button],
    pub custom: Cow<'static, [Custom]>,
}

Which keys and buttons do what. An action with no keys and no buttons can’t be done.

Fields

jump: &'static [Key]

Jump keys.

jump_pad: &'static [Button]

Jump buttons.

dash: &'static [Key]

Dash keys.

dash_pad: &'static [Button]

Dash buttons.

grab: &'static [Key]

Grab keys (held).

grab_pad: &'static [Button]

Grab buttons (held).

cast: &'static [Key]

Cast keys: with down held, a dive.

cast_pad: &'static [Button]

Cast buttons.

sprint: &'static [Key]

Sprint keys (held).

sprint_pad: &'static [Button]

Sprint buttons (held).

super_dash: &'static [Key]

Super dash keys (held).

super_dash_pad: &'static [Button]

Super dash buttons (held).

custom: Cow<'static, [Custom]>

Your game’s own buttons, read into Intent::custom and Intent::custom_pressed. The built-in schemes have none; add yours with Scheme { custom: Cow::Borrowed(&[...]), ..Scheme::SNAPPY }, or at runtime (a key-rebinding menu) with Scheme::bind.

Implementations

impl Scheme

pub const SNAPPY: Scheme

After Hollow Knight’s default layout, plus grab and sprint. The hybrid, snappy and drifter presets’ scheme.

pub const PRECISE: Scheme

After Celeste’s default layout. The precise preset’s scheme.

pub const MOMENTUM: Scheme

After Super Meat Boy’s: jump, and hold to run. The momentum preset’s scheme.

pub fn bind( &mut self, bit: u8, keys: impl Into<Cow<'static, [Key]>>, pad: impl Into<Cow<'static, [Button]>>, )

Bind custom button bit to keys and pad from now on (a key-rebinding menu), replacing what it was bound to, or adding it if it wasn’t.

pub fn of(preset: Option<Preset>) -> Self

The control scheme that goes with a feel preset (None: Hollow Knight’s).

Trait Implementations

impl Clone for Scheme

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Scheme

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

Formats the value using the given formatter.