Home | Trees | Indices | Help |
|
---|
|
SCA_ILogicBrick.SCA_ILogicBrick --+ | SCA_ISensor.SCA_ISensor --+ | SCA_JoystickSensor
This sensor detects player joystick events.
Properties:
Instance Methods | |||
list |
|
||
bool |
|
||
integer |
|
||
|
|||
list |
|
||
|
|||
list |
|
||
integer |
|
||
|
|||
integer |
|
||
|
|||
list |
|
||
list |
|
||
|
|||
integer |
|
||
integer |
|
||
integer |
|
||
bool |
|
||
integer |
|
||
integer |
|
||
|
|||
boolean |
|
||
KX_GameObject |
|
||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
Instance Variables | |
[integer, integer] |
axis The axis this sensor reacts to, as a list of two values [axisIndex, axisDirection] axisIndex: the axis index to use when detecting axis movement, 1=primary directional control, 2=secondary directional control. |
int |
axisSingle (read-only) like axisValues but returns a single axis value that is set by the sensor. |
list of ints |
axisValues (read-only) The state of the joysticks axis as a list of values numAxis long. |
integer |
button The button index the sensor reacts to (first button = 0). |
boolean |
connected (read-only) True if a joystick is connected at this joysticks index. |
int |
executePriority This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first). (Inherited from SCA_ILogicBrick.SCA_ILogicBrick) |
int |
frequency The frequency for pulse mode sensors. (Inherited from SCA_ISensor.SCA_ISensor) |
[integer, integer] |
hat The hat the sensor reacts to, as a list of two values: [hatIndex, hatDirection] hatIndex: the hat index to use when detecting hat movement, 1=primary hat, 2=secondary hat. |
integer |
index The joystick index to use (from 0 to 7). |
boolean |
invert Flag to set if this sensor activates on positive or negative events. (Inherited from SCA_ISensor.SCA_ISensor) |
boolean |
level Flag to set whether to detect level or edge transition when entering a state. (Inherited from SCA_ISensor.SCA_ISensor) |
integer |
numAxis (read-only) The number of axes for the joystick at this index. |
integer |
numButtons (read-only) The number of buttons for the joystick at this index. |
integer |
numHats (read-only) The number of hats for the joystick at this index. |
KX_GameObject or None in exceptional cases. |
owner The game object this logic brick is attached to (read only). (Inherited from SCA_ILogicBrick.SCA_ILogicBrick) |
boolean |
positive True if this sensor brick is in a positive state. (Inherited from SCA_ISensor.SCA_ISensor) |
integer |
threshold Axis threshold. |
boolean |
triggered True if this sensor brick is in a positive state. (Inherited from SCA_ISensor.SCA_ISensor) |
boolean |
useNegPulseMode Flag to turn negative pulse mode on and off. (Inherited from SCA_ISensor.SCA_ISensor) |
boolean |
usePosPulseMode Flag to turn positive pulse mode on and off. (Inherited from SCA_ISensor.SCA_ISensor) |
Method Details |
Returns a bool of the current pressed state of the specified button.
|
DEPRECATED: use the 'index' property. Returns the joystick index to use (from 1 to 8).
|
DEPRECATED: use the 'index' property. Sets the joystick index to use.
Note: This is only useful when you have more then 1 joystick connected to your computer - multiplayer games. |
DEPRECATED: use the 'axis' property. Returns the current axis this sensor reacts to. See getAxisValue() for the current axis state.
Note: When the "All Events" toggle is set, this option has no effect. |
DEPRECATED: use the 'axis' property.
Note: When the "All Events" toggle is set, this option has no effect. |
DEPRECATED: use the 'axisPosition' property. Returns the state of the joysticks axis. See differs to getAxis() returning the current state of the joystick.
Note: Some gamepads only set the axis on and off like a button. |
DEPRECATED: use the 'threshold' property. Get the axis threshold. See setThreshold() for details.
|
DEPRECATED: use the 'threshold' property. Set the axis threshold.
|
DEPRECATED: use the 'button' property. Returns the button index the sensor reacts to. See getButtonValue() for a list of pressed buttons.
Note: When the "All Events" toggle is set, this option has no effect. |
DEPRECATED: use the 'button' property. Sets the button index the sensor reacts to when the "All Events" option is not set. Note: When the "All Events" toggle is set, this option has no effect. |
DEPRECATED: use the 'getButtonActiveList' method. Returns a list containing the indicies of the currently pressed buttons.
|
DEPRECATED: use the 'hat' property. Returns the current hat direction this sensor is set to. [hatNumber, hatDirection].
Note: When the "All Events" toggle is set, this option has no effect. |
DEPRECATED: use the 'hat' property. Sets the hat index the sensor reacts to when the "All Events" option is not set.
|
DEPRECATED: use the 'numAxis' property. Returns the number of axes for the joystick at this index.
|
DEPRECATED: use the 'numButtons' property. Returns the number of buttons for the joystick at this index.
|
DEPRECATED: use the 'numHats' property. Returns the number of hats for the joystick at this index.
|
DEPRECATED: use the 'connected' property. Returns True if a joystick is detected at this joysticks index.
|
Instance Variable Details |
axisThe axis this sensor reacts to, as a list of two values [axisIndex, axisDirection] axisIndex: the axis index to use when detecting axis movement, 1=primary directional control, 2=secondary directional control. axisDirection: 0=right, 1=up, 2=left, 3=down
|
axisSingle(read-only) like axisValues but returns a single axis value that is set by the sensor. Only use this for "Single Axis" type sensors otherwise it will raise an error.
|
axisValues(read-only) The state of the joysticks axis as a list of values numAxis long. each spesifying the value of an axis between -32767 and 32767 depending on how far the axis is pushed, 0 for nothing. 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. left:[-32767, 0, ...], right:[32767, 0, ...], up:[0, -32767, ...], down:[0, 32767, ...]
|
buttonThe button index the sensor reacts to (first button = 0). When the "All Events" toggle is set, this option has no effect.
|
hatThe hat the sensor reacts to, as a list of two values: [hatIndex, hatDirection] hatIndex: the hat index to use when detecting hat movement, 1=primary hat, 2=secondary hat. hatDirection: 0-11
|
indexThe joystick index to use (from 0 to 7). The first joystick is always 0.
|
thresholdAxis threshold. Joystick axis motion below this threshold wont trigger an event. Use values between (0 and 32767), lower values are more sensitive.
|
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0 on Fri Apr 24 17:51:19 2009 | http://epydoc.sourceforge.net |