2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-07-03 18:19:12 +02:00
<class name= "InputEventMouseButton" inherits= "InputEventMouse" keywords= "click, press" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2017-09-12 22:42:36 +02:00
<brief_description >
2023-04-28 01:35:33 +02:00
Represents a mouse button being pressed or released.
2017-09-12 22:42:36 +02:00
</brief_description>
<description >
2023-04-28 01:35:33 +02:00
Stores information about mouse click events. See [method Node._input].
2024-02-09 11:33:06 +01:00
[b]Note:[/b] On Wear OS devices, rotary input is mapped to [constant MOUSE_BUTTON_WHEEL_UP] and [constant MOUSE_BUTTON_WHEEL_DOWN]. This can be changed to [constant MOUSE_BUTTON_WHEEL_LEFT] and [constant MOUSE_BUTTON_WHEEL_RIGHT] with the [member ProjectSettings.input_devices/pointing/android/rotary_input_scroll_axis] setting.
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
2023-04-28 01:35:33 +02:00
<link title= "Using InputEvent" > $DOCS_URL/tutorials/inputs/inputevent.html</link>
2021-11-15 10:43:07 +01:00
<link title= "Mouse and input coordinates" > $DOCS_URL/tutorials/inputs/mouse_and_input_coordinates.html</link>
2017-09-12 22:42:36 +02:00
</tutorials>
<members >
2021-03-25 21:56:12 +01:00
<member name= "button_index" type= "int" setter= "set_button_index" getter= "get_button_index" enum= "MouseButton" default= "0" >
2020-05-14 00:27:34 +02:00
The mouse button identifier, one of the [enum MouseButton] button or button wheel constants.
2017-09-12 22:42:36 +02:00
</member>
2023-05-04 02:57:13 +02:00
<member name= "canceled" type= "bool" setter= "set_canceled" getter= "is_canceled" default= "false" >
If [code]true[/code], the mouse button event has been canceled.
</member>
2021-04-13 10:25:44 +02:00
<member name= "double_click" type= "bool" setter= "set_double_click" getter= "is_double_click" default= "false" >
2018-12-20 13:46:54 +01:00
If [code]true[/code], the mouse button's state is a double-click.
2017-09-12 22:42:36 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "factor" type= "float" setter= "set_factor" getter= "get_factor" default= "1.0" >
2019-06-22 01:04:47 +02:00
The amount (or delta) of the event. When used for high-precision scroll events, this indicates the scroll amount (vertical or horizontal). This is only supported on some platforms; the reported sensitivity varies depending on the platform. May be [code]0[/code] if not supported.
2017-09-12 22:42:36 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "pressed" type= "bool" setter= "set_pressed" getter= "is_pressed" default= "false" >
2018-12-20 13:46:54 +01:00
If [code]true[/code], the mouse button's state is pressed. If [code]false[/code], the mouse button's state is released.
2017-09-12 22:42:36 +02:00
</member>
</members>
</class>