summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2024-03-24 01:16:34 +0100
committerRémi Verschelde <rverschelde@gmail.com>2024-03-24 01:16:34 +0100
commit5940fd5d071d827b2c5fb474c49d273a02805e8a (patch)
tree428a933e0c616024a84f565c4fcd4939ee007f29
parent4389f85a174a657c2191d551279b38586adfd456 (diff)
parent6818e50adc06146aa3303acf78d95d783e3f653c (diff)
downloadredot-engine-5940fd5d071d827b2c5fb474c49d273a02805e8a.tar.gz
Merge pull request #89526 from Calinou/inputevent-add-emulation-internal-constants
Expose `DEVICE_ID_EMULATION` constant in InputEvent
-rw-r--r--core/input/input_event.cpp2
-rw-r--r--doc/classes/InputEvent.xml7
2 files changed, 8 insertions, 1 deletions
diff --git a/core/input/input_event.cpp b/core/input/input_event.cpp
index bd1fde5a85..bf1de8d3b2 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 391d060fc3..96a4612466 100644
--- a/doc/classes/InputEvent.xml
+++ b/doc/classes/InputEvent.xml
@@ -117,7 +117,12 @@
<members>
<member name="device" type="int" setter="set_device" getter="get_device" default="0">
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].
</member>
</members>
+ <constants>
+ <constant name="DEVICE_ID_EMULATION" value="-1">
+ 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.
+ </constant>
+ </constants>
</class>