Types.Loader.FileTypes

key

string

No

The key of the file. Must be unique within both the Loader and the Texture Manager.

textureURL

string

Yes

The absolute or relative URL to load the texture image file from.

textureExtension

string

Yes

"'png'"

The default file extension to use for the image texture if no url is provided.

textureXhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for the texture image file.

atlasURL

object | string

Yes

The absolute or relative URL to load the atlas json file from. Or, a well formed JSON object to use instead.

atlasExtension

string

Yes

"'json'"

The default file extension to use for the atlas json if no url is provided.

atlasXhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for the atlas json file.

key

string

No

The key of the file. Must be unique within both the Loader and the Texture Manager.

textureURL

string

Yes

The absolute or relative URL to load the texture image file from.

textureExtension

string

Yes

"'png'"

The default file extension to use for the image texture if no url is provided.

textureXhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for the texture image file.

normalMap

string

Yes

The filename of an associated normal map. It uses the same path and url to load as the texture image.

atlasURL

object | string

Yes

The absolute or relative URL to load the atlas json file from. Or, a well formed JSON object to use instead.

atlasExtension

string

Yes

"'json'"

The default file extension to use for the atlas json if no url is provided.

atlasXhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for the atlas json file.

key

string

No

The key of the file. Must be unique within both the Loader and the Texture Manager.

textureURL

string

Yes

The absolute or relative URL to load the texture image file from.

textureExtension

string

Yes

"'png'"

The default file extension to use for the image texture if no url is provided.

textureXhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for the texture image file.

normalMap

string

Yes

The filename of an associated normal map. It uses the same path and url to load as the texture image.

atlasURL

string

Yes

The absolute or relative URL to load the atlas xml file from.

atlasExtension

string

Yes

"'xml'"

The default file extension to use for the atlas xml if no url is provided.

atlasXhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for the atlas xml file.

key

string

No

The key of the file. Must be unique within the Loader and Audio Cache.

url

string | Array.<string>

Phaser.Types.Loader.FileTypes.AudioFileURLConfig

Array.<Phaser.Types.Loader.FileTypes.AudioFileURLConfig>

xhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for this file.

context

AudioContext

Yes

The optional AudioContext this file will use to process itself.

type

string

No

The audio file format. See property names in {@link Phaser.Device.Audio}.

url

string

No

The absolute or relative URL of the audio file.

key

string

No

The key of the file. Must be unique within both the Loader and the Audio Cache.

jsonURL

string

No

The absolute or relative URL to load the json file from. Or a well formed JSON object to use instead.

jsonXhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for the json file.

audioURL

Object

Yes

The absolute or relative URL to load the audio file from.

audioConfig

any

Yes

The audio configuration options.

audioXhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for the audio file.

key

string

No

The key of the file. Must be unique within both the Loader and the Binary Cache.

url

string

Yes

The absolute or relative URL to load the file from.

extension

string

Yes

"'bin'"

The default file extension to use if no url is provided.

xhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for this file.

dataType

any

Yes

Optional type to cast the binary file to once loaded. For example, Uint8Array.

key

string

No

The key of the file. Must be unique within both the Loader and the Texture Manager.

textureURL

string

Yes

The absolute or relative URL to load the texture image file from.

textureExtension

string

Yes

"'png'"

The default file extension to use for the image texture if no url is provided.

textureXhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for the texture image file.

normalMap

string

Yes

The filename of an associated normal map. It uses the same path and url to load as the texture image.

fontDataURL

string

Yes

The absolute or relative URL to load the font data xml file from.

fontDataExtension

string

Yes

"'xml'"

The default file extension to use for the font data xml if no url is provided.

fontDataXhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for the font data xml file.

format

string

Yes

The texture compression base format that the browser must support in order to load this file. Can be any of: 'ETC', 'ETC1', 'ATC', 'ASTC', 'BPTC', 'RGTC', 'PVRTC', 'S3TC', 'S3TCSRGB' or the fallback format of 'IMG'.

