UI / PointerEvent
PointerEvent Class
Classes that transmit mobile touch, mouse, and keyboard information when clicking or sliding
Table of contents
Accessors
isTouchEvent(): boolean other |
|---|
| Determine if it is a touch event |
lastScreenSpacePosition(): Vector2 other |
| Get the last screen position of this event |
mouseWheelDelta(): number other |
| Get the distance the mouse wheel slides |
pointerIndex(): number other |
| Return the unique identifier index of the event |
screenSpacePosition(): Vector2 other |
| Get the triggered screen position |
touchPadIndex(): number other |
| Get touch event index |
userIndex(): number other |
| Get the Player's index triggered by the event |
Methods
isMouseButtonDown(MouseButton: Keys): boolean other |
|---|
| Determine whether it is a mouse button event |
toInputEvent(): InputEvent other |
| Convert to InputEvent |
Default Construction
Accessors
isTouchEvent
• | ||
|---|---|---|
Determine if it is a touch event Returns
|
lastScreenSpacePosition
• | ||
|---|---|---|
Get the last screen position of this event Returns
|
mouseWheelDelta
• | ||
|---|---|---|
Get the distance the mouse wheel slides Returns
|
pointerIndex
• | ||
|---|---|---|
Return the unique identifier index of the event Returns
|
screenSpacePosition
• | ||
|---|---|---|
Get the triggered screen position Returns
|
touchPadIndex
• | ||
|---|---|---|
Get touch event index Returns
|
userIndex
• |
|---|
Get the Player's index triggered by the event Returns |
number | Return event triggers Player's index |
|---|
Methods
isMouseButtonDown
• isMouseButtonDown(MouseButton): boolean other
Determine whether it is a mouse button event
Parameters
MouseButton Keys | Usage: Key events |
|---|
Returns
boolean | Returns whether it is a mouse key event |
|---|
toInputEvent
• toInputEvent(): InputEvent other
Convert to InputEvent
Returns
InputEvent | Return InputEvent after conversion |
|---|
Editor API