summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2019-12-30 15:28:24 +0100
committerHugo Locurcio <hugo.locurcio@hugo.pro>2019-12-30 15:30:34 +0100
commit9ae73f7bb53e7e4052cf99371f850e9ee001fad6 (patch)
tree87a21e2fc7102a739b55c32de240f3df7ede3022
parentb8e8f4942d5ae49d4661ed685486abcc8b5cbd55 (diff)
Document how to distinguish emulated mouse events from physical ones
Mouse events emulated from a touchscreen will always have a device ID of -1.
-rw-r--r--doc/classes/InputEvent.xml1
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/classes/InputEvent.xml b/doc/classes/InputEvent.xml
index d412ce09e2..ccb5c5400a 100644
--- a/doc/classes/InputEvent.xml
+++ b/doc/classes/InputEvent.xml
@@ -111,6 +111,7 @@
<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.
</member>
</members>
<constants>