Struct KeySignal

pub struct KeySignal<'buffer> {
    pub keyboard: Address,
    pub character: Option<char>,
    pub keycode: Option<NonZeroU32>,
    pub player: Option<&'buffer str>,
}

Information about a key press or release signal.

Fields

keyboard: Address

The address of the keyboard component.

character: Option<char>

The character that was pressed or released, if any.

This is None if the signal does not produce a character. Examples of non-character-producing key signals are signals related to lock keys, arrow keys, modifier keys, navigation keys, or other special keys.

keycode: Option<NonZeroU32>

The keycode that was pressed or released, if any.

This is None if the signal does not have a keycode. One example of a non-keycode-producing key signal is a composed character; in this case, the individual keystrokes are not reported, but the composed character is reported as a character without associated keycode. Another example is a Windows key (aka super key) or Menu key, both of which (under some operating systems at least) send key signals with neither character nor keycode filled in.

player: Option<&'buffer str>

The name of the player who pressed or released the key.

This is None if reporting of player names is disabled in the mod configuration.

Implementations

impl<'buffer> KeySignal<'buffer>

pub const KEY_DOWN: &'static str = "key_down"

The name of the signal sent when a key is pressed.

This includes typematic repeats of held keys.

pub const KEY_UP: &'static str = "key_up"

The name of the signal sent when a key is released.

pub fn to_basic(&self) -> BasicKeySignal

Discards the player name information from this value.

Trait Implementations

impl<'buffer> Clone for KeySignal<'buffer>

fn clone(&self) -> KeySignal<'buffer>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'buffer> Debug for KeySignal<'buffer>

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

Formats the value using the given formatter.

impl<'bytes: 'buffer, 'buffer, Ctx> Decode<'bytes, Ctx> for KeySignal<'buffer>

fn decode( __d777: &mut Decoder<'bytes>, __ctx777: &mut Ctx, ) -> Result<KeySignal<'buffer>, Error>

Decode a value using the given Decoder.

fn nil() -> Option<Self>

If possible, return a nil value of Self.

impl<'buffer> From<&KeySignal<'buffer>> for BasicKeySignal

fn from(source: &KeySignal<'buffer>) -> Self

Converts to this type from the input type.

impl<'buffer> Hash for KeySignal<'buffer>

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<'buffer> Ord for KeySignal<'buffer>

fn cmp(&self, other: &KeySignal<'buffer>) -> 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<'buffer> PartialEq for KeySignal<'buffer>

fn eq(&self, other: &KeySignal<'buffer>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'buffer> PartialOrd for KeySignal<'buffer>

fn partial_cmp(&self, other: &KeySignal<'buffer>) -> 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<'buffer> Eq for KeySignal<'buffer>

impl<'buffer> StructuralPartialEq for KeySignal<'buffer>