de.gurkenlabs.litiengine.input

Class GamepadManager

java.lang.Object

de.gurkenlabs.litiengine.input.GamepadManager

All Implemented Interfaces:

ILaunchable, GamepadEvents

public final class GamepadManager
extends java.lang.Object
implements ILaunchable, GamepadEvents

Nested Class Summary

Nested classes/interfaces inherited from interface de.gurkenlabs.litiengine.input.GamepadEvents

GamepadEvents.GamepadPollListener, GamepadEvents.GamepadPressedListener, GamepadEvents.GamepadReleasedListener

Method Summary

Modifier and Type	Method and Description
void	clearEventListeners() Removes all registered event listeners from the Gamepad instance.
Gamepad	current() Gets the first gamepad that is currently available.
Gamepad	get(int index) Gets the gamepad with the specified index if it is still plugged in.
java.util.List<Gamepad>	getAll()
boolean	isPressed(java.lang.String gamepadComponent) Determines whether the specified Gamepad component is currently pressed.
void	onGamepadAdded(java.util.function.Consumer<Gamepad> cons)
void	onGamepadRemoved(java.util.function.Consumer<Gamepad> cons)
void	onPoll(GamepadEvents.GamepadPollListener listener) Adds the specified gamepad poll listener to receive events when any component has been polled.
void	onPoll(java.lang.String identifier, GamepadEvents.GamepadPollListener consumer) Adds the specified gamepad poll listener to receive events when the component with the defined identifier has been polled.
void	onPressed(GamepadEvents.GamepadPressedListener listener) Adds the specified gamepad pressed listener to receive events when any component has been pressed.
void	onPressed(java.lang.String identifier, GamepadEvents.GamepadPressedListener listener) Adds the specified gamepad pressed listener to receive events when the component with the defined identifier has been pressed.
void	onReleased(GamepadEvents.GamepadReleasedListener listener) Adds the specified gamepad released listener to receive events when any component has been released.
void	onReleased(java.lang.String identifier, GamepadEvents.GamepadReleasedListener listener) Adds the specified gamepad released listener to receive events when the component with the defined identifier has been released.
void	removePollListener(GamepadEvents.GamepadPollListener listener) Unregister the specified poll listener from gamepad events.
void	removePollListener(java.lang.String identifier, GamepadEvents.GamepadPollListener listener) Unregister the specified poll listener from gamepad events.
void	removePressedListener(GamepadEvents.GamepadPressedListener listener) Unregister the specified pressed listener from gamepad events.
void	removePressedListener(java.lang.String identifier, GamepadEvents.GamepadPressedListener listener) Unregister the specified pressed listener from gamepad events.
void	removeReleasedListener(GamepadEvents.GamepadReleasedListener listener) Unregister the specified released listener from gamepad events.
void	removeReleasedListener(java.lang.String identifier, GamepadEvents.GamepadReleasedListener listener) Unregister the specified released listener from gamepad events.
void	start() Starts the operation of this instance.
void	terminate() Terminates the operation of this instance.

Methods inherited from class java.lang.Object

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

Method Detail

getAll

public java.util.List<Gamepad> getAll()

current

public Gamepad current()

Gets the first gamepad that is currently available.

Returns:

The first available Gamepad instance

get

public Gamepad get(int index)

Gets the gamepad with the specified index if it is still plugged in. After re-plugging a controller while the game is running, its index might change.

Parameters:

index - The index of the Gamepad.

Returns:

The Gamepad with the specified index.

onGamepadAdded

public void onGamepadAdded(java.util.function.Consumer<Gamepad> cons)

onGamepadRemoved

public void onGamepadRemoved(java.util.function.Consumer<Gamepad> cons)

onPoll

public void onPoll(java.lang.String identifier,
                   GamepadEvents.GamepadPollListener consumer)

Description copied from interface: GamepadEvents

Adds the specified gamepad poll listener to receive events when the component with the defined identifier has been polled.

Specified by:

onPoll in interface GamepadEvents

Parameters:

identifier - The component identifier for which to add the listener.

consumer - The listener to add.

removePollListener

public void removePollListener(java.lang.String identifier,
                               GamepadEvents.GamepadPollListener listener)

Description copied from interface: GamepadEvents

Unregister the specified poll listener from gamepad events.

