You are browsing legacy Phaser documentation that is 4+ years out of date. Please see https://newdocs.phaser.io

Namespace: FileTypes

Phaser.Types.Loader. FileTypes

Source: src/loader/filetypes/typedefs/index.js (Line 7)

Type Definitions

AsepriteFileConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/AsepriteFileConfig.js (Line 1)

AtlasJSONFileConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/AtlasJSONFileConfig.js (Line 1)

AtlasXMLFileConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/AtlasXMLFileConfig.js (Line 1)

AudioFileConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/AudioFileConfig.js (Line 1)

AudioSpriteFileConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/AudioSpriteFileConfig.js (Line 1)

BinaryFileConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/BinaryFileConfig.js (Line 1)

BitmapFontFileConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/BitmapFontFileConfig.js (Line 1)

CSSFileConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/CSSFileConfig.js (Line 1)

GLSLFileConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/GLSLFileConfig.js (Line 1)

HTMLFileConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/HTMLFileConfig.js (Line 1)

HTMLTextureFileConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/HTMLTextureFileConfig.js (Line 1)

ImageFileConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/ImageFileConfig.js (Line 1)

ImageFrameConfig

Type:
  • object
Properties:
Name Type Argument Default 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>
 0

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>
 0

The margin in the image. This is the space around the edge of the frames.
spacing number <optional>
 0

The spacing between each frame in the image.
Source: src/loader/filetypes/typedefs/ImageFrameConfig.js (Line 1)

JSONFileConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/JSONFileConfig.js (Line 1)

MultiAtlasFileConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/MultiAtlasFileConfig.js (Line 1)

MultiScriptFileConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/MultiScriptFileConfig.js (Line 1)

OBJFileConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/OBJFileConfig.js (Line 1)

PackFileConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/PackFileConfig.js (Line 1)

PackFileSection

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/PackFileSection.js (Line 1)
Example
var packFileSection = {
     "prefix": "TEST2.",
     "path": "assets/pics",
     "defaultType": "image",
     "files": [
         {
             "key": "donuts",
             "extension": "jpg"
         },
         {
             "key": "ayu"
         }
     ]
 }
// Result:
// --------------------------------------------
// assets/pics/ayu.png    -> image TEST2.ayu
// assets/pics/donuts.jpg -> image TEST2.donuts

PluginFileConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/PluginFileConfig.js (Line 1)

SceneFileConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/SceneFileConfig.js (Line 1)

ScenePluginFileConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/ScenePluginFileConfig.js (Line 1)

ScriptFileConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/ScriptFileConfig.js (Line 1)

SpriteSheetFileConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/SpriteSheetFileConfig.js (Line 1)

SVGFileConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/SVGFileConfig.js (Line 1)

SVGSizeConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/SVGSizeConfig.js (Line 1)

TextFileConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/TextFileConfig.js (Line 1)

TilemapCSVFileConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/TilemapCSVFileConfig.js (Line 1)

TilemapImpactFileConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/TilemapImpactFileConfig.js (Line 1)

TilemapJSONFileConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/TilemapJSONFileConfig.js (Line 1)

UnityAtlasFileConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/UnityAtlasFileConfig.js (Line 1)

VideoFileConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/VideoFileConfig.js (Line 1)

XMLFileConfig

Type:
  • object
Properties:
Name Type Argument 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.
Source: src/loader/filetypes/typedefs/XMLFileConfig.js (Line 1)