MouseInputEvent

class Event.MouseInputEvent()

Constructors

Event.MouseInputEvent.constructor()
MouseInputEvent(positionX: number, positionY: number, button: Button, buttons: Buttons, modifiers: KeyModifiers, inputType: MouseInputType, viewKey: ViewKey): MouseInputEvent

Mouse Event class

Parameters

positionX: number

X window position of the mouse

positionY: number

Y window position of the mouse

button: Button

mouse button associated with this event

buttons: Buttons

mouse buttons currently pressed with this event

modifiers: KeyModifiers

bitwise collection of values from KeyModifiers enum

inputType: MouseInputType

the type of the event

viewKey: ViewKey

Returns: MouseInputEvent

Accessors

Event.MouseInputEvent.viewKey()

inherited

get viewKey(): ViewKey

Get the ViewKey this event is associated with.

Returns: ViewKey

Methods

Event.MouseInputEvent.altDown()

inherited

altDown(): boolean

gets the state of the alt key

Returns: boolean

whether the alt key was down when this event was generated
Event.MouseInputEvent.commandDown()

inherited

commandDown(): boolean

gets the state of the command key

Returns: boolean

whether the command key was down when this event was generated
Event.MouseInputEvent.controlDown()

inherited

controlDown(): boolean

gets the state of the control key

Returns: boolean

whether the control key was down when this event was generated
Event.MouseInputEvent.getButton()
getButton(): Button

gets the mouse button associated with this event

Returns: Button

the mouse button for this event
Event.MouseInputEvent.getButtons()
getButtons(): Buttons

gets the mouse buttons currently pressed with this event

Returns: Buttons

the mouse buttons currently pressed for this event
Event.MouseInputEvent.getDate()

inherited

getDate(): Date

Gets the Date this event occurred

Returns: Date

the event Date
Event.MouseInputEvent.getEventType()

inherited

getEventType(): MouseInputType

gets the event type

Returns: MouseInputType

the type of mouse event
Event.MouseInputEvent.getHandled()

inherited

getHandled(): boolean

Gets the handled state of the event

Returns: boolean

whether the event has been handled
Event.MouseInputEvent.getModifiers()

inherited

getModifiers(): KeyModifiers

gets the event modifiers

Returns: KeyModifiers

bitwise combination of KeyModifiers
Event.MouseInputEvent.getPosition()

inherited

getPosition(): Point2

gets the window position of the mouse pointer for this event

Returns: Point2

the mouse position for this event
Event.MouseInputEvent.setHandled()

inherited

setHandled(handled: boolean): void

Sets the handled state of the event. When an event has been handled it will not propagate any further

Parameters

handled: boolean

Indicates whether this event has been handled.

Returns: void

Event.MouseInputEvent.shiftDown()

inherited

shiftDown(): boolean

gets the state of the shift key

Returns: boolean

whether the shift key was down when this event was generated