Module SCA_JoystickSensor :: Class SCA_JoystickSensor

Class SCA_JoystickSensor

SCA_ILogicBrick.SCA_ILogicBrick --+    
                                  |    
            SCA_ISensor.SCA_ISensor --+
                                      |
                                     SCA_JoystickSensor

This sensor detects player joystick events.

Properties:

Instance Methods
list
getButtonActiveList()
Returns a list containing the indicies of the currently pressed buttons.
bool
getButtonStatus(buttonIndex)
Returns a bool of the current pressed state of the specified button.
integer
getIndex()
DEPRECATED: use the 'index' property.
 
setIndex(index)
DEPRECATED: use the 'index' property.
list
getAxis()
DEPRECATED: use the 'axis' property.
 
setAxis(axisIndex, axisDirection)
DEPRECATED: use the 'axis' property.
list
getAxisValue()
DEPRECATED: use the 'axisPosition' property.
integer
getThreshold()
DEPRECATED: use the 'threshold' property.
 
setThreshold(threshold)
DEPRECATED: use the 'threshold' property.
integer
getButton()
DEPRECATED: use the 'button' property.
 
setButton(index)
DEPRECATED: use the 'button' property.
list
getButtonValue()
DEPRECATED: use the 'getButtonActiveList' method.
list
getHat()
DEPRECATED: use the 'hat' property.
 
setHat(index, direction)
DEPRECATED: use the 'hat' property.
integer
getNumAxes()
DEPRECATED: use the 'numAxis' property.
integer
getNumButtons()
DEPRECATED: use the 'numButtons' property.
integer
getNumHats()
DEPRECATED: use the 'numHats' property.
bool
isConnected()
DEPRECATED: use the 'connected' property.
integer
getExecutePriority()
Gets the execution priority of this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
integer
getFrequency()
The frequency for pulse mode sensors. (Inherited from SCA_ISensor.SCA_ISensor)
 
getInvert()
True if this sensor activates on negative events. (Inherited from SCA_ISensor.SCA_ISensor)
boolean
getLevel()
Returns whether this sensor is a level detector or a edge detector. (Inherited from SCA_ISensor.SCA_ISensor)
KX_GameObject
getOwner()
Gets the game object associated with this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
 
getUseNegPulseMode()
True if the sensor is in negative pulse mode. (Inherited from SCA_ISensor.SCA_ISensor)
 
getUsePosPulseMode()
True if the sensor is in positive pulse mode. (Inherited from SCA_ISensor.SCA_ISensor)
 
isPositive()
True if this sensor brick is in a positive state. (Inherited from SCA_ISensor.SCA_ISensor)
 
isTriggered()
True if this sensor brick has triggered the current controller. (Inherited from SCA_ISensor.SCA_ISensor)
 
reset()
Reset sensor internal state, effect depends on the type of sensor and settings. (Inherited from SCA_ISensor.SCA_ISensor)
 
setExecutePriority(priority)
Sets the priority of this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
 
setFrequency(freq)
Sets the frequency for pulse mode sensors. (Inherited from SCA_ISensor.SCA_ISensor)
 
setInvert(invert)
Sets if this sensor activates on positive or negative events. (Inherited from SCA_ISensor.SCA_ISensor)
 
setLevel(level)
Set whether to detect level or edge transition when entering a state. (Inherited from SCA_ISensor.SCA_ISensor)
 
setUseNegPulseMode(pulse)
Sets negative pulse mode. (Inherited from SCA_ISensor.SCA_ISensor)
 
setUsePosPulseMode(pulse)
Sets positive pulse mode. (Inherited from SCA_ISensor.SCA_ISensor)
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

getButtonStatus(buttonIndex)

 

Returns a bool of the current pressed state of the specified button.

Parameters:
  • buttonIndex (integer) - the button index, 0=first button
Returns: bool

getIndex()

 

DEPRECATED: use the 'index' property. Returns the joystick index to use (from 1 to 8).

Returns: integer

setIndex(index)

 

DEPRECATED: use the 'index' property. Sets the joystick index to use.

Parameters:
  • index (integer) - The index of this joystick sensor, Clamped between 1 and 8.

Note: This is only useful when you have more then 1 joystick connected to your computer - multiplayer games.

getAxis()

 

DEPRECATED: use the 'axis' property. Returns the current axis this sensor reacts to. See getAxisValue() for the current axis state.

Returns: list
2 values returned are [axisIndex, axisDirection] - see setAxis() for their purpose.

Note: When the "All Events" toggle is set, this option has no effect.

setAxis(axisIndex, axisDirection)

 

DEPRECATED: use the 'axis' property.

Parameters:
  • axisIndex (integer from 1 to 2) - Set the axis index to use when detecting axis movement.
  • axisDirection (integer from 0 to 3) - Set the axis direction used for detecting motion. 0:right, 1:up, 2:left, 3:down.

Note: When the "All Events" toggle is set, this option has no effect.

getAxisValue()

 

DEPRECATED: use the 'axisPosition' property. Returns the state of the joysticks axis. See differs to getAxis() returning the current state of the joystick.

Returns: list
4 values, 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, ...]

Note: Some gamepads only set the axis on and off like a button.

getThreshold()

 

DEPRECATED: use the 'threshold' property. Get the axis threshold. See setThreshold() for details.

Returns: integer

setThreshold(threshold)

 

DEPRECATED: use the 'threshold' property. Set the axis threshold.

Parameters:
  • threshold (integer) - Joystick axis motion below this threshold wont trigger an event. Use values between (0 and 32767), lower values are more sensitive.

getButton()

 

DEPRECATED: use the 'button' property. Returns the button index the sensor reacts to. See getButtonValue() for a list of pressed buttons.

Returns: integer

Note: When the "All Events" toggle is set, this option has no effect.

setButton(index)

 

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.

getButtonValue()

 

DEPRECATED: use the 'getButtonActiveList' method. Returns a list containing the indicies of the currently pressed buttons.

Returns: list

getHat()

 

DEPRECATED: use the 'hat' property. Returns the current hat direction this sensor is set to. [hatNumber, hatDirection].

Returns: list

Note: When the "All Events" toggle is set, this option has no effect.

setHat(index, direction)

 

DEPRECATED: use the 'hat' property. Sets the hat index the sensor reacts to when the "All Events" option is not set.

Parameters:
  • index (integer)

getNumAxes()

 

DEPRECATED: use the 'numAxis' property. Returns the number of axes for the joystick at this index.

Returns: integer

getNumButtons()

 

DEPRECATED: use the 'numButtons' property. Returns the number of buttons for the joystick at this index.

Returns: integer

getNumHats()

 

DEPRECATED: use the 'numHats' property. Returns the number of hats for the joystick at this index.

Returns: integer

isConnected()

 

DEPRECATED: use the 'connected' property. Returns True if a joystick is detected at this joysticks index.

Returns: bool

Instance Variable Details

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. axisDirection: 0=right, 1=up, 2=left, 3=down
Type:
[integer, integer]

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.
Type:
int

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, ...]
Type:
list of ints

button

The button index the sensor reacts to (first button = 0). When the "All Events" toggle is set, this option has no effect.
Type:
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. hatDirection: 0-11
Type:
[integer, integer]

index

The joystick index to use (from 0 to 7). The first joystick is always 0.
Type:
integer

threshold

Axis threshold. Joystick axis motion below this threshold wont trigger an event. Use values between (0 and 32767), lower values are more sensitive.
Type:
integer