2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 09:03:48 +08:00
<class name= "InputEventMouseButton" inherits= "InputEventMouse" version= "4.0" >
2017-09-13 04:42:36 +08:00
<brief_description >
Input event type for mouse button events.
</brief_description>
<description >
2018-01-19 04:37:17 +08:00
Contains mouse click information. See [method Node._input].
2017-09-13 04:42:36 +08:00
</description>
<tutorials >
2020-08-05 20:43:40 +08:00
<link title= "Mouse and input coordinates" > https://docs.godotengine.org/en/latest/tutorials/inputs/mouse_and_input_coordinates.html</link>
2017-09-13 04:42:36 +08:00
</tutorials>
<methods >
</methods>
<members >
2019-06-29 18:38:01 +08:00
<member name= "button_index" type= "int" setter= "set_button_index" getter= "get_button_index" default= "0" >
2019-06-22 07:04:47 +08:00
The mouse button identifier, one of the [enum ButtonList] button or button wheel constants.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "doubleclick" type= "bool" setter= "set_doubleclick" getter= "is_doubleclick" default= "false" >
2018-12-20 20:46:54 +08:00
If [code]true[/code], the mouse button's state is a double-click.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "factor" type= "float" setter= "set_factor" getter= "get_factor" default= "1.0" >
2019-06-22 07:04:47 +08: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-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "pressed" type= "bool" setter= "set_pressed" getter= "is_pressed" default= "false" >
2018-12-20 20:46:54 +08: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-13 04:42:36 +08:00
</member>
</members>
<constants >
</constants>
</class>