Phaser.Types.Loader.FileTypes - Phaser 3 API Documentation

AsepriteFileConfig

Properties:

name	type	arguments	Default	description
key	string			The key of the file. Must be unique within both the Loader and the Texture Manager.
textureURL	string	<optional>		The absolute or relative URL to load the texture image file from.
textureExtension	string	<optional>	'png'	The default file extension to use for the image texture if no url is provided.
textureXhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for the texture image file.
atlasURL	object \| string	<optional>		The absolute or relative URL to load the atlas json file from. Or, a well formed JSON object to use instead.
atlasExtension	string	<optional>	'json'	The default file extension to use for the atlas json if no url is provided.
atlasXhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for the atlas json file.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/AsepriteFileConfig.js (Line 1)

AtlasJSONFileConfig

Properties:

name	type	arguments	Default	description
key	string			The key of the file. Must be unique within both the Loader and the Texture Manager.
textureURL	string	<optional>		The absolute or relative URL to load the texture image file from.
textureExtension	string	<optional>	'png'	The default file extension to use for the image texture if no url is provided.
textureXhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for the texture image file.
normalMap	string	<optional>		The filename of an associated normal map. It uses the same path and url to load as the texture image.
atlasURL	object \| string	<optional>		The absolute or relative URL to load the atlas json file from. Or, a well formed JSON object to use instead.
atlasExtension	string	<optional>	'json'	The default file extension to use for the atlas json if no url is provided.
atlasXhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for the atlas json file.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/AtlasJSONFileConfig.js (Line 1)

AtlasXMLFileConfig

Properties:

name	type	arguments	Default	description
key	string			The key of the file. Must be unique within both the Loader and the Texture Manager.
textureURL	string	<optional>		The absolute or relative URL to load the texture image file from.
textureExtension	string	<optional>	'png'	The default file extension to use for the image texture if no url is provided.
textureXhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for the texture image file.
normalMap	string	<optional>		The filename of an associated normal map. It uses the same path and url to load as the texture image.
atlasURL	string	<optional>		The absolute or relative URL to load the atlas xml file from.
atlasExtension	string	<optional>	'xml'	The default file extension to use for the atlas xml if no url is provided.
atlasXhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for the atlas xml file.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/AtlasXMLFileConfig.js (Line 1)

AudioFileConfig

Properties:

name	type	arguments	description
key	string		The key of the file. Must be unique within the Loader and Audio Cache.
url	string \| Array.<string>	<optional>	The absolute or relative URLs to load the audio files from.
xhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>	Extra XHR Settings specifically for this file.
context	AudioContext	<optional>	The optional AudioContext this file will use to process itself.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/AudioFileConfig.js (Line 1)

AudioSpriteFileConfig

Properties:

name	type	arguments	description
key	string		The key of the file. Must be unique within both the Loader and the Audio Cache.
jsonURL	string		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	<optional>	Extra XHR Settings specifically for the json file.
audioURL	Object	<optional>	The absolute or relative URL to load the audio file from.
audioConfig	any	<optional>	The audio configuration options.
audioXhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>	Extra XHR Settings specifically for the audio file.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/AudioSpriteFileConfig.js (Line 1)

BinaryFileConfig

Properties:

name	type	arguments	Default	description
key	string			The key of the file. Must be unique within both the Loader and the Binary Cache.
url	string	<optional>		The absolute or relative URL to load the file from.
extension	string	<optional>	'bin'	The default file extension to use if no url is provided.
xhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for this file.
dataType	any	<optional>		Optional type to cast the binary file to once loaded. For example, `Uint8Array`.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/BinaryFileConfig.js (Line 1)

BitmapFontFileConfig

Properties:

name	type	arguments	Default	description
key	string			The key of the file. Must be unique within both the Loader and the Texture Manager.
textureURL	string	<optional>		The absolute or relative URL to load the texture image file from.
textureExtension	string	<optional>	'png'	The default file extension to use for the image texture if no url is provided.
textureXhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for the texture image file.
normalMap	string	<optional>		The filename of an associated normal map. It uses the same path and url to load as the texture image.
fontDataURL	string	<optional>		The absolute or relative URL to load the font data xml file from.
fontDataExtension	string	<optional>	'xml'	The default file extension to use for the font data xml if no url is provided.
fontDataXhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for the font data xml file.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/BitmapFontFileConfig.js (Line 1)

