org.jsfml.window.event

Class JoystickButtonEvent

java.lang.Object

org.jsfml.window.event.Event

org.jsfml.window.event.JoystickEvent

org.jsfml.window.event.JoystickButtonEvent

public final class JoystickButtonEvent
extends JoystickEvent

Represents joystick or gamepad button events.

Objects of this class are created for events of type Event.Type.JOYSTICK_BUTTON_PRESSED or Event.Type.JOYSTICK_BUTTON_RELEASED.

Nested Class Summary

Nested classes/interfaces inherited from class org.jsfml.window.event.Event

Event.Type

Field Summary

Fields

Modifier and Type	Field and Description
int	button The index of the button that was pressed or released.

Fields inherited from class org.jsfml.window.event.JoystickEvent

joystickId

Fields inherited from class org.jsfml.window.event.Event

type

Constructor Summary

Constructors

Constructor and Description
JoystickButtonEvent(int type, int joystickId, int button) Constructs a new joystick button event.

Method Summary

Methods

Modifier and Type	Method and Description
JoystickButtonEvent	asJoystickButtonEvent() Attempts to cast this event to a JoystickButtonEvent.

Methods inherited from class org.jsfml.window.event.JoystickEvent

asJoystickEvent

Methods inherited from class org.jsfml.window.event.Event

asJoystickMoveEvent, asKeyEvent, asMouseButtonEvent, asMouseEvent, asMouseWheelEvent, asSizeEvent, asTextEvent

Methods inherited from class java.lang.Object

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

Field Detail

button

public final int button

The index of the button that was pressed or released.

The value is guaranteed to range between 0 (inclusive) and Joystick.BUTTON_COUNT (exclusive).

Constructor Detail

JoystickButtonEvent

public JoystickButtonEvent(int type,
                   int joystickId,
                   int button)

Constructs a new joystick button event.

Parameters:

type - the type of the event. This must be a valid ordinal in the Event.Type enumeration.

joystickId - the joystick ID.

button - the index of the button that was pressed.

Method Detail

asJoystickButtonEvent

public JoystickButtonEvent asJoystickButtonEvent()

Description copied from class: Event

Attempts to cast this event to a JoystickButtonEvent.

Overrides:

asJoystickButtonEvent in class Event

Returns:

the event cast to a JoystickButtonEvent if its type is either Event.Type.JOYSTICK_BUTTON_PRESSED or Event.Type.JOYSTICK_BUTTON_RELEASED, null otherwise.