Pydoc: Fix multiple bpy.type modules
[blender.git] / doc / python_api / rst / bge_types / bge.types.SCA_JoystickSensor.rst
1 SCA_JoystickSensor(SCA_ISensor)
2 ===============================
3
4 base class --- :class:`SCA_ISensor`
5
6 .. class:: SCA_JoystickSensor(SCA_ISensor)
7
8    This sensor detects player joystick events.
9
10    .. attribute:: axisValues
11
12       The state of the joysticks axis as a list of values :data:`numAxis` long. (read-only).
13
14       :type: list of ints.
15
16       Each specifying the value of an axis between -32767 and 32767 depending on how far the axis is pushed, 0 for nothing.
17       The first 2 values are used by most joysticks and gamepads for directional control. 3rd and 4th values are only on some joysticks and can be used for arbitary controls.
18
19       * left:[-32767, 0, ...]
20       * right:[32767, 0, ...]
21       * up:[0, -32767, ...]
22       * down:[0, 32767, ...]
23
24    .. attribute:: axisSingle
25
26       like :data:`axisValues` but returns a single axis value that is set by the sensor. (read-only).
27
28       :type: integer
29
30       .. note::
31          
32          Only use this for "Single Axis" type sensors otherwise it will raise an error.
33
34    .. attribute:: hatValues
35
36       The state of the joysticks hats as a list of values :data:`numHats` long. (read-only).
37
38       :type: list of ints
39
40       Each specifying the direction of the hat from 1 to 12, 0 when inactive.
41
42       Hat directions are as follows...
43
44       * 0:None
45       * 1:Up
46       * 2:Right
47       * 4:Down
48       * 8:Left
49       * 3:Up - Right
50       * 6:Down - Right
51       * 12:Down - Left
52       * 9:Up - Left
53
54    .. attribute:: hatSingle
55
56       Like :data:`hatValues` but returns a single hat direction value that is set by the sensor. (read-only).
57
58       :type: integer
59
60    .. attribute:: numAxis
61
62       The number of axes for the joystick at this index. (read-only).
63
64       :type: integer
65
66    .. attribute:: numButtons
67
68       The number of buttons for the joystick at this index. (read-only).
69
70       :type: integer
71
72    .. attribute:: numHats
73
74       The number of hats for the joystick at this index. (read-only).
75
76       :type: integer
77
78    .. attribute:: connected
79
80       True if a joystick is connected at this joysticks index. (read-only).
81
82       :type: boolean
83
84    .. attribute:: index
85
86       The joystick index to use (from 0 to 7). The first joystick is always 0.
87
88       :type: integer
89
90    .. attribute:: threshold
91
92       Axis threshold. Joystick axis motion below this threshold wont trigger an event. Use values between (0 and 32767), lower values are more sensitive.
93
94       :type: integer
95
96    .. attribute:: button
97
98       The button index the sensor reacts to (first button = 0). When the "All Events" toggle is set, this option has no effect.
99
100       :type: integer
101
102    .. attribute:: axis
103
104       The axis this sensor reacts to, as a list of two values [axisIndex, axisDirection]
105
106       * axisIndex: the axis index to use when detecting axis movement, 1=primary directional control, 2=secondary directional control.
107       * axisDirection: 0=right, 1=up, 2=left, 3=down.
108
109       :type: [integer, integer]
110
111    .. attribute:: hat
112
113       The hat the sensor reacts to, as a list of two values: [hatIndex, hatDirection]
114
115       * hatIndex: the hat index to use when detecting hat movement, 1=primary hat, 2=secondary hat (4 max).
116       * hatDirection: 1-12.
117
118       :type: [integer, integer]
119
120    .. method:: getButtonActiveList()
121
122       :return: A list containing the indicies of the currently pressed buttons.
123       :rtype: list
124
125    .. method:: getButtonStatus(buttonIndex)
126
127       :arg buttonIndex: the button index, 0=first button
128       :type buttonIndex: integer
129       :return: The current pressed state of the specified button.
130       :rtype: boolean