onMouseMotion([callback], [remove])
Class: Panel. Method inherited from UIComponent.
Description:
Gets, registers or unregisters a mouse motion event handler function.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
|
|
function |
The event handler function that receives a MouseMotionEvent object. Pass |
|
|
|
boolean |
false |
Set to |
Returns:
An array of handler functions if no arguments are passed, otherwise this component for method chaining.
Type: this | Array.<function()>
Examples:
// Example event object:
const e = {
target: object, // The component that triggered the event.
type: string, // `move` or `drag`.
button: number, // Button number. One of MouseButton enum values. Present when applicable.
modifiers: number, // Keyboard modifiers (bitmask or flags).
x: number, // Mouse x position relative to component
y: number, // Mouse y position relative to component
screenX: number, // Mouse x position relative to default screen
screenY: number, // Mouse y position relative to default screen
};
