Struct gdnative_bindings_lily::input_event_key::InputEventKey

pub struct InputEventKey { /* fields omitted */ }

core class InputEventKey inherits InputEventWithModifiers (reference counted).

Official documentation

See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

InputEventKey inherits methods from:

• InputEventWithModifiers
• InputEvent
• Resource
• Reference
• Object

Safety

All types in the Godot API have “interior mutability” in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl InputEventKey

pub fn new() -> Ref<Self, Unique>

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

pub fn scancode(&self) -> i64

The key scancode, which corresponds to one of the [enum KeyList] constants. To get a human-readable representation of the InputEventKey, use OS.get_scancode_string(event.scancode) where event is the InputEventKey.

pub fn get_scancode_with_modifiers(&self) -> i64

Returns the scancode combined with modifier keys such as Shift or Alt. See also InputEventWithModifiers. To get a human-readable representation of the InputEventKey with modifiers, use OS.get_scancode_string(event.get_scancode_with_modifiers()) where event is the InputEventKey.

pub fn unicode(&self) -> i64

The key Unicode identifier (when relevant). Unicode identifiers for the composite characters and complex scripts may not be available unless IME input mode is active. See [method OS.set_ime_active] for more information.

pub fn set_echo(&self, echo: bool)

If true, the key was already pressed before this event. It means the user is holding the key down.

pub fn set_pressed(&self, pressed: bool)

If true, the key’s state is pressed. If false, the key’s state is released.

pub fn set_scancode(&self, scancode: i64)

The key scancode, which corresponds to one of the [enum KeyList] constants. To get a human-readable representation of the InputEventKey, use OS.get_scancode_string(event.scancode) where event is the InputEventKey.

pub fn set_unicode(&self, unicode: i64)

The key Unicode identifier (when relevant). Unicode identifiers for the composite characters and complex scripts may not be available unless IME input mode is active. See [method OS.set_ime_active] for more information.

Methods from Deref<Target = InputEventWithModifiers>

pub fn alt(&self) -> bool

State of the Alt modifier.

pub fn command(&self) -> bool

State of the Command modifier.

pub fn control(&self) -> bool

State of the Ctrl modifier.

pub fn metakey(&self) -> bool

State of the Meta modifier.

pub fn shift(&self) -> bool

State of the Shift modifier.

pub fn set_alt(&self, enable: bool)

State of the Alt modifier.

pub fn set_command(&self, enable: bool)

State of the Command modifier.

pub fn set_control(&self, enable: bool)

State of the Ctrl modifier.

pub fn set_metakey(&self, enable: bool)

State of the Meta modifier.

pub fn set_shift(&self, enable: bool)

State of the Shift modifier.

Trait Implementations

impl Debug for InputEventKey

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

Formats the value using the given formatter.

impl Deref for InputEventKey

type Target = InputEventWithModifiers

The resulting type after dereferencing.

fn deref(&self) -> &InputEventWithModifiers

Dereferences the value.

impl DerefMut for InputEventKey

fn deref_mut(&mut self) -> &mut InputEventWithModifiers

Mutably dereferences the value.

impl GodotObject for InputEventKey

type RefKind = RefCounted

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

unsafe fn try_from_instance_id<'a>(id: i64) -> Option<TRef<'a, Self, Shared>>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive. See also TRef::try_from_instance_id.

unsafe fn from_instance_id<'a>(id: i64) -> TRef<'a, Self, Shared>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive, and panics otherwise. This does NOT guarantee that the resulting reference is safe to use.

impl Instanciable for InputEventKey

fn construct() -> Ref<Self, Unique>

impl Sealed for InputEventKey

impl SubClass<InputEvent> for InputEventKey

impl SubClass<InputEventWithModifiers> for InputEventKey

impl SubClass<Object> for InputEventKey

impl SubClass<Reference> for InputEventKey

impl SubClass<Resource> for InputEventKey