JoystickSensor

The JoystickSensor node is used to map gamepads or joysticks. It supports devices based on Direct Input and on XInput.

Platform support

This node is fully supported on XR-Windows platform.

It is partially supported on XR-Portable Windows, XR-Portable iOS, XR-Portable Android, and XR-P WASM platforms.

Notes

• The JoyStick node can be created for portable platforms; however, no items can be linked to it.

• The JoyStick node is supported for module compatibility reasons, since mobile devices do not support gamepads.

  XR-WIN	XR-P-WIN	XR-P-IOS	XR-P-AND	XR-P-WASM
  Full support	Partial support	Partial support	Partial support	Partial support

The JoystickSensor Interaction model

The JoystickSensor node offers access to multiple input elements in three categories. Each instance of an input category corresponds a group of fields in the node.

• Button: A button triggers events when pressed or released. There are 12 mapped buttons (B1,B2,B3,B4,B5,B6,B7,B8,B9,B10,B11, and B12).

• Axis: An axis provides a direction and an intensity. There are two mapped axes (R and L).

• POV: A POV is a group of cross displaced buttons. Each direction button triggers separate events when pressed or released. There is one unique mapped POV (P).

Vibration

JoystickSensor offer two ways to drive device vibration.

• Direct vibration control. Vibration is activated and deactivated using the vibrationActive field. Intensity is controlled with vibrationGain, vibrationLeft, and vibrationRight.

• Time based control. Uses vibrate field to define vibration length, left intensity, and right intensity.

Code example

This is a code example for JoystickSensor.

<--declaration -->

<Joysticksensor name="joy0"/>

<!--routing few buttons to a command -->

<route from="joy0.B1Down" to="logButton.execute" value="Button 1"/>

<route from="joy0.B2Down" to="logButton.execute" value="Button 2"/>

<route from="joy0.B3Down" to="logButton.execute" value="Button 3"/>

<!--command to log the pressed button -->

<Command name="logButton" args="buttonName=sstring">

<log text="Pressed [@%buttonName%]" />

</Command>

Joystick Sensor fields

These are the fields for JoystickSensor node. Only the node-specific fields are indicated, not fields obtained by inheritance.

Field inheritance: NodeBase > JoystickSensor

Node general fields

Button related fields

Each one of the 12 mapped buttons exposes a set of fields that can be accessed with this syntax.

joystickSensorName.buttonNameField

For example: joy0.B4Down

POV related fields

The mapped POV exposes a set of fields that can be accessed with this syntax.

joystickSensorName.povNameField

For example: joy0.PDUp

Axis related fields

The two mapped Axes expose a set of fields that can be accessed with this syntax.

joystickSensorName.axisNameField

For example: joy0.LRUp