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

21 lines
730 B
JavaScript

/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2013-2023 Photon Storm Ltd.
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
/**
* The Texture Load Error Event.
*
* This event is dispatched by the Texture Manager when a texture it requested to load failed.
* This only happens when base64 encoded textures fail. All other texture types are loaded via the Loader Plugin.
*
* Listen to this event from within a Scene using: `this.textures.on('onerror', listener)`.
*
* @event Phaser.Textures.Events#ERROR
* @type {string}
* @since 3.0.0
*
* @param {string} key - The key of the Texture that failed to load into the Texture Manager.
*/
module.exports = 'onerror';