org.jsfml.window.event

Class JoystickEvent

java.lang.Object

org.jsfml.window.event.Event

org.jsfml.window.event.JoystickEvent

Direct Known Subclasses:

JoystickButtonEvent, JoystickMoveEvent

public class JoystickEvent
extends Event

Represents generic joystick or gamepad events.

Objects of this class are created for events of type Event.Type.JOYSTICK_CONNECETED, Event.Type.JOYSTICK_DISCONNECTED, Event.Type.JOYSTICK_BUTTON_PRESSED, Event.Type.JOYSTICK_BUTTON_RELEASED or Event.Type.JOYSTICK_MOVED.

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	joystickId The index of the joystick that caused this event.

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

type

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
JoystickEvent	asJoystickEvent() Attempts to cast this event to a JoystickEvent.

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

asJoystickButtonEvent, 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

joystickId

public final int joystickId

The index of the joystick that caused this event.

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

Constructor Detail

JoystickEvent

public JoystickEvent(int type,
             int joystickId)

Constructs a new joystick event.

Parameters:

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

joystickId - the joystick ID.

Method Detail

asJoystickEvent

public JoystickEvent asJoystickEvent()

Description copied from class: Event

Attempts to cast this event to a JoystickEvent.

Overrides:

asJoystickEvent in class Event

Returns:

the event cast to a JoystickEvent if its type is one of Event.Type.JOYSTICK_CONNECETED, Event.Type.JOYSTICK_DISCONNECTED, Event.Type.JOYSTICK_BUTTON_PRESSED, Event.Type.JOYSTICK_BUTTON_RELEASED or Event.Type.JOYSTICK_MOVED, null otherwise.