GutInputSender

Inherits: RefCounted

The InputSender class. It sends input to places.

Description

This is the full description that has not yet been filled in.

Properties

Variant	InputFactory	load(...)
Variant	mouse_warp	false
Variant	draw_mouse	true

Methods

void	_init(r = null)
Variant	action_down(which, strength = 1.0)
Variant	action_up(which, strength = 1.0)
void	add_receiver(obj)
void	clear()
Variant	get_auto_flush_input()
Variant	get_receivers()
Variant	hold_for(duration)
Variant	is_action_pressed(which)
Variant	is_idle()
Variant	is_key_pressed(which)
Variant	is_mouse_button_pressed(which)
Variant	key_down(which)
Variant	key_echo()
Variant	key_up(which)
Variant	mouse_double_click(position = null, global_position = null)
Variant	mouse_left_button_down(position = null, global_position = null)
Variant	mouse_left_button_up(position = null, global_position = null)
Variant	mouse_left_click_at(where, duration = “5f”)
Variant	mouse_motion(position, global_position = null)
Variant	mouse_relative_motion(offset, speed = Vector2(0, 0))
Variant	mouse_right_button_down(position = null, global_position = null)
Variant	mouse_right_button_up(position = null, global_position = null)
Variant	mouse_set_position(position, global_position = null)
Variant	release_all()
Variant	send_event(event)
void	set_auto_flush_input(val)
Variant	wait(t)
Variant	wait_frames(num_frames)
Variant	wait_secs(num_secs)

---

Signals

idle() 🔗

---

Constants

INPUT_WARN = "If using Input as a reciever it will not respond to *_down events until a *_up event is recieved.  Call the appropriate *_up event or use hold_for(...) to automatically release after some duration." 🔗

No description

---

Property Descriptions

Variant InputFactory = load(...) 🔗

No description

---

Variant mouse_warp = false 🔗

Warp mouse when sending INputEventMouse* events

---

Variant draw_mouse = true 🔗

No description

---

Method Descriptions

void _init(r = null) 🔗

You can pass in a receiver if you want to.

---

void add_receiver(obj) 🔗

No description

---

Variant get_receivers() 🔗

No description

---

Variant is_idle() 🔗

No description

---

Variant is_key_pressed(which) 🔗

No description

---

Variant is_action_pressed(which) 🔗

No description

---

Variant is_mouse_button_pressed(which) 🔗

No description

---

Variant get_auto_flush_input() 🔗

No description

---

void set_auto_flush_input(val) 🔗

No description

---

Variant wait(t) 🔗

No description

---

void clear() 🔗

No description

---

Variant key_up(which) 🔗

No description

---

Variant key_down(which) 🔗

No description

---

Variant key_echo() 🔗

No description

---

Variant action_up(which, strength = 1.0) 🔗

No description

---

Variant action_down(which, strength = 1.0) 🔗

No description

---

Variant mouse_left_button_down(position = null, global_position = null) 🔗

No description

---

Variant mouse_left_button_up(position = null, global_position = null) 🔗

No description

---

Variant mouse_double_click(position = null, global_position = null) 🔗

No description

---

Variant mouse_right_button_down(position = null, global_position = null) 🔗

No description

---

Variant mouse_right_button_up(position = null, global_position = null) 🔗

No description

---

Variant mouse_motion(position, global_position = null) 🔗

No description

---

Variant mouse_relative_motion(offset, speed = Vector2(0, 0)) 🔗

No description

---

Variant mouse_set_position(position, global_position = null) 🔗

No description

---

Variant mouse_left_click_at(where, duration = “5f”) 🔗

No description

---

Variant send_event(event) 🔗

No description

---

Variant release_all() 🔗

No description

---

Variant wait_frames(num_frames) 🔗

No description

---

Variant wait_secs(num_secs) 🔗

No description

---

Variant hold_for(duration) 🔗

No description