Gamepads

BeginnerProgrammer Gamepads, such as the Xbox Elite Wireless Controller and the PS4 DualShock, are popular input devices for consoles and desktop.

Note

Xenko is currently optimized for the Xbox Elite gamepad. Other controllers work, but might have unexpected button mappings. Gamepad-specific features like the PS4 DualShock touchpad aren’t supported.

Digital and analog buttons

• Digital buttons have two states: up and down. The D-pad, Start, Back, Thumbstick (press), A, B, X and Y buttons are digital buttons.
• Analog buttons return a value depending on how hard the user presses. The triggers are analog buttons, and return a value between 0 and 1. The thumbsticks are also analog, and return values between -1 and 1 on the X and Y axes. The Xbox Elite controller buttons have the following names in Xenko:

  Handle gamepad input

  Check that gamepads are connected

  Before handling gamepad input:
• InputManager.HasGamePad.
• InputManager.GamePadCount.
• InputManager.DeviceRemoved event.
• InputManager.DeviceAdded event.

  Digital buttons

  GamePad object, call: Button (GamePadButton) is the gamepad button you want to check. GamePadState.Buttons.

  Note

  GamePadState.Buttons field is a bitmask that uses binary system. Depending on the bitmask value, you can determine which buttons are up or down. IGamePadDevice.State.

  Analog buttons

  GetGamePadByIndex(index), where index (Integer) is the index of the gamepad you want to check.

  Warning

  IGamePadDevice.State is the state of the gamepad at the current update. You can’t reuse this value for the next updates. You have to query it again in every update. GamePadState fields: Thumbsticks move along the X and Y axes. Their positions read as follows: Triggers move along the X axis. Their positions read as follows:

  Vibration

  IGamePadDevice.SetVibration.

  Note

  Xenko currently only supports vibration for Xbox gamepads.

  Example code

  using Xenko.Core.Mathematics;using Xenko.Engine;public class TestScript : SyncScript{    public override void Update()    {        //Check if a gamepad is connected        if (Input.HasGamePad)        {            //Get the number of connected gamepads            int gamepadCount = Input.GamePadCount;            // Check each gamepad's status            foreach(var gamepad in Input.GamePads)            {                // Get the analog thumbstick positions                Vector2 speed = gamepad.State.LeftThumb;                Vector2 direction = gamepad.State.RightThumb;                // Get the digital buttons' status                if (gamepad.IsButtonDown(GamePadButton.X))                {                    // The action repeats for as long as the user holds the button down.                    // This is useful for continuous actions such as firing a machine gun.                }                if (gamepad.IsButtonPressed(GamePadButton.A))                {                    // The action is triggered only once, even if the user holds the button down.                    // This is useful for one-time actions such as jumping.                }            }        }    }}

  See also

• Keyboards
• Virtual buttons
• Input overview