summaryrefslogtreecommitdiff
path: root/doc/classes/InputEventJoypadButton.xml
blob: 18e33c2131926a8a353aa62819bc3e89aeb5edc2 (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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEventJoypadButton" inherits="InputEvent" category="Core" version="3.1">
	<brief_description>
		Input event for gamepad buttons.
	</brief_description>
	<description>
		Input event type for gamepad buttons. For joysticks see [InputEventJoypadMotion].
	</description>
	<tutorials>
		<link>https://docs.godotengine.org/en/latest/tutorials/inputs/inputevent.html</link>
	</tutorials>
	<demos>
	</demos>
	<methods>
	</methods>
	<members>
		<member name="button_index" type="int" setter="set_button_index" getter="get_button_index">
			Button identifier. One of the [code]JOY_BUTTON_*[/code] constants from [@GlobalScope].
		</member>
		<member name="pressed" type="bool" setter="set_pressed" getter="is_pressed">
			If [code]true[/code] the button's state is pressed. If [code]false[/code] the button's state is released.
		</member>
		<member name="pressure" type="float" setter="set_pressure" getter="get_pressure">
			Represents the pressure the user puts on the button with his finger, if the controller supports it. Ranges from [code]0[/code] to [code]1[/code].
		</member>
	</members>
	<constants>
	</constants>
</class>