Joystick Properties

List of axes in this controller.

List of Axis2Ds in this controller.

The Axis2D count in the controller.

The axis count in the controller.

Gets a list of all Axis element identifiers. There is always one element identifier per Axis which is at the same index as the corresponding Axis.

The Button count in the controller.

Gets a list of all Button element identifiers. There is always one element identifier per Button which is at the same index as the corresponding Button.

List of Buttons in this controller.

The Calibration Map in this controller.

List of all Compound Elements in this controller.

The unique persistent instance GUID of this device. This is an id generated for the device that may stay constant between application sessions and system restarts. This can be used for device assignment persistence between runs. The specific platform and input sources in use affects the reliability of this value for device assignment persistence. A value of Guid.Empty means the device or input source has no reliable unique identifier so persistant assignment isn't possible using this value. Even if a Guid is provided, reliability when multiple identical controllers are attached depends greatly on the platform and input source(s) currently in use.

The Element count in the controller.

Gets a list of all element identifiers of all types.

List of all Elements in this controller.

Is the controller enabled? Disabled controllers return no input.

Gets an object used to access controller and platform-specific controller functions.

String of information from the controller used for identifying unknown controller maps for saving/loading.

The name the controller hardware returns.

The Rewired GUID associated with this device. A GUID of all zeros is an Unknown Controller.

The number of Hats in this controller.

List of Hats in this controller.

Gets identifying information about the Controller.

Is the controller connected?

String representation of the controller map type. Can be used for saving/loading.

The name of the controller. This is drawn from the controller definition for recognized controllers. For unrecognized controllers, the name returned by the hardware is used instead.

Does this controller support vibration?

The id of the device in the underlying input source. The meaning of this value is determined by the current input source. This may include Unity input, Raw Input, Direct Input, OSX I/O Kit, XBoxOneInput, Ouya input, and others. Generally, you should never need to use this, but it is exposed for advanced uses. Returns null if there is no system id associated with this joystick.

The tag assigned to the controller. Can be used for find a controller by tag.

The Template count in the controller.

The Controller Templates that the Controller implements.

The type of this controller.

The unity joystick id of this joystick. This value is only used on platforms that use Unity input as the underlying input source. This value is a 1-based index corresponding to the joystick number in the Unity input manager. Generally, you should never need to use this, but it is exposed for advanced uses. Returns 0 if the platform does not use Unity input or if the joystick is not associated with a Unity joystick.

Sets vibration speed on the left motor or the motor at index 0. [float: 0.0 - 1.0] This is specifically for XInput controllers on Windows.

The number of vibration motors this device supports.

Sets vibration speed on the right motor or the motor at index 1. [float: 0.0 - 1.0] This is specifically for XInput controllers on Windows.