Input

Inherits: Object

There is currently no description for this class. Please help us by contributing one!

Properties

bool

emulate_mouse_from_touch

bool

emulate_touch_from_mouse

MouseMode

mouse_mode

bool

use_accumulated_input

Methods

void

action_press ( StringName action, float strength=1.0 )

void

action_release ( StringName action )

void

add_joy_mapping ( String mapping, bool update_existing=false )

void

flush_buffered_events ( )

Vector3

get_accelerometer ( ) const

float

get_action_raw_strength ( StringName action, bool exact_match=false ) const

float

get_action_strength ( StringName action, bool exact_match=false ) const

float

get_axis ( StringName negative_action, StringName positive_action ) const

int[]

get_connected_joypads ( )

CursorShape

get_current_cursor_shape ( ) const

Vector3

get_gravity ( ) const

Vector3

get_gyroscope ( ) const

float

get_joy_axis ( int device, JoyAxis axis ) const

String

get_joy_guid ( int device ) const

Dictionary

get_joy_info ( int device ) const

String

get_joy_name ( int device )

float

get_joy_vibration_duration ( int device )

Vector2

get_joy_vibration_strength ( int device )

Vector2

get_last_mouse_screen_velocity ( )

Vector2

get_last_mouse_velocity ( )

Vector3

get_magnetometer ( ) const

BitField<MouseButtonMask>

get_mouse_button_mask ( ) const

Vector2

get_vector ( StringName negative_x, StringName positive_x, StringName negative_y, StringName positive_y, float deadzone=-1.0 ) const

bool

is_action_just_pressed ( StringName action, bool exact_match=false ) const

bool

is_action_just_released ( StringName action, bool exact_match=false ) const

bool

is_action_pressed ( StringName action, bool exact_match=false ) const

bool

is_anything_pressed ( ) const

bool

is_joy_button_pressed ( int device, JoyButton button ) const

bool

is_joy_known ( int device )

bool

is_key_label_pressed ( Key keycode ) const

bool

is_key_pressed ( Key keycode ) const

bool

is_mouse_button_pressed ( MouseButton button ) const

bool

is_physical_key_pressed ( Key keycode ) const

void

parse_input_event ( InputEvent event )

void

remove_joy_mapping ( String guid )

void

set_accelerometer ( Vector3 value )

void

set_custom_mouse_cursor ( Resource image, CursorShape shape=0, Vector2 hotspot=Vector2(0, 0) )

void

set_default_cursor_shape ( CursorShape shape=0 )

void

set_gravity ( Vector3 value )

void

set_gyroscope ( Vector3 value )

void

set_magnetometer ( Vector3 value )

bool

should_ignore_device ( int vendor_id, int product_id ) const

void

start_joy_vibration ( int device, float weak_magnitude, float strong_magnitude, float duration=0 )

void

stop_joy_vibration ( int device )

void

vibrate_handheld ( int duration_ms=500, float amplitude=-1.0 )

void

warp_mouse ( Vector2 position )


Signals

joy_connection_changed ( int device, bool connected )

There is currently no description for this signal. Please help us by contributing one!


Enumerations

enum MouseMode:

MouseMode MOUSE_MODE_VISIBLE = 0

There is currently no description for this enum. Please help us by contributing one!

MouseMode MOUSE_MODE_HIDDEN = 1

There is currently no description for this enum. Please help us by contributing one!

MouseMode MOUSE_MODE_CAPTURED = 2

There is currently no description for this enum. Please help us by contributing one!

MouseMode MOUSE_MODE_CONFINED = 3

There is currently no description for this enum. Please help us by contributing one!

MouseMode MOUSE_MODE_CONFINED_HIDDEN = 4

There is currently no description for this enum. Please help us by contributing one!


enum CursorShape:

CursorShape CURSOR_ARROW = 0

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_IBEAM = 1

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_POINTING_HAND = 2

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_CROSS = 3

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_WAIT = 4

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_BUSY = 5

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_DRAG = 6

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_CAN_DROP = 7

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_FORBIDDEN = 8

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_VSIZE = 9

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_HSIZE = 10

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_BDIAGSIZE = 11

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_FDIAGSIZE = 12

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_MOVE = 13

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_VSPLIT = 14

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_HSPLIT = 15

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_HELP = 16

There is currently no description for this enum. Please help us by contributing one!


Property Descriptions

bool emulate_mouse_from_touch

  • void set_emulate_mouse_from_touch ( bool value )

  • bool is_emulating_mouse_from_touch ( )

There is currently no description for this property. Please help us by contributing one!


bool emulate_touch_from_mouse

  • void set_emulate_touch_from_mouse ( bool value )

  • bool is_emulating_touch_from_mouse ( )

There is currently no description for this property. Please help us by contributing one!


MouseMode mouse_mode

There is currently no description for this property. Please help us by contributing one!


bool use_accumulated_input

  • void set_use_accumulated_input ( bool value )

  • bool is_using_accumulated_input ( )

There is currently no description for this property. Please help us by contributing one!


Method Descriptions

