org.jsfml.window

Class Joystick

java.lang.Object

org.jsfml.window.Joystick

public final class Joystick
extends Object

Provides access to the the real-time states of joysticks and gamepads.

The methods in this class provide direct access to the joystick state, that means that they work independently of a window's focus. In order to react to window based events, use the Window.pollEvents() method instead.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Joystick.Axis Enumeration of supported joystick and gamepad axes.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUTTON_COUNT The maximum amount of supported joystick and gamepad buttons.
static int	JOYSTICK_COUNT The maximum amount of supported joysticks and gamepads.

Method Summary

Methods

Modifier and Type	Method and Description
static float	getAxisPosition(int joystick, Joystick.Axis axis) Retrieves the current position of the specified axis of a joystick or gamepad.
static int	getButtonCount(int joystick) Retrieves the amount of buttons of a joystick or gamepad.
static boolean	hasAxis(int joystick, Joystick.Axis axis) Checks whether a joystick or gamepad supports the specified axis.
static boolean	isButtonPressed(int joystick, int button) Checks whether the specified button is currently pressed on a joystick or gamepad.
static boolean	isConnected(int joystick) Checks if a joystick or gamepad is currently connected.
static void	update() Forces an update of the states of all joysticks and gamepads.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

JOYSTICK_COUNT

public static final int JOYSTICK_COUNT

The maximum amount of supported joysticks and gamepads.

Joystick identifiers are guaranteed to be smaller than this value.

See Also:

Constant Field Values

BUTTON_COUNT

public static final int BUTTON_COUNT

The maximum amount of supported joystick and gamepad buttons.

Joystick button indices are guaranteed to be smaller than this value.

See Also:

Constant Field Values

Method Detail

isConnected

public static boolean isConnected(int joystick)

Checks if a joystick or gamepad is currently connected.

Parameters:

joystick - the index of the joystick to check. This value must range between 0 (inclusive) and #JOYSTICK_COUNT (exclusive).

Returns:

true if the joystick or gamepad is currently connected, false otherwise.

getButtonCount

public static int getButtonCount(int joystick)

Retrieves the amount of buttons of a joystick or gamepad.

Parameters:

joystick - the index of the joystick in question. This value must range between 0 (inclusive) and #JOYSTICK_COUNT (exclusive).

Returns:

the amount of buttons of the joystick.

hasAxis

public static boolean hasAxis(int joystick,
              Joystick.Axis axis)

Checks whether a joystick or gamepad supports the specified axis.

Parameters:

joystick - the index of the joystick in question. This value must range between 0 (inclusive) and #JOYSTICK_COUNT (exclusive).

axis - the axis to look for.

Returns:

true if the joystick or gamepad supports the given axis, false otherwise.

isButtonPressed

public static boolean isButtonPressed(int joystick,
                      int button)

Checks whether the specified button is currently pressed on a joystick or gamepad.

Parameters:

joystick - the index of the joystick in question. This value must range between 0 (inclusive) and #JOYSTICK_COUNT (exclusive).

button - the index of the button to check. This value must range between 0 (inclusive) and #BUTTON_COUNT (exclusive).

Returns:

true if the button is currently pressed on the joystick or gamepad, false otherwise.

getAxisPosition

public static float getAxisPosition(int joystick,
                    Joystick.Axis axis)

Retrieves the current position of the specified axis of a joystick or gamepad.

Parameters:

joystick - the index of the joystick in question. This value must range between 0 (inclusive) and #JOYSTICK_COUNT (exclusive).

axis - the axis in question.

Returns:

a floating point number ranging between -100 and 100, denoting the current position of the axis. If the joystick or gamepad is not connected or does not support the specified axis, 0 is returned.

update

public static void update()

Forces an update of the states of all joysticks and gamepads.

This method is only required if the joystick state needs to be known before a window has been created. Once there is a window, the states will be automatically updated in regular periods.