type

string

Yes

The container format, either PVR or KTX. If not given it will try to extract it from the textureURL extension.

textureURL

string

Yes

The URL of the compressed texture file to load.

atlasURL

string

Yes

Optional URL of a texture atlas JSON data file. If not given, the texture will be loaded as a single image.

multiAtlasURL

string

Yes

Optional URL of a multi-texture atlas JSON data file as created by Texture Packer Pro.

multiPath

string

Yes

Optional path to use when loading the textures defined in the multi atlas data.

multiBaseURL

string

Yes

Optional Base URL to use when loading the textures defined in the multi atlas data.

ETC

Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | string

Yes

The string, or file entry object, for an ETC format texture.

ETC1

Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | string

Yes

The string, or file entry object, for an ETC1 format texture.

ATC

Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | string

Yes

The string, or file entry object, for an ATC format texture.

ASTC

Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | string

Yes

The string, or file entry object, for an ASTC format texture.

BPTC

Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | string

Yes

The string, or file entry object, for an BPTC format texture.

RGTC

Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | string

Yes

The string, or file entry object, for an RGTC format texture.

PVRTC

Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | string

Yes

The string, or file entry object, for an PVRTC format texture.

S3TC

Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | string

Yes

The string, or file entry object, for an S3TC format texture.

S3TCSRGB

Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | string

Yes

The string, or file entry object, for an S3TCSRGB format texture.

IMG

Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | string

Yes

The string, or file entry object, for the fallback image file.

key

string

No

The key of the file. Must be unique within the Loader.

url

string

Yes

The absolute or relative URL to load the file from.

extension

string

Yes

"'css'"

The default file extension to use if no url is provided.

xhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for this file.

key

string

No

The key of the file. Must be unique within both the Loader and the Text Cache.

url

string

Yes

The absolute or relative URL to load the file from.

shaderType

string

Yes

"'fragment'"

The type of shader. Either fragment for a fragment shader, or vertex for a vertex shader. This is ignored if you load a shader bundle.

extension

string

Yes

"'glsl'"

The default file extension to use if no url is provided.

xhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for this file.

key

string

No

The key of the file. Must be unique within both the Loader and the Text Cache.

url

string

Yes

The absolute or relative URL to load the file from.

extension

string

Yes

"'html'"

The default file extension to use if no url is provided.

xhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for this file.

key

string

No

The key of the file. Must be unique within both the Loader and the Texture Manager.

url

string

Yes

The absolute or relative URL to load the file from.

extension

string

Yes

"'html'"

The default file extension to use if no url is provided.

xhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for this file.

width

number

Yes

512

The width of the texture the HTML will be rendered to.

height

number

Yes

512

The height of the texture the HTML will be rendered to.

key

string

No

The key of the file. Must be unique within both the Loader and the Texture Manager.

url

string

Yes

The absolute or relative URL to load the file from.

extension

string

Yes

"'png'"

The default file extension to use if no url is provided.

normalMap

string

Yes

The filename of an associated normal map. It uses the same path and url to load as the image.

frameConfig

Phaser.Types.Loader.FileTypes.ImageFrameConfig

Yes

The frame configuration object. Only provided for, and used by, Sprite Sheets.

xhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for this file.

frameWidth

number

No

The width of the frame in pixels.

frameHeight

number

Yes

The height of the frame in pixels. Uses the frameWidth value if not provided.

startFrame

number

Yes

0

The first frame to start parsing from.

endFrame

number

Yes

The frame to stop parsing at. If not provided it will calculate the value based on the image and frame dimensions.

margin

number

Yes

0

The margin in the image. This is the space around the edge of the frames.

spacing

number

Yes

0

The spacing between each frame in the image.

key

string

No

The key of the file. Must be unique within both the Loader and the JSON Cache.

url

string | any

Yes

The absolute or relative URL to load the file from. Or can be a ready formed JSON object, in which case it will be directly added to the Cache.