CSSFileConfig

Properties:

name	type	arguments	Default	description
key	string			The key of the file. Must be unique within the Loader.
url	string	<optional>		The absolute or relative URL to load the file from.
extension	string	<optional>	'js'	The default file extension to use if no url is provided.
xhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for this file.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/CSSFileConfig.js (Line 1)

GLSLFileConfig

Properties:

name	type	arguments	Default	description
key	string			The key of the file. Must be unique within both the Loader and the Text Cache.
url	string	<optional>		The absolute or relative URL to load the file from.
shaderType	string	<optional>	'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	<optional>	'glsl'	The default file extension to use if no url is provided.
xhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for this file.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/GLSLFileConfig.js (Line 1)

HTMLFileConfig

Properties:

name	type	arguments	Default	description
key	string			The key of the file. Must be unique within both the Loader and the Text Cache.
url	string	<optional>		The absolute or relative URL to load the file from.
extension	string	<optional>	'html'	The default file extension to use if no url is provided.
xhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for this file.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/HTMLFileConfig.js (Line 1)

HTMLTextureFileConfig

Properties:

name	type	arguments	Default	description
key	string			The key of the file. Must be unique within both the Loader and the Texture Manager.
url	string	<optional>		The absolute or relative URL to load the file from.
extension	string	<optional>	'html'	The default file extension to use if no url is provided.
xhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for this file.
width	number	<optional>	512	The width of the texture the HTML will be rendered to.
height	number	<optional>	512	The height of the texture the HTML will be rendered to.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/HTMLTextureFileConfig.js (Line 1)

ImageFileConfig

Properties:

name	type	arguments	Default	description
key	string			The key of the file. Must be unique within both the Loader and the Texture Manager.
url	string	<optional>		The absolute or relative URL to load the file from.
extension	string	<optional>	'png'	The default file extension to use if no url is provided.
normalMap	string	<optional>		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	<optional>		The frame configuration object. Only provided for, and used by, Sprite Sheets.
xhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for this file.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/ImageFileConfig.js (Line 1)

ImageFrameConfig

Properties:

name	type	arguments	description
frameWidth	number		The width of the frame in pixels.
frameHeight	number	<optional>	The height of the frame in pixels. Uses the `frameWidth` value if not provided.
startFrame	number	<optional>	The first frame to start parsing from.
endFrame	number	<optional>	The frame to stop parsing at. If not provided it will calculate the value based on the image and frame dimensions.
margin	number	<optional>	The margin in the image. This is the space around the edge of the frames.
spacing	number	<optional>	The spacing between each frame in the image.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/ImageFrameConfig.js (Line 1)

JSONFileConfig

Properties:

name	type	arguments	Default	description
key	string			The key of the file. Must be unique within both the Loader and the JSON Cache.
url	string \| any	<optional>		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	<optional>	'json'	The default file extension to use if no url is provided.
dataKey	string	<optional>		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	<optional>		Extra XHR Settings specifically for this file.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/JSONFileConfig.js (Line 1)

MultiAtlasFileConfig

Properties:

name	type	arguments	Default	description
key	string			The key of the file. Must be unique within both the Loader and the Texture Manager.
atlasURL	string	<optional>		The absolute or relative URL to load the multi atlas json file from. Or, a well formed JSON object.
url	string	<optional>		An alias for 'atlasURL'. If given, it overrides anything set in 'atlasURL'.
atlasExtension	string	<optional>	'json'	The default file extension to use for the atlas json if no url is provided.
atlasXhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for the atlas json file.
path	string	<optional>		Optional path to use when loading the textures defined in the atlas data.
baseURL	string	<optional>		Optional Base URL to use when loading the textures defined in the atlas data.
textureXhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for the texture files.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/MultiAtlasFileConfig.js (Line 1)

MultiScriptFileConfig

Properties:

name	type	arguments	Default	description
key	string			The key of the file. Must be unique within the Loader.
url	Array.<string>	<optional>		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	<optional>	'js'	The default file extension to use if no url is provided.
xhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for these files.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/MultiScriptFileConfig.js (Line 1)

OBJFileConfig

Properties:

