CSSFile
A single CSS File suitable for loading by the Loader. When loaded, the CSS is injected into the document by creating a <style> DOM element and appending it to document.head, making the styles immediately available to the page. This is useful for loading external stylesheets that affect your game's UI, fonts, or HTML overlay elements.
These are created when you use the Phaser.Loader.LoaderPlugin#css method and are not typically created directly.
For documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#css.
Constructor
new CSSFile(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.CSSFileConfig | 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>.css, i.e. if key was "alien" then the URL will be "alien.css". |
| xhrSettings | Phaser.Types.Loader.XHRSettingsObject | Yes | Extra XHR Settings specifically for this file. |
Scope: static
Extends
Source: src/loader/filetypes/CSSFile.js#L14
Since: 3.17.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 injects the loaded CSS text into the document by creating a <style> DOM element, setting its innerHTML to the response text, and appending it to document.head. The styles are applied to the current document immediately upon insertion.
Overrides: Phaser.Loader.File#onProcess
Source: src/loader/filetypes/CSSFile.js#L69
Since: 3.17.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