Module GameTypes :: Class SCA_JoystickSensor

Class SCA_JoystickSensor

PyObjectPlus --+            
               |            
          CValue --+        
                   |        
     SCA_ILogicBrick --+    
                       |    
             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.

bool

isA(game_type)
Check if this is a type or a subtype game_type. (Inherited from GameTypes.PyObjectPlus)

reset()
Reset sensor internal state, effect depends on the type of sensor and settings. (Inherited from GameTypes.SCA_ISensor)

Deprecated

integer

getIndex()
Returns the joystick index to use (from 1 to 8).

setIndex(index)
Sets the joystick index to use.

list

getAxis()
Returns the current axis this sensor reacts to.

setAxis(axisIndex, axisDirection)

list

getAxisValue()
Returns the state of the joysticks axis.

integer

getThreshold()
Get the axis threshold.

setThreshold(threshold)
Set the axis threshold.

integer

getButton()
Returns the button index the sensor reacts to.

setButton(index)
Sets the button index the sensor reacts to when the "All Events" option is not set.

list

getButtonValue()
Returns a list containing the indicies of the currently pressed buttons.

list

getHat()
Returns the current hat direction this sensor is set to.

setHat(index, direction)
Sets the hat index the sensor reacts to when the "All Events" option is not set.

integer

getNumAxes()
Returns the number of axes for the joystick at this index.

integer

getNumButtons()
Returns the number of buttons for the joystick at this index.

integer

getNumHats()
Returns the number of hats for the joystick at this index.

bool

isConnected()
Returns True if a joystick is detected at this joysticks index.

integer

getExecutePriority()
Gets the execution priority of this logic brick. (Inherited from GameTypes.SCA_ILogicBrick)

integer

getFrequency()
The frequency for pulse mode sensors. (Inherited from GameTypes.SCA_ISensor)

getInvert()
True if this sensor activates on negative events. (Inherited from GameTypes.SCA_ISensor)

boolean

getLevel()
Returns whether this sensor is a level detector or a edge detector. (Inherited from GameTypes.SCA_ISensor)

string

getName()
Returns the name of the CValue. (Inherited from GameTypes.CValue)

KX_GameObject

getOwner()
Gets the game object associated with this logic brick. (Inherited from GameTypes.SCA_ILogicBrick)

getUseNegPulseMode()
True if the sensor is in negative pulse mode. (Inherited from GameTypes.SCA_ISensor)

getUsePosPulseMode()
True if the sensor is in positive pulse mode. (Inherited from GameTypes.SCA_ISensor)

isPositive()
True if this sensor brick is in a positive state. (Inherited from GameTypes.SCA_ISensor)

isTriggered()
True if this sensor brick has triggered the current controller. (Inherited from GameTypes.SCA_ISensor)

setExecutePriority(priority)
Sets the priority of this logic brick. (Inherited from GameTypes.SCA_ILogicBrick)

setFrequency(freq)
Sets the frequency for pulse mode sensors. (Inherited from GameTypes.SCA_ISensor)

setInvert(invert)
Sets if this sensor activates on positive or negative events. (Inherited from GameTypes.SCA_ISensor)

setLevel(level)
Set whether to detect level or edge transition when entering a state. (Inherited from GameTypes.SCA_ISensor)

setUseNegPulseMode(pulse)
Sets negative pulse mode. (Inherited from GameTypes.SCA_ISensor)

setUsePosPulseMode(pulse)
Sets positive pulse mode. (Inherited from GameTypes.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 GameTypes.SCA_ILogicBrick)
int	frequency The frequency for pulse mode sensors. (Inherited from GameTypes.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 (4 max).
int	hatSingle (read-only) like hatValues but returns a single hat direction value that is set by the sensor.
list of ints	hatValues (read-only) The state of the joysticks hats as a list of values numHats long.
integer	index The joystick index to use (from 0 to 7).
bool	invalid Test if the object has been freed by the game engine and is no longer valid. (Inherited from GameTypes.PyObjectPlus)
boolean	invert Flag to set if this sensor activates on positive or negative events. (Inherited from GameTypes.SCA_ISensor)
boolean	level Option whether to detect level or edge transition when entering a state. (Inherited from GameTypes.SCA_ISensor)
string	name The name of this CValue derived object (read-only). (Inherited from GameTypes.SCA_ILogicBrick)
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 GameTypes.SCA_ILogicBrick)
boolean	positive True if this sensor brick is in a positive state. (Inherited from GameTypes.SCA_ISensor)
boolean	tap When enabled only sensors that are just activated will send a positive event, after this they will be detected as negative by the controllers. (Inherited from GameTypes.SCA_ISensor)
integer	threshold Axis threshold.
boolean	triggered True if this sensor brick is in a positive state. (Inherited from GameTypes.SCA_ISensor)
boolean	useNegPulseMode Flag to turn negative pulse mode on and off. (Inherited from GameTypes.SCA_ISensor)
boolean	usePosPulseMode Flag to turn positive pulse mode on and off. (Inherited from GameTypes.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()

Returns the joystick index to use (from 1 to 8).

Returns: integer

Deprecated: Use the index attribute instead.

setIndex(index)

Sets the joystick index to use.

Parameters:

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

Deprecated: Use the index attribute instead.

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

getAxis()

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.

Deprecated: Use the axis attribute instead.

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

setAxis(axisIndex, axisDirection)

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.

Deprecated: Use the axis attribute instead.

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

getAxisValue()

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, ...]

Deprecated: Use the axisValues attribute instead.

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

getThreshold()

Get the axis threshold. See setThreshold() for details.

Returns: integer

Deprecated: Use the threshold attribute instead.

setThreshold(threshold)

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.

Deprecated: Use the threshold attribute instead.

getButton()

Returns the button index the sensor reacts to. See getButtonValue() for a list of pressed buttons.

Returns: integer

Deprecated: Use the button attribute instead.

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

setButton(index)

Sets the button index the sensor reacts to when the "All Events" option is not set.

Deprecated: Use the button attribute instead.

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

getButtonValue()

Returns a list containing the indicies of the currently pressed buttons.

Returns: list

Deprecated: Use the getButtonActiveList method instead.

getHat()

Returns the current hat direction this sensor is set to. [hatNumber, hatDirection].

Returns: list

Deprecated: Use the hat attribute instead.

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

setHat(index, direction)

Sets the hat index the sensor reacts to when the "All Events" option is not set.

Parameters:

index (integer)

Deprecated: Use the hat attribute instead.

getNumAxes()

Returns the number of axes for the joystick at this index.

Returns: integer

Deprecated: Use the numAxis attribute instead.

getNumButtons()

Returns the number of buttons for the joystick at this index.

Returns: integer

Deprecated: Use the numButtons attribute instead.

getNumHats()

Returns the number of hats for the joystick at this index.

Returns: integer

Deprecated: Use the numHats attribute instead.

isConnected()

Returns True if a joystick is detected at this joysticks index.

Returns: bool

Deprecated: Use the connected attribute instead.

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 (4 max). hatDirection: 1-12

Type:: [integer, integer]

hatValues

(read-only) The state of the joysticks hats as a list of values numHats long. each spesifying the direction of the hat from 1 to 12, 0 when inactive. Hat directions are as follows...

0:None
1:Up
2:Right
4:Down
8:Left
3:Up - Right
6:Down - Right
12:Down - Left
9:Up - Left

Type:: list of ints

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