pub struct InputEventKey { /* private fields */ }Expand description
core class InputEventKey inherits InputEventWithModifiers (reference counted).
§Official documentation
See the documentation of this class in the Godot engine’s official documentation.
§Memory management
The lifetime of this object is automatically managed through reference counting.
§Feature flag
This type is behind the gdnative crate’s common feature flag.
§Class hierarchy
InputEventKey inherits methods from:
Implementations§
Source§impl InputEventKey
impl InputEventKey
pub fn new() -> Self
pub fn set_pressed(&mut self, pressed: bool)
pub fn set_scancode(&mut self, scancode: i64)
pub fn get_scancode(&self) -> i64
pub fn set_unicode(&mut self, unicode: i64)
pub fn get_unicode(&self) -> i64
pub fn set_echo(&mut self, echo: bool)
pub fn get_scancode_with_modifiers(&self) -> i64
Sourcepub fn set_alt(&mut self, enable: bool)
pub fn set_alt(&mut self, enable: bool)
Inherited from InputEventWithModifiers.
Sourcepub fn get_alt(&self) -> bool
pub fn get_alt(&self) -> bool
Inherited from InputEventWithModifiers.
Sourcepub fn set_shift(&mut self, enable: bool)
pub fn set_shift(&mut self, enable: bool)
Inherited from InputEventWithModifiers.
Sourcepub fn get_shift(&self) -> bool
pub fn get_shift(&self) -> bool
Inherited from InputEventWithModifiers.
Sourcepub fn set_control(&mut self, enable: bool)
pub fn set_control(&mut self, enable: bool)
Inherited from InputEventWithModifiers.
Sourcepub fn get_control(&self) -> bool
pub fn get_control(&self) -> bool
Inherited from InputEventWithModifiers.
Sourcepub fn set_metakey(&mut self, enable: bool)
pub fn set_metakey(&mut self, enable: bool)
Inherited from InputEventWithModifiers.
Sourcepub fn get_metakey(&self) -> bool
pub fn get_metakey(&self) -> bool
Inherited from InputEventWithModifiers.
Sourcepub fn set_command(&mut self, enable: bool)
pub fn set_command(&mut self, enable: bool)
Inherited from InputEventWithModifiers.
Sourcepub fn get_command(&self) -> bool
pub fn get_command(&self) -> bool
Inherited from InputEventWithModifiers.
Sourcepub fn set_device(&mut self, device: i64)
pub fn set_device(&mut self, device: i64)
Inherited from InputEvent.
Sourcepub fn get_device(&self) -> i64
pub fn get_device(&self) -> i64
Inherited from InputEvent.
Sourcepub fn is_action(&self, action: GodotString) -> bool
pub fn is_action(&self, action: GodotString) -> bool
Inherited from InputEvent.
Sourcepub fn is_action_pressed(&self, action: GodotString) -> bool
pub fn is_action_pressed(&self, action: GodotString) -> bool
Inherited from InputEvent.
Sourcepub fn is_action_released(&self, action: GodotString) -> bool
pub fn is_action_released(&self, action: GodotString) -> bool
Inherited from InputEvent.
Sourcepub fn get_action_strength(&self, action: GodotString) -> f64
pub fn get_action_strength(&self, action: GodotString) -> f64
Inherited from InputEvent.
Sourcepub fn is_pressed(&self) -> bool
pub fn is_pressed(&self) -> bool
Inherited from InputEvent.
Sourcepub fn is_echo(&self) -> bool
pub fn is_echo(&self) -> bool
Inherited from InputEvent.
Sourcepub fn as_text(&self) -> GodotString
pub fn as_text(&self) -> GodotString
Inherited from InputEvent.
Sourcepub fn shortcut_match(&self, event: Option<InputEvent>) -> bool
pub fn shortcut_match(&self, event: Option<InputEvent>) -> bool
Inherited from InputEvent.
Sourcepub fn is_action_type(&self) -> bool
pub fn is_action_type(&self) -> bool
Inherited from InputEvent.
Sourcepub fn xformed_by(
&self,
xform: Transform2D,
local_ofs: Vector2,
) -> Option<InputEvent>
pub fn xformed_by( &self, xform: Transform2D, local_ofs: Vector2, ) -> Option<InputEvent>
Inherited from InputEvent.
Sourcepub fn _setup_local_to_scene(&mut self)
pub fn _setup_local_to_scene(&mut self)
Inherited from Resource.
Sourcepub fn set_path(&mut self, path: GodotString)
pub fn set_path(&mut self, path: GodotString)
Inherited from Resource.
Sourcepub fn take_over_path(&mut self, path: GodotString)
pub fn take_over_path(&mut self, path: GodotString)
Inherited from Resource.
Sourcepub fn get_path(&self) -> GodotString
pub fn get_path(&self) -> GodotString
Inherited from Resource.
Sourcepub fn set_name(&mut self, name: GodotString)
pub fn set_name(&mut self, name: GodotString)
Inherited from Resource.
Sourcepub fn get_name(&self) -> GodotString
pub fn get_name(&self) -> GodotString
Inherited from Resource.
Sourcepub fn set_local_to_scene(&mut self, enable: bool)
pub fn set_local_to_scene(&mut self, enable: bool)
Inherited from Resource.
Sourcepub fn is_local_to_scene(&self) -> bool
pub fn is_local_to_scene(&self) -> bool
Inherited from Resource.
Sourcepub fn get_local_scene(&self) -> Option<Node>
pub fn get_local_scene(&self) -> Option<Node>
Inherited from Resource.
Sourcepub fn setup_local_to_scene(&mut self)
pub fn setup_local_to_scene(&mut self)
Inherited from Resource.
Sourcepub fn _notification(&mut self, what: i64)
pub fn _notification(&mut self, what: i64)
Inherited from Object.
Sourcepub fn _get(&mut self, property: GodotString) -> Variant
pub fn _get(&mut self, property: GodotString) -> Variant
Inherited from Object.
Sourcepub fn _get_property_list(&mut self) -> VariantArray
pub fn _get_property_list(&mut self) -> VariantArray
Inherited from Object.
Sourcepub fn get_class(&self) -> GodotString
pub fn get_class(&self) -> GodotString
Inherited from Object.
Sourcepub fn is_class(&self, _type: GodotString) -> bool
pub fn is_class(&self, _type: GodotString) -> bool
Inherited from Object.
Sourcepub fn set(&mut self, property: GodotString, value: Variant)
pub fn set(&mut self, property: GodotString, value: Variant)
Inherited from Object.
Sourcepub fn get(&self, property: GodotString) -> Variant
pub fn get(&self, property: GodotString) -> Variant
Inherited from Object.
Sourcepub fn set_indexed(&mut self, property: NodePath, value: Variant)
pub fn set_indexed(&mut self, property: NodePath, value: Variant)
Inherited from Object.
Sourcepub fn get_indexed(&self, property: NodePath) -> Variant
pub fn get_indexed(&self, property: NodePath) -> Variant
Inherited from Object.
Sourcepub fn get_property_list(&self) -> VariantArray
pub fn get_property_list(&self) -> VariantArray
Inherited from Object.
Sourcepub fn get_method_list(&self) -> VariantArray
pub fn get_method_list(&self) -> VariantArray
Inherited from Object.
Sourcepub fn notification(&mut self, what: i64, reversed: bool)
pub fn notification(&mut self, what: i64, reversed: bool)
Inherited from Object.
Sourcepub fn get_instance_id(&self) -> i64
pub fn get_instance_id(&self) -> i64
Inherited from Object.
Sourcepub fn set_script(&mut self, script: Option<Reference>)
pub fn set_script(&mut self, script: Option<Reference>)
Inherited from Object.
Sourcepub fn get_script(&self) -> Option<Reference>
pub fn get_script(&self) -> Option<Reference>
Inherited from Object.
Sourcepub fn set_meta(&mut self, name: GodotString, value: Variant)
pub fn set_meta(&mut self, name: GodotString, value: Variant)
Inherited from Object.
Sourcepub fn get_meta(&self, name: GodotString) -> Variant
pub fn get_meta(&self, name: GodotString) -> Variant
Inherited from Object.
Sourcepub fn has_meta(&self, name: GodotString) -> bool
pub fn has_meta(&self, name: GodotString) -> bool
Inherited from Object.
Sourcepub fn get_meta_list(&self) -> StringArray
pub fn get_meta_list(&self) -> StringArray
Inherited from Object.
Sourcepub fn add_user_signal(&mut self, signal: GodotString, arguments: VariantArray)
pub fn add_user_signal(&mut self, signal: GodotString, arguments: VariantArray)
Inherited from Object.
Sourcepub fn has_user_signal(&self, signal: GodotString) -> bool
pub fn has_user_signal(&self, signal: GodotString) -> bool
Inherited from Object.
Sourcepub fn emit_signal(
&mut self,
signal: GodotString,
varargs: &[Variant],
) -> Variant
pub fn emit_signal( &mut self, signal: GodotString, varargs: &[Variant], ) -> Variant
Inherited from Object.
Sourcepub fn call(&mut self, method: GodotString, varargs: &[Variant]) -> Variant
pub fn call(&mut self, method: GodotString, varargs: &[Variant]) -> Variant
Inherited from Object.
Sourcepub fn call_deferred(
&mut self,
method: GodotString,
varargs: &[Variant],
) -> Variant
pub fn call_deferred( &mut self, method: GodotString, varargs: &[Variant], ) -> Variant
Inherited from Object.
Sourcepub fn callv(&mut self, method: GodotString, arg_array: VariantArray) -> Variant
pub fn callv(&mut self, method: GodotString, arg_array: VariantArray) -> Variant
Inherited from Object.
Sourcepub fn has_method(&self, method: GodotString) -> bool
pub fn has_method(&self, method: GodotString) -> bool
Inherited from Object.
Sourcepub fn get_signal_list(&self) -> VariantArray
pub fn get_signal_list(&self) -> VariantArray
Inherited from Object.
Sourcepub fn get_signal_connection_list(&self, signal: GodotString) -> VariantArray
pub fn get_signal_connection_list(&self, signal: GodotString) -> VariantArray
Inherited from Object.
Sourcepub fn get_incoming_connections(&self) -> VariantArray
pub fn get_incoming_connections(&self) -> VariantArray
Inherited from Object.
Sourcepub fn connect(
&mut self,
signal: GodotString,
target: Option<Object>,
method: GodotString,
binds: VariantArray,
flags: i64,
) -> GodotResult
pub fn connect( &mut self, signal: GodotString, target: Option<Object>, method: GodotString, binds: VariantArray, flags: i64, ) -> GodotResult
Inherited from Object.
Sourcepub fn disconnect(
&mut self,
signal: GodotString,
target: Option<Object>,
method: GodotString,
)
pub fn disconnect( &mut self, signal: GodotString, target: Option<Object>, method: GodotString, )
Inherited from Object.
Sourcepub fn is_connected(
&self,
signal: GodotString,
target: Option<Object>,
method: GodotString,
) -> bool
pub fn is_connected( &self, signal: GodotString, target: Option<Object>, method: GodotString, ) -> bool
Inherited from Object.
Sourcepub fn set_block_signals(&mut self, enable: bool)
pub fn set_block_signals(&mut self, enable: bool)
Inherited from Object.
Sourcepub fn is_blocking_signals(&self) -> bool
pub fn is_blocking_signals(&self) -> bool
Inherited from Object.
Sourcepub fn property_list_changed_notify(&mut self)
pub fn property_list_changed_notify(&mut self)
Inherited from Object.
Sourcepub fn set_message_translation(&mut self, enable: bool)
pub fn set_message_translation(&mut self, enable: bool)
Inherited from Object.
Sourcepub fn can_translate_messages(&self) -> bool
pub fn can_translate_messages(&self) -> bool
Inherited from Object.
Sourcepub fn tr(&self, message: GodotString) -> GodotString
pub fn tr(&self, message: GodotString) -> GodotString
Inherited from Object.
Sourcepub fn is_queued_for_deletion(&self) -> bool
pub fn is_queued_for_deletion(&self) -> bool
Inherited from Object.
Sourcepub fn to_input_event_with_modifiers(&self) -> InputEventWithModifiers
pub fn to_input_event_with_modifiers(&self) -> InputEventWithModifiers
Up-cast.
Sourcepub fn to_input_event(&self) -> InputEvent
pub fn to_input_event(&self) -> InputEvent
Up-cast.
Sourcepub fn to_resource(&self) -> Resource
pub fn to_resource(&self) -> Resource
Up-cast.
Sourcepub fn to_reference(&self) -> Reference
pub fn to_reference(&self) -> Reference
Up-cast.
Sourcepub fn cast<T: GodotObject>(&self) -> Option<T>
pub fn cast<T: GodotObject>(&self) -> Option<T>
Generic dynamic cast.