Controller (gdx-controllers-core 2.2.1 API)

```
public interface Controller
```
Represents a connected controller. Provides methods to query the state of buttons, axes and more information on the controller. Multiple ControllerListener instances can be registered with the Controller to receive events in case the controller's state changes. Listeners will be invoked on the rendering thread.

Field Summary

Fields
Modifier and Type Field and Description

static int PLAYER_IDX_UNSET
returned by getPlayerIndex() if no player index was set or feature is not supported

Fields
Modifier and Type	Field and Description
`static int`	`PLAYER_IDX_UNSET` returned by `getPlayerIndex()` if no player index was set or feature is not supported

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addListener(ControllerListener listener)` Adds a new `ControllerListener` to this `Controller`.
`void`	`cancelVibration()` Cancel any running vibration.
`boolean`	`canVibrate()`
`float`	`getAxis(int axisCode)`
`int`	`getAxisCount()`
`boolean`	`getButton(int buttonCode)`
`ControllerMapping`	`getMapping()`
`int`	`getMaxButtonIndex()`
`int`	`getMinButtonIndex()`
`java.lang.String`	`getName()`
`int`	`getPlayerIndex()`
`ControllerPowerLevel`	`getPowerLevel()`
`java.lang.String`	`getUniqueId()`
`boolean`	`isConnected()`
`boolean`	`isVibrating()`
`void`	`removeListener(ControllerListener listener)` Removes the given `ControllerListener`
`void`	`setPlayerIndex(int index)` Sets the player index of this controller.
`void`	`startVibration(int duration, float strength)` Starts vibrating this controller, if possible.
`boolean`	`supportsPlayerIndex()`

- Field Detail
  - PLAYER_IDX_UNSET
```
static final int PLAYER_IDX_UNSET
```
    returned by getPlayerIndex() if no player index was set or feature is not supported
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getButton
```
boolean getButton(int buttonCode)
```
    Parameters:
    
    buttonCode -
    
    Returns:
    
    whether the button is pressed.
  - getAxis
```
float getAxis(int axisCode)
```
    Parameters:
    
    axisCode -
    
    Returns:
    
    the value of the axis, between -1 and 1
  - getName
```
java.lang.String getName()
```
    Returns:
    
    the device name
  - getUniqueId
```
java.lang.String getUniqueId()
```
    Returns:
    
    unique ID to recognize this controller if more than one of the same controller models are connected. Use this to map a controller to a player, but do not use it to save a button mapping.
  - getMinButtonIndex
```
int getMinButtonIndex()
```
    Returns:
    
    the minimum button index code that can be queried
  - getMaxButtonIndex
```
int getMaxButtonIndex()
```
    Returns:
    
    the maximum button index code that can be queried
  - getAxisCount
```
int getAxisCount()
```
    Returns:
    
    number of axis of this controller. Axis indices start at 0, so the maximum axis index is one under this value.
  - isConnected
```
boolean isConnected()
```
    Returns:
    
    true when this Controller is still connected, false if it already disconnected
  - canVibrate
```
boolean canVibrate()
```
    Returns:
    
    whether the connected controller or the current controller implementation can rumble. Note that this is no guarantee that the connected controller itself can vibrate.
  - isVibrating
```
boolean isVibrating()
```
    Returns:
    
    if the controller is currently rumbling
  - startVibration
```
void startVibration(int duration,
                    float strength)
```
    Starts vibrating this controller, if possible.
    
    Parameters:
    
    duration - duration, in milliseconds
    
    strength - value between 0f and 1f
  - cancelVibration
```
void cancelVibration()
```
    Cancel any running vibration. May not be supported by implementations
  - supportsPlayerIndex
```
boolean supportsPlayerIndex()
```
    Returns:
    
    whether the connected controller (or the implementation) can return and set the current player index
  - getPlayerIndex
```
int getPlayerIndex()
```
    Returns:
    
    0-based player index of this controller, or PLAYER_IDX_UNSET if none is set
  - setPlayerIndex
```
void setPlayerIndex(int index)
```
    Sets the player index of this controller. Please note that this does not always set indication lights of controllers, it is just an internal representation on some platforms
    
    Parameters:
    
    index - 0 typically 0 to 3 for player indices, and PLAYER_IDX_UNSET for unset
  - getMapping
```
ControllerMapping getMapping()
```
    Returns:
    
    button and axis mapping for this controller (or platform). The connected controller might not support all features.
  - getPowerLevel
```
ControllerPowerLevel getPowerLevel()
```
    Returns:
    
    value of enum ControllerPowerLevel indicating battery state of the connected controller, or ControllerPowerLevel.POWER_UNKNOWN if information is not present
  - addListener
```
void addListener(ControllerListener listener)
```
    Adds a new ControllerListener to this Controller. The listener will receive calls in case the state of the controller changes. The listener will be invoked on the rendering thread.
    
    Parameters:
    
    listener -
  - removeListener
```
void removeListener(ControllerListener listener)
```
    Removes the given ControllerListener
    
    Parameters:
    
    listener -

Interface Controller

Field Summary

Method Summary

Field Detail

PLAYER_IDX_UNSET

Method Detail

getButton

getAxis

getName

getUniqueId

getMinButtonIndex

getMaxButtonIndex

getAxisCount

isConnected

canVibrate

isVibrating

startVibration

cancelVibration

supportsPlayerIndex

getPlayerIndex

setPlayerIndex

getMapping

getPowerLevel

addListener

removeListener