void action_press ( StringName action, float strength=1.0 )

There is currently no description for this method. Please help us by contributing one!


void action_release ( StringName action )

There is currently no description for this method. Please help us by contributing one!


void add_joy_mapping ( String mapping, bool update_existing=false )

There is currently no description for this method. Please help us by contributing one!


void flush_buffered_events ( )

There is currently no description for this method. Please help us by contributing one!


Vector3 get_accelerometer ( ) const

There is currently no description for this method. Please help us by contributing one!


float get_action_raw_strength ( StringName action, bool exact_match=false ) const

There is currently no description for this method. Please help us by contributing one!


float get_action_strength ( StringName action, bool exact_match=false ) const

There is currently no description for this method. Please help us by contributing one!


float get_axis ( StringName negative_action, StringName positive_action ) const

There is currently no description for this method. Please help us by contributing one!


int[] get_connected_joypads ( )

There is currently no description for this method. Please help us by contributing one!


CursorShape get_current_cursor_shape ( ) const

There is currently no description for this method. Please help us by contributing one!


Vector3 get_gravity ( ) const

There is currently no description for this method. Please help us by contributing one!


Vector3 get_gyroscope ( ) const

There is currently no description for this method. Please help us by contributing one!


float get_joy_axis ( int device, JoyAxis axis ) const

There is currently no description for this method. Please help us by contributing one!


String get_joy_guid ( int device ) const

There is currently no description for this method. Please help us by contributing one!


Dictionary get_joy_info ( int device ) const

There is currently no description for this method. Please help us by contributing one!


String get_joy_name ( int device )

There is currently no description for this method. Please help us by contributing one!


float get_joy_vibration_duration ( int device )

There is currently no description for this method. Please help us by contributing one!


Vector2 get_joy_vibration_strength ( int device )

There is currently no description for this method. Please help us by contributing one!


Vector2 get_last_mouse_screen_velocity ( )

There is currently no description for this method. Please help us by contributing one!


Vector2 get_last_mouse_velocity ( )

There is currently no description for this method. Please help us by contributing one!


Vector3 get_magnetometer ( ) const

There is currently no description for this method. Please help us by contributing one!


BitField<MouseButtonMask> get_mouse_button_mask ( ) const

There is currently no description for this method. Please help us by contributing one!


Vector2 get_vector ( StringName negative_x, StringName positive_x, StringName negative_y, StringName positive_y, float deadzone=-1.0 ) const

There is currently no description for this method. Please help us by contributing one!


bool is_action_just_pressed ( StringName action, bool exact_match=false ) const

There is currently no description for this method. Please help us by contributing one!


bool is_action_just_released ( StringName action, bool exact_match=false ) const

There is currently no description for this method. Please help us by contributing one!


bool is_action_pressed ( StringName action, bool exact_match=false ) const

There is currently no description for this method. Please help us by contributing one!


bool is_anything_pressed ( ) const

There is currently no description for this method. Please help us by contributing one!


bool is_joy_button_pressed ( int device, JoyButton button ) const

There is currently no description for this method. Please help us by contributing one!


bool is_joy_known ( int device )

There is currently no description for this method. Please help us by contributing one!


bool is_key_label_pressed ( Key keycode ) const

There is currently no description for this method. Please help us by contributing one!


bool is_key_pressed ( Key keycode ) const

There is currently no description for this method. Please help us by contributing one!


bool is_mouse_button_pressed ( MouseButton button ) const

There is currently no description for this method. Please help us by contributing one!


bool is_physical_key_pressed ( Key keycode ) const

There is currently no description for this method. Please help us by contributing one!


void parse_input_event ( InputEvent event )

There is currently no description for this method. Please help us by contributing one!


void remove_joy_mapping ( String guid )

There is currently no description for this method. Please help us by contributing one!


void set_accelerometer ( Vector3 value )

There is currently no description for this method. Please help us by contributing one!


void set_custom_mouse_cursor ( Resource image, CursorShape shape=0, Vector2 hotspot=Vector2(0, 0) )

There is currently no description for this method. Please help us by contributing one!


void set_default_cursor_shape ( CursorShape shape=0 )

There is currently no description for this method. Please help us by contributing one!


void set_gravity ( Vector3 value )

There is currently no description for this method. Please help us by contributing one!


void set_gyroscope ( Vector3 value )

There is currently no description for this method. Please help us by contributing one!


void set_magnetometer ( Vector3 value )

There is currently no description for this method. Please help us by contributing one!


bool should_ignore_device ( int vendor_id, int product_id ) const

There is currently no description for this method. Please help us by contributing one!


void start_joy_vibration ( int device, float weak_magnitude, float strong_magnitude, float duration=0 )

There is currently no description for this method. Please help us by contributing one!


void stop_joy_vibration ( int device )

There is currently no description for this method. Please help us by contributing one!


void vibrate_handheld ( int duration_ms=500, float amplitude=-1.0 )

There is currently no description for this method. Please help us by contributing one!


void warp_mouse ( Vector2 position )

There is currently no description for this method. Please help us by contributing one!