Click or drag to resize

Joystick Properties

The Joystick type exposes the following members.

Properties
  NameDescription
Public propertyAxes
List of axes in this controller.
(Inherited from ControllerWithAxes.)
Public propertyAxes2D
List of Axis2Ds in this controller.
(Inherited from ControllerWithAxes.)
Public propertyaxis2DCount
The Axis2D count in the controller.
(Inherited from ControllerWithAxes.)
Public propertyaxisCount
The axis count in the controller.
(Inherited from ControllerWithAxes.)
Public propertyAxisElementIdentifiers
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.
(Inherited from ControllerWithAxes.)
Public propertybuttonCount
The Button count in the controller.
(Inherited from Controller.)
Public propertyButtonElementIdentifiers
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.
(Inherited from Controller.)
Public propertyButtons
List of Buttons in this controller.
(Inherited from Controller.)
Public propertycalibrationMap
The Calibration Map in this controller.
(Inherited from ControllerWithAxes.)
Public propertydeviceInstanceGuid
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.
(Overrides ControllerdeviceInstanceGuid.)
Public propertyelementCount
The Element count in the controller.
(Inherited from Controller.)
Public propertyElementIdentifiers
Gets a list of all element identifiers of all types.
(Inherited from Controller.)
Public propertyElements
List of all Elements in this controller.
(Inherited from Controller.)
Public propertyenabled
Is the controller enabled? Disabled controllers return no input.
(Inherited from Controller.)
Public propertyextension
Gets an object used to access controller and platform-specific controller functions.
(Inherited from Controller.)
Public propertyhardwareIdentifier
String of information from the controller used for identifying unknown controller maps for saving/loading.
(Inherited from Controller.)
Public propertyhardwareName
The name the controller hardware returns.
(Inherited from Controller.)
Public propertyhardwareTypeGuid
The Rewired GUID associated with this device. A GUID of all zeros is an Unknown Controller.
(Inherited from Controller.)
Public propertyhatCount
The number of Hats in this controller.
Public propertyHats
List of Hats in this controller.
Public propertyidentifier
Gets identifying information about the Controller.
(Inherited from Controller.)
Public propertyisConnected
Is the controller connected?
(Inherited from Controller.)
Public propertymapTypeString
String representation of the controller map type. Can be used for saving/loading.
(Inherited from Controller.)
Public propertyname
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.
(Inherited from Controller.)
Public propertysupportsVibration
Does this controller support vibration?
Public propertysystemId
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.
Public propertytag
The tag assigned to the controller. Can be used for find a controller by tag.
(Inherited from Controller.)
Public propertytemplateCount
The Template count in the controller.
(Inherited from Controller.)
Public propertyTemplates
The Controller Templates that the Controller implements.
(Inherited from Controller.)
Public propertytype
The type of this controller.
(Inherited from Controller.)
Public propertyunityId
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.
Public propertyvibrationLeftMotor
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.
Public propertyvibrationMotorCount
The number of vibration motors this device supports.
Public propertyvibrationRightMotor
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.
Top
See Also