godot/doc/classes/InputEventMouseButton.xml

33 lines
1.3 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEventMouseButton" inherits="InputEventMouse" category="Core" version="3.1">
<brief_description>
Input event type for mouse button events.
</brief_description>
<description>
Contains mouse click information. See [method Node._input].
</description>
<tutorials>
http://docs.godotengine.org/en/3.0/tutorials/inputs/mouse_and_input_coordinates.html
</tutorials>
<demos>
</demos>
<methods>
</methods>
<members>
<member name="button_index" type="int" setter="set_button_index" getter="get_button_index">
Mouse button identifier, one of the BUTTON_* or BUTTON_WHEEL_* constants in [@GlobalScope].
</member>
<member name="doubleclick" type="bool" setter="set_doubleclick" getter="is_doubleclick">
2017-10-15 22:07:13 +00:00
If [code]true[/code] the mouse button's state is a double-click. If [code]false[/code] the mouse button's state is released.
</member>
<member name="factor" type="float" setter="set_factor" getter="get_factor">
2017-10-15 22:07:13 +00:00
TO TALK in PR, reduz said : i think it's used for apple touch but i don't remember what it does
</member>
<member name="pressed" type="bool" setter="set_pressed" getter="is_pressed">
2017-10-15 22:07:13 +00:00
If [code]true[/code] the mouse button's state is pressed. If [code]false[/code] the mouse button's state is released.
</member>
</members>
<constants>
</constants>
</class>