HTMLFile

A single HTML File suitable for loading by the Loader.

These are created when you use the Phaser.Loader.LoaderPlugin#html method and are not typically created directly.

For documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#html.

Constructor

new HTMLFile(loader, key, [url], [xhrSettings])

Parameters

name	type	optional	description
loader	Phaser.Loader.LoaderPlugin	No	A reference to the Loader that is responsible for this file.
key	string | Phaser.Types.Loader.FileTypes.HTMLFileConfig	No	The key to use for this file, or a file configuration object.
url	string	Yes	The absolute or relative URL to load this file from. If undefined or null it will be set to <key>.html, i.e. if key was "alien" then the URL will be "alien.html".
xhrSettings	Phaser.Types.Loader.XHRSettingsObject	Yes	Extra XHR Settings specifically for this file.

---

Scope: static

Extends

Phaser.Loader.File

Source: src/loader/filetypes/HTMLFile.js#L14
Since: 3.12.0

Inherited Methods

From Phaser.Loader.File:

• addToCache
• destroy
• hasCacheConflict
• load
• onBase64Load
• onError
• onLoad
• onProcessComplete
• onProcessError
• onProgress
• pendingDestroy
• resetXHR
• setLink

---

Public Methods

onProcess

<instance> onProcess()

Description:

Called automatically by Loader.nextFile.

This method controls what extra work this File does with its loaded data.

Overrides: Phaser.Loader.File#onProcess

Source: src/loader/filetypes/HTMLFile.js#L66
Since: 3.7.0

---

Inherited Members

From Phaser.Loader.File:

• base64
• bytesLoaded
• bytesTotal
• cache
• config
• crossOrigin
• data
• key
• linkFile
• loader
• multiFile
• percentComplete
• retryAttempts
• src
• state
• type
• url
• xhrLoader
• xhrSettings

---