Drag[en]gine Script Module DragonScript  1.23
Dragengine.Gui.Events.GamepadEvent Class Reference

Immutable gamepad event. More...

Inheritance diagram for Dragengine.Gui.Events.GamepadEvent:
Dragengine.Gui.Events.ModifiableEvent Dragengine.Gui.Events.Event

Public Member Functions

float getAxisValue ()
 Axis value. More...
 
int getCode ()
 Axis or button index. More...
 
int getDevice ()
 Input device index. More...
 
InputDeviceAxisType getInputAxisType ()
 Input axis type or null if not valid. More...
 
InputDeviceButtonType getInputButtonType ()
 Input button type or null if not valid. More...
 
InputDevice getInputDevice ()
 Input device or null. More...
 
InputDeviceAxis getInputDeviceAxis ()
 Input device axis or null. More...
 
InputDeviceButton getInputDeviceButton ()
 Input device button or null. More...
 
InputEventSource getSystem ()
 Source system. More...
 
GamepadEvent new (Object source, int id, InputEventSource system, int device, int code, int modifiers)
 Create event. More...
 
GamepadEvent new (Object source, int id, InputEventSource system, int device, int code, int modifiers, float axisValue)
 Create event. More...
 
GamepadEvent new (Object source, int id, int device, int code, int modifiers)
 Create event. More...
 
GamepadEvent new (Object source, int id, int device, int code, int modifiers, float axisValue)
 Create event. More...
 
- Public Member Functions inherited from Dragengine.Gui.Events.ModifiableEvent
int getModifiers ()
 Modifier keys. More...
 
ModifiableEvent new (Object source, int id, int modifiers)
 Create event. More...
 
- Public Member Functions inherited from Dragengine.Gui.Events.Event
int getIdentifier ()
 Event identifier. More...
 
Object getSource ()
 Event source. More...
 
Event new (Object source, int id)
 Create event. More...
 

Static Public Member Functions

static bool isGamepadEvent (int identifier)
 Event identifier is an input device event identifier. More...
 

Public Attributes

float pAxisValue
 
int pCode
 
int pDevice
 
InputEventSource pSystem
 

Static Public Attributes

static final int idGamepadAxisMoved = 90
 Input device axis moved event identifier. More...
 
static final int idGamepadButtonPressed = 91
 Input device button pressed event identifier. More...
 
static final int idGamepadButtonReleased = 92
 Input device button released event identifier. More...
 
- Static Public Attributes inherited from Dragengine.Gui.Events.ModifiableEvent
static final int alt = 4
 Alt key pressed. More...
 
static final int control = 2
 Control key pressed. More...
 
static final int shift = 1
 Shift key pressed. More...
 

Detailed Description

Immutable gamepad event.

Used for input events outside mouse and keyboard handling.

Member Function Documentation

◆ getAxisValue()

float Dragengine.Gui.Events.GamepadEvent.getAxisValue ( )

Axis value.

◆ getCode()

int Dragengine.Gui.Events.GamepadEvent.getCode ( )

Axis or button index.

◆ getDevice()

int Dragengine.Gui.Events.GamepadEvent.getDevice ( )

Input device index.

◆ getInputAxisType()

InputDeviceAxisType Dragengine.Gui.Events.GamepadEvent.getInputAxisType ( )

Input axis type or null if not valid.

Version
1.20

Call this only for events of type idGamepadAxisMoved.

◆ getInputButtonType()

InputDeviceButtonType Dragengine.Gui.Events.GamepadEvent.getInputButtonType ( )

Input button type or null if not valid.

Version
1.20

Call this only for events of type idGamepadButtonPressed or idGamepadButtonReleased.

◆ getInputDevice()

InputDevice Dragengine.Gui.Events.GamepadEvent.getInputDevice ( )

Input device or null.

Version
1.20

◆ getInputDeviceAxis()

InputDeviceAxis Dragengine.Gui.Events.GamepadEvent.getInputDeviceAxis ( )

Input device axis or null.

Version
1.20

Call this only for events of type idGamepadAxisPressed or idGamepadAxisReleased.

◆ getInputDeviceButton()

InputDeviceButton Dragengine.Gui.Events.GamepadEvent.getInputDeviceButton ( )

Input device button or null.

Version
1.20

Call this only for events of type idGamepadButtonPressed or idGamepadButtonReleased.

◆ getSystem()

InputEventSource Dragengine.Gui.Events.GamepadEvent.getSystem ( )

Source system.

Version
1.6

◆ isGamepadEvent()

static bool Dragengine.Gui.Events.GamepadEvent.isGamepadEvent ( int  identifier)
static

Event identifier is an input device event identifier.

◆ new() [1/4]

GamepadEvent Dragengine.Gui.Events.GamepadEvent.new ( Object  source,
int  id,
InputEventSource  system,
int  device,
int  code,
int  modifiers 
)

Create event.

Version
1.6

For use with idGamepadButtonPressed and idGamepadButtonReleased.

◆ new() [2/4]

GamepadEvent Dragengine.Gui.Events.GamepadEvent.new ( Object  source,
int  id,
InputEventSource  system,
int  device,
int  code,
int  modifiers,
float  axisValue 
)

Create event.

Version
1.6

For use with idGamepadAxisMoved.

◆ new() [3/4]

GamepadEvent Dragengine.Gui.Events.GamepadEvent.new ( Object  source,
int  id,
int  device,
int  code,
int  modifiers 
)

◆ new() [4/4]

GamepadEvent Dragengine.Gui.Events.GamepadEvent.new ( Object  source,
int  id,
int  device,
int  code,
int  modifiers,
float  axisValue 
)

Member Data Documentation

◆ idGamepadAxisMoved

final int Dragengine.Gui.Events.GamepadEvent.idGamepadAxisMoved = 90
static

Input device axis moved event identifier.

◆ idGamepadButtonPressed

final int Dragengine.Gui.Events.GamepadEvent.idGamepadButtonPressed = 91
static

Input device button pressed event identifier.

◆ idGamepadButtonReleased

final int Dragengine.Gui.Events.GamepadEvent.idGamepadButtonReleased = 92
static

Input device button released event identifier.

◆ pAxisValue

float Dragengine.Gui.Events.GamepadEvent.pAxisValue

◆ pCode

int Dragengine.Gui.Events.GamepadEvent.pCode

◆ pDevice

int Dragengine.Gui.Events.GamepadEvent.pDevice

◆ pSystem

InputEventSource Dragengine.Gui.Events.GamepadEvent.pSystem

The documentation for this class was generated from the following file: