Skip to main content

Key

Struct Key 

Source
pub struct Key { /* private fields */ }

Implementations§

Source§

impl Key

Source

pub const NONE: Key

Godot enumerator name: KEY_NONE

Source

pub const SPECIAL: Key

Godot enumerator name: KEY_SPECIAL

Source

pub const ESCAPE: Key

Godot enumerator name: KEY_ESCAPE

Source

pub const TAB: Key

Godot enumerator name: KEY_TAB

Source

pub const BACKTAB: Key

Godot enumerator name: KEY_BACKTAB

Source

pub const BACKSPACE: Key

Godot enumerator name: KEY_BACKSPACE

Source

pub const ENTER: Key

Godot enumerator name: KEY_ENTER

Source

pub const KP_ENTER: Key

Godot enumerator name: KEY_KP_ENTER

Source

pub const INSERT: Key

Godot enumerator name: KEY_INSERT

Source

pub const DELETE: Key

Godot enumerator name: KEY_DELETE

Source

pub const PAUSE: Key

Godot enumerator name: KEY_PAUSE

Source

pub const PRINT: Key

Godot enumerator name: KEY_PRINT

Source

pub const SYSREQ: Key

Godot enumerator name: KEY_SYSREQ

Source

pub const CLEAR: Key

Godot enumerator name: KEY_CLEAR

Source

pub const HOME: Key

Godot enumerator name: KEY_HOME

Source

pub const END: Key

Godot enumerator name: KEY_END

Source

pub const LEFT: Key

Godot enumerator name: KEY_LEFT

Source

pub const UP: Key

Godot enumerator name: KEY_UP

Source

pub const RIGHT: Key

Godot enumerator name: KEY_RIGHT

Source

pub const DOWN: Key

Godot enumerator name: KEY_DOWN

Source

pub const PAGEUP: Key

Godot enumerator name: KEY_PAGEUP

Source

pub const PAGEDOWN: Key

Godot enumerator name: KEY_PAGEDOWN

Source

pub const SHIFT: Key

Godot enumerator name: KEY_SHIFT

Source

pub const CTRL: Key

Godot enumerator name: KEY_CTRL

Source

pub const META: Key

Godot enumerator name: KEY_META

Source

pub const ALT: Key

Godot enumerator name: KEY_ALT

Source

pub const CAPSLOCK: Key

Godot enumerator name: KEY_CAPSLOCK

Source

pub const NUMLOCK: Key

Godot enumerator name: KEY_NUMLOCK

Source

pub const SCROLLLOCK: Key

Godot enumerator name: KEY_SCROLLLOCK

Source

pub const F1: Key

Godot enumerator name: KEY_F1

Source

pub const F2: Key

Godot enumerator name: KEY_F2

Source

pub const F3: Key

Godot enumerator name: KEY_F3

Source

pub const F4: Key

Godot enumerator name: KEY_F4

Source

pub const F5: Key

Godot enumerator name: KEY_F5

Source

pub const F6: Key

Godot enumerator name: KEY_F6

Source

pub const F7: Key

Godot enumerator name: KEY_F7

Source

pub const F8: Key

Godot enumerator name: KEY_F8

Source

pub const F9: Key

Godot enumerator name: KEY_F9

Source

pub const F10: Key

Godot enumerator name: KEY_F10

Source

pub const F11: Key

Godot enumerator name: KEY_F11

Source

pub const F12: Key

Godot enumerator name: KEY_F12

Source

pub const F13: Key

Godot enumerator name: KEY_F13

Source

pub const F14: Key

Godot enumerator name: KEY_F14

Source

pub const F15: Key

Godot enumerator name: KEY_F15

Source

pub const F16: Key

Godot enumerator name: KEY_F16

Source

pub const F17: Key

Godot enumerator name: KEY_F17

Source

pub const F18: Key

Godot enumerator name: KEY_F18

Source

pub const F19: Key

Godot enumerator name: KEY_F19

Source

pub const F20: Key

Godot enumerator name: KEY_F20

Source

pub const F21: Key

Godot enumerator name: KEY_F21

Source

pub const F22: Key

Godot enumerator name: KEY_F22

Source

pub const F23: Key

Godot enumerator name: KEY_F23

Source

pub const F24: Key

Godot enumerator name: KEY_F24

Source

pub const F25: Key

Godot enumerator name: KEY_F25

Source

pub const F26: Key

Godot enumerator name: KEY_F26

Source

pub const F27: Key

Godot enumerator name: KEY_F27

Source

pub const F28: Key

Godot enumerator name: KEY_F28

Source

pub const F29: Key

Godot enumerator name: KEY_F29

Source

pub const F30: Key

Godot enumerator name: KEY_F30

Source

pub const F31: Key

Godot enumerator name: KEY_F31

Source

pub const F32: Key

Godot enumerator name: KEY_F32

Source

pub const F33: Key

Godot enumerator name: KEY_F33

Source

pub const F34: Key

Godot enumerator name: KEY_F34

Source

pub const F35: Key

Godot enumerator name: KEY_F35

Source

pub const KP_MULTIPLY: Key

Godot enumerator name: KEY_KP_MULTIPLY

Source

pub const KP_DIVIDE: Key

Godot enumerator name: KEY_KP_DIVIDE

Source

pub const KP_SUBTRACT: Key

Godot enumerator name: KEY_KP_SUBTRACT

Source

pub const KP_PERIOD: Key

Godot enumerator name: KEY_KP_PERIOD

Source

pub const KP_ADD: Key

Godot enumerator name: KEY_KP_ADD

Source

pub const KP_0: Key

Godot enumerator name: KEY_KP_0

Source

pub const KP_1: Key

Godot enumerator name: KEY_KP_1

Source

pub const KP_2: Key

Godot enumerator name: KEY_KP_2

Source

pub const KP_3: Key

Godot enumerator name: KEY_KP_3

Source

pub const KP_4: Key

Godot enumerator name: KEY_KP_4

Source

pub const KP_5: Key

Godot enumerator name: KEY_KP_5

Source

pub const KP_6: Key

Godot enumerator name: KEY_KP_6

Source

pub const KP_7: Key

Godot enumerator name: KEY_KP_7

Source

pub const KP_8: Key

Godot enumerator name: KEY_KP_8

Source

pub const KP_9: Key

Godot enumerator name: KEY_KP_9

Source

pub const MENU: Key

Godot enumerator name: KEY_MENU

Source

pub const HYPER: Key

Godot enumerator name: KEY_HYPER

Source

pub const HELP: Key

Godot enumerator name: KEY_HELP

Source

pub const BACK: Key

Godot enumerator name: KEY_BACK

Source

pub const FORWARD: Key

Godot enumerator name: KEY_FORWARD

Source

pub const STOP: Key

Godot enumerator name: KEY_STOP

Source

pub const REFRESH: Key

Godot enumerator name: KEY_REFRESH

Source

pub const VOLUMEDOWN: Key

Godot enumerator name: KEY_VOLUMEDOWN

Source

pub const VOLUMEMUTE: Key

Godot enumerator name: KEY_VOLUMEMUTE

Source

pub const VOLUMEUP: Key

Godot enumerator name: KEY_VOLUMEUP

Source

pub const MEDIAPLAY: Key

Godot enumerator name: KEY_MEDIAPLAY

Source

pub const MEDIASTOP: Key

Godot enumerator name: KEY_MEDIASTOP

Source

pub const MEDIAPREVIOUS: Key

Godot enumerator name: KEY_MEDIAPREVIOUS

Source

pub const MEDIANEXT: Key

Godot enumerator name: KEY_MEDIANEXT

Source

pub const MEDIARECORD: Key

Godot enumerator name: KEY_MEDIARECORD

Source

pub const HOMEPAGE: Key

Godot enumerator name: KEY_HOMEPAGE

Source

pub const FAVORITES: Key

Godot enumerator name: KEY_FAVORITES

Source

pub const SEARCH: Key

Godot enumerator name: KEY_SEARCH

Source

pub const STANDBY: Key

Godot enumerator name: KEY_STANDBY

Source

pub const OPENURL: Key

Godot enumerator name: KEY_OPENURL

Source

pub const LAUNCHMAIL: Key

Godot enumerator name: KEY_LAUNCHMAIL

Source

pub const LAUNCHMEDIA: Key

Godot enumerator name: KEY_LAUNCHMEDIA

Source

pub const LAUNCH0: Key

Godot enumerator name: KEY_LAUNCH0

Source

pub const LAUNCH1: Key

Godot enumerator name: KEY_LAUNCH1

Source

pub const LAUNCH2: Key

Godot enumerator name: KEY_LAUNCH2

Source

pub const LAUNCH3: Key

Godot enumerator name: KEY_LAUNCH3

Source

pub const LAUNCH4: Key

Godot enumerator name: KEY_LAUNCH4

Source

pub const LAUNCH5: Key

Godot enumerator name: KEY_LAUNCH5

Source

pub const LAUNCH6: Key

Godot enumerator name: KEY_LAUNCH6

Source

pub const LAUNCH7: Key

Godot enumerator name: KEY_LAUNCH7

Source

pub const LAUNCH8: Key

Godot enumerator name: KEY_LAUNCH8

Source

pub const LAUNCH9: Key

Godot enumerator name: KEY_LAUNCH9

Source

pub const LAUNCHA: Key

Godot enumerator name: KEY_LAUNCHA

Source

pub const LAUNCHB: Key

Godot enumerator name: KEY_LAUNCHB

Source

pub const LAUNCHC: Key

Godot enumerator name: KEY_LAUNCHC

Source

pub const LAUNCHD: Key

Godot enumerator name: KEY_LAUNCHD

Source

pub const LAUNCHE: Key

Godot enumerator name: KEY_LAUNCHE

Source

pub const LAUNCHF: Key

Godot enumerator name: KEY_LAUNCHF

Source

pub const GLOBE: Key

Godot enumerator name: KEY_GLOBE

Source

pub const KEYBOARD: Key

Godot enumerator name: KEY_KEYBOARD

Source

pub const JIS_EISU: Key

Godot enumerator name: KEY_JIS_EISU

Source

pub const JIS_KANA: Key

Godot enumerator name: KEY_JIS_KANA

Source

pub const UNKNOWN: Key

Godot enumerator name: KEY_UNKNOWN

Source

pub const SPACE: Key

Godot enumerator name: KEY_SPACE

Source

pub const EXCLAM: Key

Godot enumerator name: KEY_EXCLAM

Source

pub const QUOTEDBL: Key

Godot enumerator name: KEY_QUOTEDBL

Source

pub const NUMBERSIGN: Key

Godot enumerator name: KEY_NUMBERSIGN

Source

pub const DOLLAR: Key

Godot enumerator name: KEY_DOLLAR

Source

pub const PERCENT: Key

Godot enumerator name: KEY_PERCENT

Source

pub const AMPERSAND: Key

Godot enumerator name: KEY_AMPERSAND

Source

pub const APOSTROPHE: Key

Godot enumerator name: KEY_APOSTROPHE

Source

pub const PARENLEFT: Key

Godot enumerator name: KEY_PARENLEFT

Source

pub const PARENRIGHT: Key

Godot enumerator name: KEY_PARENRIGHT

Source

pub const ASTERISK: Key

Godot enumerator name: KEY_ASTERISK

Source

pub const PLUS: Key

Godot enumerator name: KEY_PLUS

Source

pub const COMMA: Key

Godot enumerator name: KEY_COMMA

Source

pub const MINUS: Key

Godot enumerator name: KEY_MINUS

Source

pub const PERIOD: Key

Godot enumerator name: KEY_PERIOD

Source

pub const SLASH: Key

Godot enumerator name: KEY_SLASH

Source

pub const KEY_0: Key

Source

pub const KEY_1: Key

Source

pub const KEY_2: Key

Source

pub const KEY_3: Key

Source

pub const KEY_4: Key

Source

pub const KEY_5: Key

Source

pub const KEY_6: Key

Source

pub const KEY_7: Key

Source

pub const KEY_8: Key

Source

pub const KEY_9: Key

Source

pub const COLON: Key

Godot enumerator name: KEY_COLON

Source

pub const SEMICOLON: Key

Godot enumerator name: KEY_SEMICOLON

Source

pub const LESS: Key

Godot enumerator name: KEY_LESS

Source

pub const EQUAL: Key

Godot enumerator name: KEY_EQUAL

Source

pub const GREATER: Key

Godot enumerator name: KEY_GREATER

Source

pub const QUESTION: Key

Godot enumerator name: KEY_QUESTION

Source

pub const AT: Key

Godot enumerator name: KEY_AT

Source

pub const A: Key

Godot enumerator name: KEY_A

Source

pub const B: Key

Godot enumerator name: KEY_B

Source

pub const C: Key

Godot enumerator name: KEY_C

Source

pub const D: Key

Godot enumerator name: KEY_D

Source

pub const E: Key

Godot enumerator name: KEY_E

Source

pub const F: Key

Godot enumerator name: KEY_F

Source

pub const G: Key

Godot enumerator name: KEY_G

Source

pub const H: Key

Godot enumerator name: KEY_H

Source

pub const I: Key

Godot enumerator name: KEY_I

Source

pub const J: Key

Godot enumerator name: KEY_J

Source

pub const K: Key

Godot enumerator name: KEY_K

Source

pub const L: Key

Godot enumerator name: KEY_L

Source

pub const M: Key

Godot enumerator name: KEY_M

Source

pub const N: Key

Godot enumerator name: KEY_N

Source

pub const O: Key

Godot enumerator name: KEY_O

Source

pub const P: Key

Godot enumerator name: KEY_P

Source

pub const Q: Key

Godot enumerator name: KEY_Q

Source

pub const R: Key

Godot enumerator name: KEY_R

Source

pub const S: Key

Godot enumerator name: KEY_S

Source

pub const T: Key

Godot enumerator name: KEY_T

Source

pub const U: Key

Godot enumerator name: KEY_U

Source

pub const V: Key

Godot enumerator name: KEY_V

Source

pub const W: Key

Godot enumerator name: KEY_W

Source

pub const X: Key

Godot enumerator name: KEY_X

Source

pub const Y: Key

Godot enumerator name: KEY_Y

Source

pub const Z: Key

Godot enumerator name: KEY_Z

Source

pub const BRACKETLEFT: Key

Godot enumerator name: KEY_BRACKETLEFT

Source

pub const BACKSLASH: Key

Godot enumerator name: KEY_BACKSLASH

Source

pub const BRACKETRIGHT: Key

Godot enumerator name: KEY_BRACKETRIGHT

Source

pub const ASCIICIRCUM: Key

Godot enumerator name: KEY_ASCIICIRCUM

Source

pub const UNDERSCORE: Key

Godot enumerator name: KEY_UNDERSCORE

Source

pub const QUOTELEFT: Key

Godot enumerator name: KEY_QUOTELEFT

Source

pub const BRACELEFT: Key

Godot enumerator name: KEY_BRACELEFT

Source

pub const BAR: Key

Godot enumerator name: KEY_BAR

Source

pub const BRACERIGHT: Key

Godot enumerator name: KEY_BRACERIGHT

Source

pub const ASCIITILDE: Key

Godot enumerator name: KEY_ASCIITILDE

Source

pub const YEN: Key

Godot enumerator name: KEY_YEN

Source

pub const SECTION: Key

Godot enumerator name: KEY_SECTION

Trait Implementations§

Source§

impl BitOr<Key> for KeyModifierMask

Source§

type Output = Key

The resulting type after applying the | operator.
Source§

fn bitor(self, rhs: Key) -> Self::Output

Performs the | operation. Read more
Source§

impl BitOr<KeyModifierMask> for Key

Source§

type Output = Key

The resulting type after applying the | operator.
Source§

fn bitor(self, rhs: KeyModifierMask) -> Self::Output

Performs the | operation. Read more
Source§

impl BitOrAssign<KeyModifierMask> for Key

Source§

fn bitor_assign(&mut self, rhs: KeyModifierMask)

Performs the |= operation. Read more
Source§

impl Clone for Key

Source§

fn clone(&self) -> Key

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Key

Source§

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

Formats the value using the given formatter. Read more
Source§

impl EngineEnum for Key

Source§

fn try_from_ord(ord: i32) -> Option<Self>

Source§

fn ord(self) -> i32

Ordinal value of the enumerator, as specified in Godot. This is not necessarily unique.
Source§

fn as_str(&self) -> &'static str

The name of the enumerator, as it appears in Rust. Read more
Source§

fn values() -> &'static [Self]

Returns a slice of distinct enum values. Read more
Source§

fn all_constants() -> &'static [EnumConstant<Key>]

Returns metadata for all enum constants. Read more
Source§

fn from_ord(ord: i32) -> Self

Source§

impl FromGodot for Key

Source§

fn try_from_godot(via: Self::Via) -> Result<Self, ConvertError>

Converts the Godot representation to this type, returning Err on failure.
Source§

fn from_godot(via: Self::Via) -> Self

⚠️ Converts the Godot representation to this type. Read more
Source§

fn try_from_variant(variant: &Variant) -> Result<Self, ConvertError>

Performs the conversion from a [Variant], returning Err on failure.
Source§

fn from_variant(variant: &Variant) -> Self

⚠️ Performs the conversion from a [Variant]. Read more
Source§

impl GodotConvert for Key

Source§

type Via = i32

The type through which Self is represented in Godot.
Source§

fn godot_shape() -> GodotShape

Which “shape” this type has for property registration (e.g. builtin, enum, …). Read more
Source§

impl Hash for Key

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Key

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl ToGodot for Key

Source§

type Pass = ByValue

Whether arguments of this type are passed by value or by reference. Read more
Source§

fn to_godot(&self) -> Self::Via

Converts this type to Godot representation, optimizing for zero-copy when possible. Read more
Source§

fn to_godot_owned(&self) -> Self::Via
where Self::Via: Clone,

Converts this type to owned Godot representation. Read more
Source§

fn to_variant(&self) -> Variant

Converts this type to a [Variant].
Source§

impl Var for Key

Source§

type PubType = Key

Type used in generated Rust getters/setters for #[var(pub)].
Source§

fn var_get(field: &Self) -> Self::Via

Get property value via FFI-level Via type. Called for internal (non-pub) getters registered with Godot.
Source§

fn var_set(field: &mut Self, value: Self::Via)

Set property value via FFI-level Via type. Called for internal (non-pub) setters registered with Godot.
Source§

fn var_pub_get(field: &Self) -> Self::PubType

Get property value as PubType. Called for #[var(pub)] getters exposed in Rust API.
Source§

fn var_pub_set(field: &mut Self, value: Self::PubType)

Set property value as PubType. Called for #[var(pub)] setters exposed in Rust API.
Source§

impl Copy for Key

Source§

impl Element for Key

Source§

impl Eq for Key

Source§

impl Export for Key

Source§

impl StructuralPartialEq for Key

Auto Trait Implementations§

§

impl Freeze for Key

§

impl RefUnwindSafe for Key

§

impl Send for Key

§

impl Sync for Key

§

impl Unpin for Key

§

impl UnsafeUnpin for Key

§

impl UnwindSafe for Key

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AsArg<T> for T
where T: ToGodot<Pass = ByValue>,

Source§

fn into_arg<'arg>(self) -> CowArg<'arg, T>
where T: 'arg,

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> AsDirectElement<T> for T
where T: Element<Pass = ByValue> + ToGodot,