List of Mouse Events for GameObjects (Phaser3)

This article can be read in about 4 minutes.
PR

The purpose 

Summarizing mouse events for GameObjects in Phaser 3.

How to receive event

First, enable mouse interaction for the game object. 

GameObject.setInteractive();

If you are going to use drugs, the following options are required.

GameObject.setInteractive({ draggable: true });

Event handling will be linked as follows.

GameObject.on(event name, function));

Example:

        const rect = this.add.rectangle(400, 300, 100, 100, 0xff0000);
        rect.setInteractive();
        rect.on('pointerdown', () => alert("clicked")); //add
PR

Event list

Event nameargumentdetail
dragendDrag is endpointer, dragX, dragYhttps://newdocs.phaser.io/docs/3.80.0/Phaser.Input.Events.GAMEOBJECT_DRAG_END
dragentermouse point enter to target while dragpointer, targethttps://newdocs.phaser.io/docs/3.80.0/Phaser.Input.Events.GAMEOBJECT_DRAG_ENTER
dragwhile dragpointer, dragX, dragYhttps://newdocs.phaser.io/docs/3.80.0/Phaser.Input.Events.GAMEOBJECT_DRAG
dragleave
mouse point leave from target while drag
pointer, targethttps://newdocs.phaser.io/docs/3.80.0/Phaser.Input.Events.GAMEOBJECT_DRAG_LEAVE
dragover
mouse point move on target while drag
pointer, targethttps://newdocs.phaser.io/docs/3.80.0/Phaser.Input.Events.GAMEOBJECT_DRAG_OVER
dragstartStart dragpointer, dragX, dragYhttps://newdocs.phaser.io/docs/3.80.0/Phaser.Input.Events.GAMEOBJECT_DRAG_START
dropdrop to targetpointer, targethttps://newdocs.phaser.io/docs/3.80.0/Phaser.Input.Events.GAMEOBJECT_DROP
pointerdownclick(button down)pointer, localX, localY, eventhttps://newdocs.phaser.io/docs/3.80.0/Phaser.Input.Events.GAMEOBJECT_POINTER_DOWN
pointermovemove mousepointer, localX, localY, eventhttps://newdocs.phaser.io/docs/3.80.0/Phaser.Input.Events.GAMEOBJECT_POINTER_MOVE
pointeroutmove mouse to out of GameObjectpointer, eventhttps://newdocs.phaser.io/docs/3.80.0/Phaser.Input.Events.GAMEOBJECT_POINTER_OUT
pointerovermove mousepointer, localX, localY, eventhttps://newdocs.phaser.io/docs/3.80.0/Phaser.Input.Events.GAMEOBJECT_POINTER_OVER
pointerupclick(button up)pointer, localX, localY, eventhttps://newdocs.phaser.io/docs/3.80.0/Phaser.Input.Events.GAMEOBJECT_POINTER_UP
wheelwheel operationpointer, deltaX, deltaY, deltaZ, eventhttps://newdocs.phaser.io/docs/3.80.0/Phaser.Input.Events.GAMEOBJECT_POINTER_WHEEL
PR

Reference

Events - Phaser 3 API Documentation

comment

Copied title and URL