Phaser API Documentation

  Version: 
Filter
This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord
Namespace: Events
Phaser.GameObjects.Events

Events

ADDED_TO_SCENE
Focus
Focus

Description:

The Game Object Added to Scene Event.

This event is dispatched when a Game Object is added to a Scene.

Listen for it on a Game Object instance using GameObject.on('addedtoscene', listener).

Parameters:

name type description
gameObject Phaser.GameObjects.GameObject

The Game Object that was added to the Scene.

scene Phaser.Scene

The Scene to which the Game Object was added.

Since: 3.50.0
Focus
Focus
DESTROY
Focus
Focus

Description:

The Game Object Destroy Event.

This event is dispatched when a Game Object instance is being destroyed.

Listen for it on a Game Object instance using GameObject.on('destroy', listener).

Parameters:

name type description
gameObject Phaser.GameObjects.GameObject

The Game Object which is being destroyed.

fromScene boolean

True if this Game Object is being destroyed by the Scene, false if not.

Since: 3.0.0
Focus
Focus
REMOVED_FROM_SCENE
Focus
Focus

Description:

The Game Object Removed from Scene Event.

This event is dispatched when a Game Object is removed from a Scene.

Listen for it on a Game Object instance using GameObject.on('removedfromscene', listener).

Parameters:

name type description
gameObject Phaser.GameObjects.GameObject

The Game Object that was removed from the Scene.

scene Phaser.Scene

The Scene from which the Game Object was removed.

Focus
Focus
VIDEO_COMPLETE
Focus
Focus

Description:

The Video Game Object Complete Event.

This event is dispatched when a Video finishes playback by reaching the end of its duration. It is also dispatched if a video marker sequence is being played and reaches the end.

Note that not all videos can fire this event. Live streams, for example, have no fixed duration, so never technically 'complete'.

If a video is stopped from playback, via the Video.stop method, it will emit the VIDEO_STOP event instead of this one.

Listen for it from a Video Game Object instance using Video.on('complete', listener).

Parameters:

name type description
video Phaser.GameObjects.Video

The Video Game Object which completed playback.

Since: 3.20.0
Focus
Focus
VIDEO_CREATED
Focus
Focus

Description:

The Video Game Object Created Event.

This event is dispatched when the texture for a Video has been created. This happens when enough of the video source has been loaded that the browser is able to render a frame from it.

Listen for it from a Video Game Object instance using Video.on('created', listener).

Parameters:

name type description
video Phaser.GameObjects.Video

The Video Game Object which raised the event.

width number

The width of the video.

height number

The height of the video.

Since: 3.20.0
Focus
Focus
VIDEO_ERROR
Focus
Focus

Description:

The Video Game Object Error Event.

This event is dispatched when a Video tries to play a source that does not exist, or is the wrong file type.

Listen for it from a Video Game Object instance using Video.on('error', listener).

Parameters:

name type description
video Phaser.GameObjects.Video

The Video Game Object which threw the error.

event Event

The native DOM event the browser raised during playback.

Since: 3.20.0
Focus
Focus
VIDEO_LOOP
Focus
Focus

Description:

The Video Game Object Loop Event.

This event is dispatched when a Video that is currently playing has looped. This only happens if the loop parameter was specified, or the setLoop method was called, and if the video has a fixed duration. Video streams, for example, cannot loop, as they have no duration.

Looping is based on the result of the Video timeupdate event. This event is not frame-accurate, due to the way browsers work, so please do not rely on this loop event to be time or frame precise.

Listen for it from a Video Game Object instance using Video.on('loop', listener).

Parameters:

name type description
video Phaser.GameObjects.Video

The Video Game Object which has looped.

Since: 3.20.0
Focus
Focus
VIDEO_PLAY
Focus
Focus

Description:

The Video Game Object Play Event.

This event is dispatched when a Video begins playback. For videos that do not require interaction unlocking, this is usually as soon as the Video.play method is called. However, for videos that require unlocking, it is fired once playback begins after they've been unlocked.

Listen for it from a Video Game Object instance using Video.on('play', listener).

Parameters:

name type description
video Phaser.GameObjects.Video

The Video Game Object which started playback.

Since: 3.20.0
Focus
Focus
VIDEO_SEEKED
Focus
Focus

Description:

The Video Game Object Seeked Event.

This event is dispatched when a Video completes seeking to a new point in its timeline.

Listen for it from a Video Game Object instance using Video.on('seeked', listener).

Parameters:

name type description
video Phaser.GameObjects.Video

The Video Game Object which completed seeking.

Since: 3.20.0
Focus
Focus
VIDEO_SEEKING
Focus
Focus

Description:

The Video Game Object Seeking Event.

This event is dispatched when a Video begins seeking to a new point in its timeline. When the seek is complete, it will dispatch the VIDEO_SEEKED event to conclude.

Listen for it from a Video Game Object instance using Video.on('seeking', listener).

Parameters:

name type description
video Phaser.GameObjects.Video

The Video Game Object which started seeking.

Since: 3.20.0
Focus
Focus
VIDEO_STOP
Focus
Focus

Description:

The Video Game Object Stopped Event.

This event is dispatched when a Video is stopped from playback via a call to the Video.stop method, either directly via game code, or indirectly as the result of changing a video source or destroying it.

Listen for it from a Video Game Object instance using Video.on('stop', listener).

Parameters:

name type description
video Phaser.GameObjects.Video

The Video Game Object which stopped playback.

Since: 3.20.0
Focus
Focus
VIDEO_TIMEOUT
Focus
Focus

Description:

The Video Game Object Timeout Event.

This event is dispatched when a Video has exhausted its allocated time while trying to connect to a video source to start playback.

Listen for it from a Video Game Object instance using Video.on('timeout', listener).

Parameters:

name type description
video Phaser.GameObjects.Video

The Video Game Object which timed out.

Since: 3.20.0
Focus
Focus
VIDEO_UNLOCKED
Focus
Focus

Description:

The Video Game Object Unlocked Event.

This event is dispatched when a Video that was prevented from playback due to the browsers Media Engagement Interaction policy, is unlocked by a user gesture.

Listen for it from a Video Game Object instance using Video.on('unlocked', listener).

Parameters:

name type description
video Phaser.GameObjects.Video

The Video Game Object which raised the event.

Since: 3.20.0
Focus
Focus