summaryrefslogtreecommitdiff
path: root/doc/classes/InputEventJoypadMotion.xml
blob: a89c91fbe6e80ba724893262e54e21ced68fac41 (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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEventJoypadMotion" inherits="InputEvent" category="Core" version="3.0-alpha">
	<brief_description>
		Input event type for gamepad joysticks and other motions. For buttons see [code]InputEventJoypadMotion[/code].
	</brief_description>
	<description>
		Stores information about joystick motions. One [code]InputEventJoypadMotion[/code] represents one axis at a time.
	</description>
	<tutorials>
		http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_axis" qualifiers="const">
			<return type="int">
			</return>
			<description>
			</description>
		</method>
		<method name="get_axis_value" qualifiers="const">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="set_axis">
			<return type="void">
			</return>
			<argument index="0" name="axis" type="int">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_axis_value">
			<return type="void">
			</return>
			<argument index="0" name="axis_value" type="float">
			</argument>
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="axis" type="int" setter="set_axis" getter="get_axis">
			Axis identifier. Use one of the [code]JOY_AXIS_*[/code] constants in [@global Scope].
		</member>
		<member name="axis_value" type="float" setter="set_axis_value" getter="get_axis_value">
			Current position of the joystick on the given axis. The value ranges from [code]-1.0[/code] to [code]1.0[/code]. A value of [code]0[/code] means the axis is in its resting position.
		</member>
	</members>
	<constants>
	</constants>
</class>