The Game Object Pointer Wheel Event.
This event is dispatched by an interactive Game Object if a pointer has its wheel moved while over it.
Listen to this event from a Game Object using: gameObject.on('wheel', listener).
Note that the scope of the listener is automatically set to be the Game Object instance itself.
To receive this event, the Game Object must have been set as interactive. See GameObject.setInteractive for more details.
The event hierarchy is as follows:
With the top event being dispatched first and then flowing down the list. Note that higher-up event handlers can stop the propagation of this event.
| name | type | description |
|---|---|---|
| pointer | Phaser.Input.Pointer |
The Pointer responsible for triggering this event. |
| deltaX | number |
The horizontal scroll amount that occurred due to the user moving a mouse wheel or similar input device. |
| deltaY | number |
The vertical scroll amount that occurred due to the user moving a mouse wheel or similar input device. This value will typically be less than 0 if the user scrolls up and greater than zero if scrolling down. |
| deltaZ | number |
The z-axis scroll amount that occurred due to the user moving a mouse wheel or similar input device. |
| event | Phaser.Types.Input.EventData |
The Phaser input event. You can call |