Enum UiAction 

pub enum UiAction {
    Up,
    Down,
    Left,
    Right,
    Confirm,
    Cancel,
    Debug,
}

What the generic widgets (a menu), the Key bindings screen and the debug hook react to. A game maps some of its actions onto these with ActionSet::ui; the rest are its own business.

Variants

Up

Move up (a menu’s focus, a cursor).

Down

Move down.

Left

Move left.

Right

Move right.

Confirm

Confirm / select.

Cancel

Cancel / back.

Debug

Open the developer’s debug screens.

Trait Implementations

impl ActionSet for UiAction

The ready-made action set of a game that plays with the six moves: its keymap file names Up, Down, Left, Right, Confirm and Cancel, every one required and rebindable. UiAction::Debug is no action of the set: a game with a debug key writes its own action enum. A UiAction added later stays out of ALL too, so no game’s keymap file must name it (ADR-0036).

type Group = ()

No two actions share a key.

fn is_repeatable(self) -> bool

The four moves repeat while held.

fn is_required(self) -> bool

The six must keep a key: the game can’t be played without one.

const ALL: &'static [Self]

Every action, in the order the game lists them (the order a repair of the saved bindings keeps the first of two claims in).

fn name(self) -> &'static str

The name used in keymap files and the saved bindings.

fn is_rebindable(self) -> bool

Whether the player can rebind it. One that can’t keeps the keymap file’s keys and has no controller button.

fn group(self)

Its Group.

fn ui(self) -> Option<UiAction>

What a generic widget or screen takes it for, if anything.

fn fixed_keys() -> &'static [(Chord, Self)]

The keys every keymap has on top of its own bindings, which the player can’t move or remove (this game: plain Escape cancels). Shown after an action’s own keys in help text, but never counted as a key of its own. A game with none returns &[].

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

Looks an action up by its name (exact match).

fn for_ui(ui: UiAction) -> Option<Self>

The first action that ui maps to ui, if any.

impl Clone for UiAction

fn clone(&self) -> UiAction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for UiAction

impl Debug for UiAction

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

Formats the value using the given formatter.

impl Eq for UiAction

impl Hash for UiAction

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

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 UiAction

fn cmp(&self, other: &UiAction) -> 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 UiAction

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for UiAction

fn partial_cmp(&self, other: &UiAction) -> 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 StructuralPartialEq for UiAction