extension

string

Yes

"'json'"

The default file extension to use if no url is provided.

dataKey

string

Yes

If specified instead of the whole JSON file being parsed and added to the Cache, only the section corresponding to this property key will be added. If the property you want to extract is nested, use periods to divide it.

xhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for this file.

key

string

No

The key of the file. Must be unique within both the Loader and the Texture Manager.

atlasURL

string

Yes

The absolute or relative URL to load the multi atlas json file from. Or, a well formed JSON object.

url

string

Yes

An alias for 'atlasURL'. If given, it overrides anything set in 'atlasURL'.

atlasExtension

string

Yes

"'json'"

The default file extension to use for the atlas json if no url is provided.

atlasXhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for the atlas json file.

path

string

Yes

Optional path to use when loading the textures defined in the atlas data.

baseURL

string

Yes

Optional Base URL to use when loading the textures defined in the atlas data.

textureXhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for the texture files.

key

string

No

The key of the file. Must be unique within the Loader.

url

Array.<string>

Yes

An array of absolute or relative URLs to load the script files from. They are processed in the order given in the array.

extension

string

Yes

"'js'"

The default file extension to use if no url is provided.

xhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for these files.

key

string

No

The key of the file. Must be unique within both the Loader and the OBJ Cache.

url

string

Yes

The absolute or relative URL to load this file from. If undefined or null it will be set to <key>.obj, i.e. if key was "alien" then the URL will be "alien.obj".

extension

string

Yes

"'obj'"

The default file extension to use if no url is provided.

flipUV

boolean

Yes

Flip the UV coordinates stored in the model data?

matURL

string

Yes

An optional absolute or relative URL to the object material file from. If undefined or null, no material file will be loaded.

matExtension

string

Yes

"'mat'"

The default material file extension to use if no url is provided.

xhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for this file.

key

string

No

The key of the file. Must be unique within both the Loader and the JSON Cache.

url

string | any

Yes

The absolute or relative URL to load the file from. Or can be a ready formed JSON object, in which case it will be directly processed.

extension

string

Yes

"'json'"

The default file extension to use if no url is provided.

dataKey

string

Yes

If specified instead of the whole JSON file being parsed, only the section corresponding to this property key will be added. If the property you want to extract is nested, use periods to divide it.

xhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for this file.

files

Array.<Phaser.Types.Loader.FileConfig>

No

The files to load. See {@link Phaser.Types.Loader.FileTypes}.

baseURL

string

Yes

A URL used to resolve paths in files. Example: 'http://labs.phaser.io/assets/'.

defaultType

string

Yes

The default {@link Phaser.Types.Loader.FileConfig} type.

path

string

Yes

A URL path used to resolve relative paths in files. Example: 'images/sprites/'.

prefix

string

Yes

An optional prefix that is automatically prepended to each file key.

key

string

No

The key of the file. Must be unique within the Loader.

url

string

Yes

The absolute or relative URL to load the file from.

extension

string

Yes

"'js'"

The default file extension to use if no url is provided.

start

boolean

Yes

false

Automatically start the plugin after loading?

mapping

string

Yes

If this plugin is to be injected into the Scene, this is the property key used.

xhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for this file.

key

string

No

The key of the file. Must be unique within both the Loader and the Text Cache.

url

string

Yes

The absolute or relative URL to load the file from.

extension

string

Yes

"'js'"

The default file extension to use if no url is provided.

xhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for this file.

key

string

No

The key of the file. Must be unique within the Loader.

url

string | function

Yes

The absolute or relative URL to load the file from. Or, a Scene Plugin.

extension

string

Yes

"'js'"

The default file extension to use if no url is provided.

systemKey

string

Yes

If this plugin is to be added to Scene.Systems, this is the property key for it.

sceneKey

string

Yes

If this plugin is to be added to the Scene, this is the property key for it.

xhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for this file.

key

string

No

The key of the file. Must be unique within the Loader.

