Share via

GamePad.GetState Method (PlayerIndex)

  • Article

Gets the current state of an Xbox 360 Controller.

Namespace: Microsoft.Xna.Framework.Input
Assembly: Microsoft.Xna.Framework (in microsoft.xna.framework.dll)

Syntax

public static GamePadState GetState (
         PlayerIndex playerIndex
)

Parameters

  • playerIndex
    Player index for the controller you want to query.

Return Value

The current state of the controller.

Exceptions

Exception type Condition
InvalidOperationException An unknown error has occurred. Verify that the correct playerIndex is being requested.

Remarks

When calling GetState, check the returned structure's IsConnected property value. If the controller has been disconnected, this value will be false. When a controller is disconnected, values for its state will not be valid. The controller will also not be able to receive new vibration settings.

This method uses the GamePadDeadZone.IndependentAxes dead zone to smooth the values of the analog sticks. To specify a different dead zone type, or to specify no dead-zone processing, pass a GamePadDeadZone value to this method.

See Also

Tasks

How to: Detect Whether a Controller Button Is Pressed
How to: Detect Whether a Controller Is Disconnected

Concepts

Input Overview

Reference

GamePad Class
GamePad Members
Microsoft.Xna.Framework.Input Namespace

Platforms

Xbox 360, Windows XP SP2, Windows Vista