From 6818e50adc06146aa3303acf78d95d783e3f653c Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Fri, 15 Mar 2024 18:10:41 +0100 Subject: [PATCH] Expose `DEVICE_ID_EMULATION` constant in InputEvent This also improves the documentation related to emulated InputEvents. --- core/input/input_event.cpp | 2 ++ doc/classes/InputEvent.xml | 7 ++++++- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/core/input/input_event.cpp b/core/input/input_event.cpp index bd1fde5a85e..bf1de8d3b27 100644 --- a/core/input/input_event.cpp +++ b/core/input/input_event.cpp @@ -132,6 +132,8 @@ void InputEvent::_bind_methods() { ClassDB::bind_method(D_METHOD("xformed_by", "xform", "local_ofs"), &InputEvent::xformed_by, DEFVAL(Vector2())); ADD_PROPERTY(PropertyInfo(Variant::INT, "device"), "set_device", "get_device"); + + BIND_CONSTANT(DEVICE_ID_EMULATION); } /////////////////////////////////// diff --git a/doc/classes/InputEvent.xml b/doc/classes/InputEvent.xml index 391d060fc3d..96a46124667 100644 --- a/doc/classes/InputEvent.xml +++ b/doc/classes/InputEvent.xml @@ -117,7 +117,12 @@ The event's device ID. - [b]Note:[/b] This device ID will always be [code]-1[/code] for emulated mouse input from a touchscreen. This can be used to distinguish emulated mouse input from physical mouse input. + [b]Note:[/b] [member device] can be negative for special use cases that don't refer to devices physically present on the system. See [constant DEVICE_ID_EMULATION]. + + + Device ID used for emulated mouse input from a touchscreen, or for emulated touch input from a mouse. This can be used to distinguish emulated mouse input from physical mouse input, or emulated touch input from physical touch input. + +