url

string

Yes

The absolute or relative URL to load the file from.

extension

string

Yes

"'js'"

The default file extension to use if no url is provided.

type

string

Yes

"'script'"

The script type. Should be either 'script' for classic JavaScript, or 'module' if the file contains an exported module.

xhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for this file.

key

string

No

The key of the file. Must be unique within both the Loader and the Texture Manager.

url

string

Yes

The absolute or relative URL to load the file from.

extension

string

Yes

"'png'"

The default file extension to use if no url is provided.

normalMap

string

Yes

The filename of an associated normal map. It uses the same path and url to load as the image.

frameConfig

Phaser.Types.Loader.FileTypes.ImageFrameConfig

Yes

The frame configuration object.

xhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for this file.

key

string

No

The key of the file. Must be unique within both the Loader and the Texture Manager.

url

string

Yes

The absolute or relative URL to load the file from.

extension

string

Yes

"'svg'"

The default file extension to use if no url is provided.

xhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for this file.

svgConfig

Phaser.Types.Loader.FileTypes.SVGSizeConfig

Yes

The svg size configuration object.

width

number

Yes

An optional width. The SVG will be resized to this size before being rendered to a texture.

height

number

Yes

An optional height. The SVG will be resized to this size before being rendered to a texture.

scale

number

Yes

An optional scale. If given it overrides the width / height properties. The SVG is scaled by the scale factor before being rendered to a texture.

key

string

No

The key of the file. Must be unique within both the Loader and the Text Cache.

url

string

Yes

The absolute or relative URL to load the file from.

extension

string

Yes

"'txt'"

The default file extension to use if no url is provided.

xhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for this file.

key

string

No

The key of the file. Must be unique within both the Loader and the Tilemap Cache.

url

string

Yes

The absolute or relative URL to load the file from.

extension

string

Yes

"'csv'"

The default file extension to use if no url is provided.

xhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for this file.

key

string

No

The key of the file. Must be unique within both the Loader and the Tilemap Cache.

url

string

Yes

The absolute or relative URL to load the file from.

extension

string

Yes

"'json'"

The default file extension to use if no url is provided.

xhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for this file.

key

string

No

The key of the file. Must be unique within both the Loader and the Tilemap Cache.

url

object | string

Yes

The absolute or relative URL to load the file from. Or, a well formed JSON object.

extension

string

Yes

"'json'"

The default file extension to use if no url is provided.

xhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for this file.

key

string

No

The key of the file. Must be unique within both the Loader and the Texture Manager.

textureURL

string

Yes

The absolute or relative URL to load the texture image file from.

textureExtension

string

Yes

"'png'"

The default file extension to use for the image texture if no url is provided.

textureXhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for the texture image file.

normalMap

string

Yes

The filename of an associated normal map. It uses the same path and url to load as the texture image.

atlasURL

string

Yes

The absolute or relative URL to load the atlas data file from.

atlasExtension

string

Yes

"'txt'"

The default file extension to use for the atlas data if no url is provided.

atlasXhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for the atlas data file.

key

string | Phaser.Types.Loader.FileTypes.VideoFileConfig

No

The key to use for this file, or a file configuration object.

url

string | Array.<string>

Phaser.Types.Loader.FileTypes.VideoFileURLConfig

Array.<Phaser.Types.Loader.FileTypes.VideoFileURLConfig>

noAudio

boolean

Yes

Does the video have an audio track? If not you can enable auto-playing on it.

type

string

No

The video file format. See property names in {@link Phaser.Device.Video}.

url

string

No

The absolute or relative URL of the video file.

key

string

No

The key of the file. Must be unique within both the Loader and the Text Cache.

url

string

Yes

The absolute or relative URL to load the file from.

extension

string

Yes

"'xml'"

The default file extension to use if no url is provided.

xhrSettings

Phaser.Types.Loader.XHRSettingsObject

Yes

Extra XHR Settings specifically for this file.