summaryrefslogtreecommitdiff
path: root/doc/classes/InputEventMouseButton.xml
blob: cd1037b0224565bfef2fe40464298ff00d7e2dae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEventMouseButton" inherits="InputEventMouse" category="Core" version="3.0-beta">
	<brief_description>
		Input event type for mouse button events.
	</brief_description>
	<description>
		Contains mouse click informations. See [method Node._input].
	</description>
	<tutorials>
		http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.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">
			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">
			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">
			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>