Version: Unity 6 Preview (6000.0)
LanguageEnglish
  • C#

Input.IsJoystickPreconfigured

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public static bool IsJoystickPreconfigured(string joystickName);

Parameters

joystickName The name of the joystick to check (returned by Input.GetJoystickNames).

Returns

bool True if the joystick layout has been preconfigured; false otherwise.

Description

Determine whether a particular joystick model has been preconfigured by Unity. (Linux-only).

Note: This API is part of the legacy Input class, and not recommended for new projects. The documentation is provided here to support legacy projects that use the old Input Manager and Input class. For new projects you should use the newer and Input System Package. (read more).

Preconfigured joysticks report indices for buttons and axes in the following order. Buttons: A, B, X, Y, left bumper, right bumper, select, start, guide, left stick press, right stick press Axes: left stick x, left stick y, left trigger, right stick x, right stick y, right trigger, dpad horizontal, dpad vertical.