name	type	arguments	Default	description
key	string			The key of the file. Must be unique within both the Loader and the OBJ Cache.
url	string	<optional>		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	<optional>	'obj'	The default file extension to use if no url is provided.
flipUV	boolean	<optional>		Flip the UV coordinates stored in the model data?
matURL	string	<optional>		An optional absolute or relative URL to the object material file from. If undefined or `null`, no material file will be loaded.
matExtension	string	<optional>	'mat'	The default material file extension to use if no url is provided.
xhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for this file.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/OBJFileConfig.js (Line 1)

PackFileConfig

Properties:

name	type	arguments	Default	description
key	string			The key of the file. Must be unique within both the Loader and the JSON Cache.
url	string \| any	<optional>		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	<optional>	'json'	The default file extension to use if no url is provided.
dataKey	string	<optional>		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	<optional>		Extra XHR Settings specifically for this file.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/PackFileConfig.js (Line 1)

PackFileSection

Properties:

name	type	arguments	description
files	Array.<Phaser.Types.Loader.FileConfig>		The files to load. See Phaser.Types.Loader.FileTypes.
baseURL	string	<optional>	A URL used to resolve paths in `files`. Example: 'http://labs.phaser.io/assets/'.
defaultType	string	<optional>	The default Phaser.Types.Loader.FileConfig `type`.
path	string	<optional>	A URL path used to resolve relative paths in `files`. Example: 'images/sprites/'.
prefix	string	<optional>	An optional prefix that is automatically prepended to each file key.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/PackFileSection.js (Line 1)

PluginFileConfig

Properties:

name	type	arguments	Default	description
key	string			The key of the file. Must be unique within the Loader.
url	string	<optional>		The absolute or relative URL to load the file from.
extension	string	<optional>	'js'	The default file extension to use if no url is provided.
start	boolean	<optional>	false	Automatically start the plugin after loading?
mapping	string	<optional>		If this plugin is to be injected into the Scene, this is the property key used.
xhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for this file.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/PluginFileConfig.js (Line 1)

SceneFileConfig

Properties:

name	type	arguments	Default	description
key	string			The key of the file. Must be unique within both the Loader and the Text Cache.
url	string	<optional>		The absolute or relative URL to load the file from.
extension	string	<optional>	'js'	The default file extension to use if no url is provided.
xhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for this file.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/SceneFileConfig.js (Line 1)

ScenePluginFileConfig

Properties:

name	type	arguments	Default	description
key	string			The key of the file. Must be unique within the Loader.
url	string \| function	<optional>		The absolute or relative URL to load the file from. Or, a Scene Plugin.
extension	string	<optional>	'js'	The default file extension to use if no url is provided.
systemKey	string	<optional>		If this plugin is to be added to Scene.Systems, this is the property key for it.
sceneKey	string	<optional>		If this plugin is to be added to the Scene, this is the property key for it.
xhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for this file.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/ScenePluginFileConfig.js (Line 1)

ScriptFileConfig

Properties:

name	type	arguments	Default	description
key	string			The key of the file. Must be unique within the Loader.
url	string	<optional>		The absolute or relative URL to load the file from.
extension	string	<optional>	'js'	The default file extension to use if no url is provided.
xhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for this file.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/ScriptFileConfig.js (Line 1)

SpriteSheetFileConfig

Properties:

name	type	arguments	Default	description
key	string			The key of the file. Must be unique within both the Loader and the Texture Manager.
url	string	<optional>		The absolute or relative URL to load the file from.
extension	string	<optional>	'png'	The default file extension to use if no url is provided.
normalMap	string	<optional>		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	<optional>		The frame configuration object.
xhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for this file.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/SpriteSheetFileConfig.js (Line 1)

SVGFileConfig

Properties:

name	type	arguments	Default	description
key	string			The key of the file. Must be unique within both the Loader and the Texture Manager.
url	string	<optional>		The absolute or relative URL to load the file from.
extension	string	<optional>	'svg'	The default file extension to use if no url is provided.
xhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for this file.
svgConfig	Phaser.Types.Loader.FileTypes.SVGSizeConfig	<optional>		The svg size configuration object.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/SVGFileConfig.js (Line 1)

SVGSizeConfig

Properties:

name	type	arguments	description
width	number	<optional>	An optional width. The SVG will be resized to this size before being rendered to a texture.
height	number	<optional>	An optional height. The SVG will be resized to this size before being rendered to a texture.
scale	number	<optional>	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.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/SVGSizeConfig.js (Line 1)

