Struct KeyRegistration 

#[non_exhaustive]
pub struct KeyRegistration {
    pub id: String,
    pub label: String,
    pub key: String,
    pub modifiers: ClientModifiers,
    pub category: String,
    pub context: KeyConflictContext,
}

A key a mod registers through Registrar::register_key_mapping: it is listed under the mod’s name on Options > Controls, and the player’s binding and reset are kept by mod id in horizon-mods.txt. Its default is key with modifiers held; shift, control and alt are bound, super is not.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: String

The key’s id, unique within its mod (zoom).

label: String

The translation key for the label Controls shows.

key: String

The default key (key.keyboard.z).

modifiers: ClientModifiers

The default modifiers, in GLFW’s input-event encoding (shift 1, control 2, alt 4).

category: String

The category translation key within its mod’s heading; empty for none.

context: KeyConflictContext

When this mapping can conflict with another binding.

Implementations

impl KeyRegistration

pub fn context(self, context: KeyConflictContext) -> KeyRegistration

Sets the conflict context.

pub fn new(id: &str, key: &str) -> KeyRegistration

Key id of the registering mod, bound to key with no modifiers and labelled id.

pub fn label(self, label: &str) -> KeyRegistration

Sets the label translation key Controls shows.

pub fn modifiers(self, modifiers: ClientModifiers) -> KeyRegistration

Sets the modifiers the default binding holds.

pub fn category(self, category: &str) -> KeyRegistration

Sets the category translation key the binding is listed under.

Trait Implementations

impl Clone for KeyRegistration

fn clone(&self) -> KeyRegistration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyRegistration

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

Formats the value using the given formatter.

impl PartialEq for KeyRegistration

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for KeyRegistration

impl Wire for KeyRegistration

const MIN: usize

Minimum encoded size, used to reject impossible collection lengths.

fn put(&self, out: &mut Writer)

Encodes this value, recording failures on the writer.

fn put_owned(self, out: &mut Writer)

Consumes owned data when a resource’s ownership must cross the boundary.

fn take(input: &mut Reader<'_>) -> Result<KeyRegistration, WireError>

Decodes one value, leaving any following bytes for the caller.