summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPedro J. Estébanez <pedrojrulez@gmail.com>2021-10-14 18:58:15 +0200
committerPedro J. Estébanez <pedrojrulez@gmail.com>2021-10-22 14:28:48 +0200
commit6dc3fae201574cca599b322d24bb091bd1dbdcbd (patch)
treec8c7fc9fad0e8c4a3a776650156d89702b4d5443
parentbf322bacdd99cdb81bd7870b0b196ef01652581c (diff)
Expose Input::flush_buffered_events()
-rw-r--r--core/input/input.cpp1
-rw-r--r--doc/classes/Input.xml7
2 files changed, 8 insertions, 0 deletions
diff --git a/core/input/input.cpp b/core/input/input.cpp
index f9a361c761..8d518ef6ce 100644
--- a/core/input/input.cpp
+++ b/core/input/input.cpp
@@ -129,6 +129,7 @@ void Input::_bind_methods() {
ClassDB::bind_method(D_METHOD("set_custom_mouse_cursor", "image", "shape", "hotspot"), &Input::set_custom_mouse_cursor, DEFVAL(CURSOR_ARROW), DEFVAL(Vector2()));
ClassDB::bind_method(D_METHOD("parse_input_event", "event"), &Input::parse_input_event);
ClassDB::bind_method(D_METHOD("set_use_accumulated_input", "enable"), &Input::set_use_accumulated_input);
+ ClassDB::bind_method(D_METHOD("flush_buffered_events"), &Input::flush_buffered_events);
BIND_ENUM_CONSTANT(MOUSE_MODE_VISIBLE);
BIND_ENUM_CONSTANT(MOUSE_MODE_HIDDEN);
diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml
index 00ead31115..5d9c25b374 100644
--- a/doc/classes/Input.xml
+++ b/doc/classes/Input.xml
@@ -37,6 +37,13 @@
Adds a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices.
</description>
</method>
+ <method name="flush_buffered_events">
+ <return type="void" />
+ <description>
+ Sends all input events which are in the current buffer to the game loop. These events may have been buffered as a result of accumulated input ([method set_use_accumulated_input]) or agile input flushing ([member ProjectSettings.input_devices/buffering/agile_event_flushing]).
+ The engine will already do this itself at key execution points (at least once per frame). However, this can be useful in advanced cases where you want precise control over the timing of event handling.
+ </description>
+ </method>
<method name="get_accelerometer" qualifiers="const">
<return type="Vector3" />
<description>