TextFileConfig

Properties:

name	type	arguments	Default	description
key	string			The key of the file. Must be unique within both the Loader and the Text Cache.
url	string	<optional>		The absolute or relative URL to load the file from.
extension	string	<optional>	'txt'	The default file extension to use if no url is provided.
xhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for this file.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/TextFileConfig.js (Line 1)

TilemapCSVFileConfig

Properties:

name	type	arguments	Default	description
key	string			The key of the file. Must be unique within both the Loader and the Tilemap Cache.
url	string	<optional>		The absolute or relative URL to load the file from.
extension	string	<optional>	'csv'	The default file extension to use if no url is provided.
xhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for this file.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/TilemapCSVFileConfig.js (Line 1)

TilemapImpactFileConfig

Properties:

name	type	arguments	Default	description
key	string			The key of the file. Must be unique within both the Loader and the Tilemap Cache.
url	string	<optional>		The absolute or relative URL to load the file from.
extension	string	<optional>	'json'	The default file extension to use if no url is provided.
xhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for this file.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/TilemapImpactFileConfig.js (Line 1)

TilemapJSONFileConfig

Properties:

name	type	arguments	Default	description
key	string			The key of the file. Must be unique within both the Loader and the Tilemap Cache.
url	object \| string	<optional>		The absolute or relative URL to load the file from. Or, a well formed JSON object.
extension	string	<optional>	'json'	The default file extension to use if no url is provided.
xhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for this file.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/TilemapJSONFileConfig.js (Line 1)

UnityAtlasFileConfig

Properties:

name	type	arguments	Default	description
key	string			The key of the file. Must be unique within both the Loader and the Texture Manager.
textureURL	string	<optional>		The absolute or relative URL to load the texture image file from.
textureExtension	string	<optional>	'png'	The default file extension to use for the image texture if no url is provided.
textureXhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for the texture image file.
normalMap	string	<optional>		The filename of an associated normal map. It uses the same path and url to load as the texture image.
atlasURL	string	<optional>		The absolute or relative URL to load the atlas data file from.
atlasExtension	string	<optional>	'txt'	The default file extension to use for the atlas data if no url is provided.
atlasXhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for the atlas data file.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/UnityAtlasFileConfig.js (Line 1)

VideoFileConfig

Properties:

name	type	arguments	description
key	string \| Phaser.Types.Loader.FileTypes.VideoFileConfig		The key to use for this file, or a file configuration object.
url	string \| Array.<string>	<optional>	The absolute or relative URLs to load the video files from.
loadEvent	string	<optional>	The load event to listen for when not loading as a blob. Either 'loadeddata', 'canplay' or 'canplaythrough'.
asBlob	boolean	<optional>	Load the video as a data blob, or via the Video element?
noAudio	boolean	<optional>	Does the video have an audio track? If not you can enable auto-playing on it.
xhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>	Extra XHR Settings specifically for this file.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/VideoFileConfig.js (Line 1)

XMLFileConfig

Properties:

name	type	arguments	Default	description
key	string			The key of the file. Must be unique within both the Loader and the Text Cache.
url	string	<optional>		The absolute or relative URL to load the file from.
extension	string	<optional>	'xml'	The default file extension to use if no url is provided.
xhrSettings	Phaser.Types.Loader.XHRSettingsObject	<optional>		Extra XHR Settings specifically for this file.

Type:

object

Since: 3.0.0

Source: src/loader/filetypes/typedefs/XMLFileConfig.js (Line 1)

Filter

Type Definitions

Properties:

Type:

Properties:

Type:

Properties:

Type:

Properties:

Type:

Properties:

Type:

Properties:

Type:

Properties:

Type:

Properties:

Type:

Properties:

Type:

Properties:

Type:

Properties:

Type:

Properties:

Type:

Properties:

Type:

Properties:

Type:

Properties:

Type:

Properties:

Type:

Properties:

Type:

Properties:

Type:

Properties:

Type:

Properties:

Type:

Properties:

Type:

Properties:

Type:

Properties:

Type:

Properties:

Type:

Properties:

Type:

Properties:

Type:

Properties:

Type:

Properties:

Type:

Properties:

Type:

Properties:

Type:

Properties:

Type:

Properties:

Type:

Properties:

Type: