summaryrefslogtreecommitdiff
path: root/doc/classes/InputEventJoypadButton.xml
blob: fecd65e6a20ff5636c933f9cb99071d379ee4879 (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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEventJoypadButton" inherits="InputEvent" category="Core" version="3.0-alpha">
	<brief_description>
		Input event for gamepad buttons.
	</brief_description>
	<description>
		Input event type for gamepad buttons. For joysticks see [InputEventJoypadMotion].
	</description>
	<tutorials>
		http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_button_index" qualifiers="const">
			<return type="int">
			</return>
			<description>
			</description>
		</method>
		<method name="get_pressure" qualifiers="const">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="set_button_index">
			<return type="void">
			</return>
			<argument index="0" name="button_index" type="int">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_pressed">
			<return type="void">
			</return>
			<argument index="0" name="pressed" type="bool">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_pressure">
			<return type="void">
			</return>
			<argument index="0" name="pressure" type="float">
			</argument>
			<description>
			</description>
		</method>
	</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 [@global Scope].
		</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>