The Game Object Wheel Input Event.
This event is dispatched by the Input Plugin belonging to a Scene if a pointer has its wheel moved while over any interactive Game Object.
Listen to this event from within a Scene using: this.input.on('gameobjectwheel', listener).
To receive this event, the Game Objects must have been set as interactive. See GameObject.setInteractive for more details.
To listen for this event from a specific Game Object, use the GAMEOBJECT_POINTER_WHEEL event instead.
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. |
| gameObject | Phaser.GameObjects.GameObject |
The Game Object the pointer was over when the wheel changed. |
| 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 |