phaser/src/loader/events/PROGRESS_EVENT.js
2023-01-02 17:36:27 +00:00

20 lines
633 B
JavaScript

/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2013-2023 Photon Storm Ltd.
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
/**
* The Loader Plugin Progress Event.
*
* This event is dispatched when the Loader updates its load progress, typically as a result of a file having completed loading.
*
* Listen to it from a Scene using: `this.load.on('progress', listener)`.
*
* @event Phaser.Loader.Events#PROGRESS
* @type {string}
* @since 3.0.0
*
* @param {number} progress - The current progress of the load. A value between 0 and 1.
*/
module.exports = 'progress';