Phaser API Documentation

  Version: 
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
Event: FILE_PROGRESS
Phaser.Loader.Events.FILE_PROGRESS
FILE_PROGRESS

Description:

The File Load Progress Event.

This event is dispatched by the Loader Plugin during the load of a file, if the browser receives a DOM ProgressEvent and the lengthComputable event property is true. Depending on the size of the file and browser in use, this may, or may not happen.

Listen to it from a Scene using: this.load.on('fileprogress', listener).

Parameters:

name type description
file Phaser.Loader.File

A reference to the File which errored during load.

percentComplete number

A value between 0 and 1 indicating how 'complete' this file is.

Since: 3.0.0