Specified by:

removePollListener in interface GamepadEvents

Parameters:

identifier - The component identifier for which to remove the listener.

listener - The listener to remove.

onPressed

public void onPressed(java.lang.String identifier,
                      GamepadEvents.GamepadPressedListener listener)

Description copied from interface: GamepadEvents

Adds the specified gamepad pressed listener to receive events when the component with the defined identifier has been pressed.

Specified by:

onPressed in interface GamepadEvents

Parameters:

identifier - The component identifier for which to add the listener.

listener - The listener to add.

removePressedListener

public void removePressedListener(java.lang.String identifier,
                                  GamepadEvents.GamepadPressedListener listener)

Description copied from interface: GamepadEvents

Unregister the specified pressed listener from gamepad events.

Specified by:

removePressedListener in interface GamepadEvents

Parameters:

identifier - The component identifier for which to remove the listener.

listener - The listener to remove.

onReleased

public void onReleased(java.lang.String identifier,
                       GamepadEvents.GamepadReleasedListener listener)

Description copied from interface: GamepadEvents

Adds the specified gamepad released listener to receive events when the component with the defined identifier has been released.

Specified by:

onReleased in interface GamepadEvents

Parameters:

identifier - The component identifier for which to add the listener.

listener - The listener to add.

removeReleasedListener

public void removeReleasedListener(java.lang.String identifier,
                                   GamepadEvents.GamepadReleasedListener listener)

Description copied from interface: GamepadEvents

Unregister the specified released listener from gamepad events.

Specified by:

removeReleasedListener in interface GamepadEvents

Parameters:

identifier - The component identifier for which to remove the listener.

listener - The listener to remove.

onPoll

public void onPoll(GamepadEvents.GamepadPollListener listener)

Description copied from interface: GamepadEvents

Adds the specified gamepad poll listener to receive events when any component has been polled.

Specified by:

onPoll in interface GamepadEvents

Parameters:

listener - The listener to add.

removePollListener

public void removePollListener(GamepadEvents.GamepadPollListener listener)

Description copied from interface: GamepadEvents

Unregister the specified poll listener from gamepad events.

Specified by:

removePollListener in interface GamepadEvents

Parameters:

listener - The listener to remove.

onPressed

public void onPressed(GamepadEvents.GamepadPressedListener listener)

Description copied from interface: GamepadEvents

Adds the specified gamepad pressed listener to receive events when any component has been pressed.

Specified by:

onPressed in interface GamepadEvents

Parameters:

listener - The listener to add.

removePressedListener

public void removePressedListener(GamepadEvents.GamepadPressedListener listener)

Description copied from interface: GamepadEvents

Unregister the specified pressed listener from gamepad events.

Specified by:

removePressedListener in interface GamepadEvents

Parameters:

listener - The listener to remove.

onReleased

public void onReleased(GamepadEvents.GamepadReleasedListener listener)

Description copied from interface: GamepadEvents

Adds the specified gamepad released listener to receive events when any component has been released.

Specified by:

onReleased in interface GamepadEvents

Parameters:

listener - The listener to add.

removeReleasedListener

public void removeReleasedListener(GamepadEvents.GamepadReleasedListener listener)

Description copied from interface: GamepadEvents

Unregister the specified released listener from gamepad events.

Specified by:

removeReleasedListener in interface GamepadEvents

Parameters:

listener - The listener to remove.

clearEventListeners

public void clearEventListeners()

Description copied from interface: GamepadEvents

Removes all registered event listeners from the Gamepad instance.

Specified by:

clearEventListeners in interface GamepadEvents

start

public void start()

Description copied from interface: ILaunchable

Starts the operation of this instance.

Specified by:

start in interface ILaunchable

terminate

public void terminate()

Description copied from interface: ILaunchable

Terminates the operation of this instance.

Specified by:

terminate in interface ILaunchable

isPressed

public boolean isPressed(java.lang.String gamepadComponent)

Description copied from interface: GamepadEvents

Determines whether the specified Gamepad component is currently pressed. This is useful for button type components.

Specified by:

isPressed in interface GamepadEvents

Parameters:

gamepadComponent - The component to check against.

Returns:

True if the component is pressed, otherwise false.

See Also:

Gamepad.Buttons, Gamepad.Xbox