2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2022-03-16 22:01:02 +00:00
<class name= "InputEventMouseButton" inherits= "InputEventMouse" version= "3.5" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2017-09-12 20:42:36 +00:00
<brief_description >
Input event type for mouse button events.
</brief_description>
<description >
2018-01-18 20:37:17 +00:00
Contains mouse click information. See [method Node._input].
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
2021-11-15 16:11:20 +00:00
<link > $DOCS_URL/tutorials/inputs/mouse_and_input_coordinates.html</link>
2017-09-12 20:42:36 +00:00
</tutorials>
<methods >
</methods>
<members >
2019-06-29 10:38:01 +00:00
<member name= "button_index" type= "int" setter= "set_button_index" getter= "get_button_index" default= "0" >
2019-06-21 23:04:47 +00:00
The mouse button identifier, one of the [enum ButtonList] button or button wheel constants.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "doubleclick" type= "bool" setter= "set_doubleclick" getter= "is_doubleclick" default= "false" >
2018-12-20 12:46:54 +00:00
If [code]true[/code], the mouse button's state is a double-click.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "factor" type= "float" setter= "set_factor" getter= "get_factor" default= "1.0" >
2019-06-21 23:04:47 +00: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 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "pressed" type= "bool" setter= "set_pressed" getter= "is_pressed" default= "false" >
2018-12-20 12:46:54 +00: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 20:42:36 +00:00
</member>
</members>
<constants >
</constants>
</class>