Struct Input

pub struct Input { /* private fields */ }

core singleton class Input inherits Object (unsafe).

Official documentation

See the documentation of this class in the Godot engine’s official documentation.

Feature flag

This type is behind the gdnative crate’s common feature flag.

Class hierarchy

Input inherits methods from:

• Object

Implementations

impl Input

pub fn godot_singleton() -> Self

pub fn is_key_pressed(&self, scancode: i64) -> bool

pub fn is_mouse_button_pressed(&self, button: i64) -> bool

pub fn is_joy_button_pressed(&self, device: i64, button: i64) -> bool

pub fn is_action_pressed(&self, action: GodotString) -> bool

pub fn is_action_just_pressed(&self, action: GodotString) -> bool

pub fn is_action_just_released(&self, action: GodotString) -> bool

pub fn get_action_strength(&self, action: GodotString) -> f64

pub fn add_joy_mapping(&mut self, mapping: GodotString, update_existing: bool)

pub fn remove_joy_mapping(&mut self, guid: GodotString)

pub fn joy_connection_changed( &mut self, device: i64, connected: bool, name: GodotString, guid: GodotString, )

pub fn is_joy_known(&mut self, device: i64) -> bool

pub fn get_joy_axis(&self, device: i64, axis: i64) -> f64

pub fn get_joy_name(&mut self, device: i64) -> GodotString

pub fn get_joy_guid(&self, device: i64) -> GodotString

pub fn get_connected_joypads(&mut self) -> VariantArray

pub fn get_joy_vibration_strength(&mut self, device: i64) -> Vector2

pub fn get_joy_vibration_duration(&mut self, device: i64) -> f64

pub fn get_joy_button_string(&mut self, button_index: i64) -> GodotString

pub fn get_joy_button_index_from_string(&mut self, button: GodotString) -> i64

pub fn get_joy_axis_string(&mut self, axis_index: i64) -> GodotString

pub fn get_joy_axis_index_from_string(&mut self, axis: GodotString) -> i64

pub fn start_joy_vibration( &mut self, device: i64, weak_magnitude: f64, strong_magnitude: f64, duration: f64, )

pub fn stop_joy_vibration(&mut self, device: i64)

pub fn get_gravity(&self) -> Vector3

pub fn get_accelerometer(&self) -> Vector3

pub fn get_magnetometer(&self) -> Vector3

pub fn get_gyroscope(&self) -> Vector3

pub fn get_last_mouse_speed(&self) -> Vector2

pub fn get_mouse_button_mask(&self) -> i64

pub fn set_mouse_mode(&mut self, mode: i64)

pub fn get_mouse_mode(&self) -> InputMouseMode

pub fn warp_mouse_position(&mut self, to: Vector2)

pub fn action_press(&mut self, action: GodotString)

pub fn action_release(&mut self, action: GodotString)

pub fn set_default_cursor_shape(&mut self, shape: i64)

pub fn set_custom_mouse_cursor( &mut self, image: Option<Resource>, shape: i64, hotspot: Vector2, )

pub fn parse_input_event(&mut self, event: Option<InputEvent>)

pub fn _notification(&mut self, what: i64)

Inherited from Object.

pub fn _set(&mut self, property: GodotString, value: Variant) -> bool

Inherited from Object.

pub fn _get(&mut self, property: GodotString) -> Variant

Inherited from Object.

pub fn _get_property_list(&mut self) -> VariantArray

Inherited from Object.

pub fn _init(&mut self)

Inherited from Object.

pub fn get_class(&self) -> GodotString

Inherited from Object.

pub fn is_class(&self, _type: GodotString) -> bool

Inherited from Object.

pub fn set(&mut self, property: GodotString, value: Variant)

Inherited from Object.

pub fn get(&self, property: GodotString) -> Variant

Inherited from Object.

pub fn set_indexed(&mut self, property: NodePath, value: Variant)

Inherited from Object.

pub fn get_indexed(&self, property: NodePath) -> Variant

Inherited from Object.

pub fn get_property_list(&self) -> VariantArray

Inherited from Object.

pub fn get_method_list(&self) -> VariantArray

Inherited from Object.

pub fn notification(&mut self, what: i64, reversed: bool)

Inherited from Object.

pub fn get_instance_id(&self) -> i64

Inherited from Object.

pub fn set_script(&mut self, script: Option<Reference>)

Inherited from Object.

pub fn get_script(&self) -> Option<Reference>

Inherited from Object.

pub fn set_meta(&mut self, name: GodotString, value: Variant)

Inherited from Object.

pub fn get_meta(&self, name: GodotString) -> Variant

Inherited from Object.

pub fn has_meta(&self, name: GodotString) -> bool

Inherited from Object.

pub fn get_meta_list(&self) -> StringArray

Inherited from Object.

pub fn add_user_signal(&mut self, signal: GodotString, arguments: VariantArray)

Inherited from Object.

pub fn has_user_signal(&self, signal: GodotString) -> bool

Inherited from Object.

pub fn emit_signal( &mut self, signal: GodotString, varargs: &[Variant], ) -> Variant

Inherited from Object.

pub fn call(&mut self, method: GodotString, varargs: &[Variant]) -> Variant

Inherited from Object.

pub fn call_deferred( &mut self, method: GodotString, varargs: &[Variant], ) -> Variant

Inherited from Object.

pub fn callv(&mut self, method: GodotString, arg_array: VariantArray) -> Variant

Inherited from Object.

pub fn has_method(&self, method: GodotString) -> bool

Inherited from Object.

pub fn get_signal_list(&self) -> VariantArray

Inherited from Object.

pub fn get_signal_connection_list(&self, signal: GodotString) -> VariantArray

Inherited from Object.

pub fn get_incoming_connections(&self) -> VariantArray

Inherited from Object.

pub fn connect( &mut self, signal: GodotString, target: Option<Object>, method: GodotString, binds: VariantArray, flags: i64, ) -> GodotResult

Inherited from Object.

pub fn disconnect( &mut self, signal: GodotString, target: Option<Object>, method: GodotString, )

Inherited from Object.

pub fn is_connected( &self, signal: GodotString, target: Option<Object>, method: GodotString, ) -> bool

Inherited from Object.

pub fn set_block_signals(&mut self, enable: bool)

Inherited from Object.

pub fn is_blocking_signals(&self) -> bool

Inherited from Object.

pub fn property_list_changed_notify(&mut self)

Inherited from Object.

pub fn set_message_translation(&mut self, enable: bool)

Inherited from Object.

pub fn can_translate_messages(&self) -> bool

Inherited from Object.

pub fn tr(&self, message: GodotString) -> GodotString

Inherited from Object.

pub fn is_queued_for_deletion(&self) -> bool

Inherited from Object.

pub fn to_object(&self) -> Object

Up-cast.

pub fn cast<T: GodotObject>(&self) -> Option<T>

Generic dynamic cast.

Trait Implementations

impl Clone for Input

fn clone(&self) -> Input

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Input

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

Formats the value using the given formatter.

impl GodotObject for Input

fn class_name() -> &'static str

impl ToVariant for Input

fn to_variant(&self) -> Variant

fn from_variant(variant: &Variant) -> Option<Self>

impl Copy for Input