Skip to main content
Version: Phaser v3.88.2

Types.Loader.FileTypes

AsepriteFileConfig

<static> AsepriteFileConfig

nametypeoptionaldefaultdescription
keystringNoThe key of the file. Must be unique within both the Loader and the Texture Manager.
textureURLstringYesThe absolute or relative URL to load the texture image file from.
textureExtensionstringYes"'png'"The default file extension to use for the image texture if no url is provided.
textureXhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for the texture image file.
atlasURLobject | stringYesThe absolute or relative URL to load the atlas json file from. Or, a well formed JSON object to use instead.
atlasExtensionstringYes"'json'"The default file extension to use for the atlas json if no url is provided.
atlasXhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for the atlas json file.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/AsepriteFileConfig.js#L1


AtlasJSONFileConfig

<static> AtlasJSONFileConfig

nametypeoptionaldefaultdescription
keystringNoThe key of the file. Must be unique within both the Loader and the Texture Manager.
textureURLstringYesThe absolute or relative URL to load the texture image file from.
textureExtensionstringYes"'png'"The default file extension to use for the image texture if no url is provided.
textureXhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for the texture image file.
normalMapstringYesThe filename of an associated normal map. It uses the same path and url to load as the texture image.
atlasURLobject | stringYesThe absolute or relative URL to load the atlas json file from. Or, a well formed JSON object to use instead.
atlasExtensionstringYes"'json'"The default file extension to use for the atlas json if no url is provided.
atlasXhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for the atlas json file.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/AtlasJSONFileConfig.js#L1


AtlasXMLFileConfig

<static> AtlasXMLFileConfig

nametypeoptionaldefaultdescription
keystringNoThe key of the file. Must be unique within both the Loader and the Texture Manager.
textureURLstringYesThe absolute or relative URL to load the texture image file from.
textureExtensionstringYes"'png'"The default file extension to use for the image texture if no url is provided.
textureXhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for the texture image file.
normalMapstringYesThe filename of an associated normal map. It uses the same path and url to load as the texture image.
atlasURLstringYesThe absolute or relative URL to load the atlas xml file from.
atlasExtensionstringYes"'xml'"The default file extension to use for the atlas xml if no url is provided.
atlasXhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for the atlas xml file.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/AtlasXMLFileConfig.js#L1


AudioFileConfig

<static> AudioFileConfig

nametypeoptionaldescription
keystringNoThe key of the file. Must be unique within the Loader and Audio Cache.
urlstring | Array.<string>Phaser.Types.Loader.FileTypes.AudioFileURLConfigArray.<Phaser.Types.Loader.FileTypes.AudioFileURLConfig>
xhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for this file.
contextAudioContextYesThe optional AudioContext this file will use to process itself.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/AudioFileConfig.js#L1


AudioFileURLConfig

<static> AudioFileURLConfig

nametypeoptionaldescription
typestringNoThe audio file format. See property names in {@link Phaser.Device.Audio}.
urlstringNoThe absolute or relative URL of the audio file.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/AudioFileURLConfig.js#L1


AudioSpriteFileConfig

<static> AudioSpriteFileConfig

nametypeoptionaldescription
keystringNoThe key of the file. Must be unique within both the Loader and the Audio Cache.
jsonURLstringNoThe absolute or relative URL to load the json file from. Or a well formed JSON object to use instead.
jsonXhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for the json file.
audioURLObjectYesThe absolute or relative URL to load the audio file from.
audioConfiganyYesThe audio configuration options.
audioXhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for the audio file.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/AudioSpriteFileConfig.js#L1


BinaryFileConfig

<static> BinaryFileConfig

nametypeoptionaldefaultdescription
keystringNoThe key of the file. Must be unique within both the Loader and the Binary Cache.
urlstringYesThe absolute or relative URL to load the file from.
extensionstringYes"'bin'"The default file extension to use if no url is provided.
xhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for this file.
dataTypeanyYesOptional type to cast the binary file to once loaded. For example, Uint8Array.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/BinaryFileConfig.js#L1


BitmapFontFileConfig

<static> BitmapFontFileConfig

nametypeoptionaldefaultdescription
keystringNoThe key of the file. Must be unique within both the Loader and the Texture Manager.
textureURLstringYesThe absolute or relative URL to load the texture image file from.
textureExtensionstringYes"'png'"The default file extension to use for the image texture if no url is provided.
textureXhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for the texture image file.
normalMapstringYesThe filename of an associated normal map. It uses the same path and url to load as the texture image.
fontDataURLstringYesThe absolute or relative URL to load the font data xml file from.
fontDataExtensionstringYes"'xml'"The default file extension to use for the font data xml if no url is provided.
fontDataXhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for the font data xml file.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/BitmapFontFileConfig.js#L1


CSSFileConfig

<static> CSSFileConfig

nametypeoptionaldefaultdescription
keystringNoThe key of the file. Must be unique within the Loader.
urlstringYesThe absolute or relative URL to load the file from.
extensionstringYes"'css'"The default file extension to use if no url is provided.
xhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for this file.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/CSSFileConfig.js#L1


CompressedTextureFileEntry

<static> CompressedTextureFileEntry

nametypeoptionaldescription
formatstringYesThe 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'.
typestringYesThe container format, either PVR or KTX. If not given it will try to extract it from the textureURL extension.
textureURLstringYesThe URL of the compressed texture file to load.
atlasURLstringYesOptional URL of a texture atlas JSON data file. If not given, the texture will be loaded as a single image.
multiAtlasURLstringYesOptional URL of a multi-texture atlas JSON data file as created by Texture Packer Pro.
multiPathstringYesOptional path to use when loading the textures defined in the multi atlas data.
multiBaseURLstringYesOptional Base URL to use when loading the textures defined in the multi atlas data.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/CompressedTextureFileConfig.js#L1


CompressedTextureFileConfig

<static> CompressedTextureFileConfig

nametypeoptionaldescription
ETCPhaser.Types.Loader.FileTypes.CompressedTextureFileEntry | stringYesThe string, or file entry object, for an ETC format texture.
ETC1Phaser.Types.Loader.FileTypes.CompressedTextureFileEntry | stringYesThe string, or file entry object, for an ETC1 format texture.
ATCPhaser.Types.Loader.FileTypes.CompressedTextureFileEntry | stringYesThe string, or file entry object, for an ATC format texture.
ASTCPhaser.Types.Loader.FileTypes.CompressedTextureFileEntry | stringYesThe string, or file entry object, for an ASTC format texture.
BPTCPhaser.Types.Loader.FileTypes.CompressedTextureFileEntry | stringYesThe string, or file entry object, for an BPTC format texture.
RGTCPhaser.Types.Loader.FileTypes.CompressedTextureFileEntry | stringYesThe string, or file entry object, for an RGTC format texture.
PVRTCPhaser.Types.Loader.FileTypes.CompressedTextureFileEntry | stringYesThe string, or file entry object, for an PVRTC format texture.
S3TCPhaser.Types.Loader.FileTypes.CompressedTextureFileEntry | stringYesThe string, or file entry object, for an S3TC format texture.
S3TCSRGBPhaser.Types.Loader.FileTypes.CompressedTextureFileEntry | stringYesThe string, or file entry object, for an S3TCSRGB format texture.
IMGPhaser.Types.Loader.FileTypes.CompressedTextureFileEntry | stringYesThe string, or file entry object, for the fallback image file.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/CompressedTextureFileConfig.js#L13


FontFileConfig

<static> FontFileConfig

nametypeoptionaldefaultdescription
keystringNoThe key of the file. Must be unique within the Loader.
urlstringYesThe absolute or relative URL to load the file from.
extensionstringYes"'ttf'"The default file extension to use if no url is provided.
formatstringYes"'truetype'"The font type. Should be a string, like 'truetype' or 'opentype'.
descriptorsobjectYesAn optional object containing font descriptors for the Font Face.
xhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for this file.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/FontFileConfig.js#L1


GLSLFileConfig

<static> GLSLFileConfig

nametypeoptionaldefaultdescription
keystringNoThe key of the file. Must be unique within both the Loader and the Text Cache.
urlstringYesThe absolute or relative URL to load the file from.
shaderTypestringYes"'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.
extensionstringYes"'glsl'"The default file extension to use if no url is provided.
xhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for this file.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/GLSLFileConfig.js#L1


HTMLFileConfig

<static> HTMLFileConfig

nametypeoptionaldefaultdescription
keystringNoThe key of the file. Must be unique within both the Loader and the Text Cache.
urlstringYesThe absolute or relative URL to load the file from.
extensionstringYes"'html'"The default file extension to use if no url is provided.
xhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for this file.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/HTMLFileConfig.js#L1


HTMLTextureFileConfig

<static> HTMLTextureFileConfig

nametypeoptionaldefaultdescription
keystringNoThe key of the file. Must be unique within both the Loader and the Texture Manager.
urlstringYesThe absolute or relative URL to load the file from.
extensionstringYes"'html'"The default file extension to use if no url is provided.
xhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for this file.
widthnumberYes512The width of the texture the HTML will be rendered to.
heightnumberYes512The height of the texture the HTML will be rendered to.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/HTMLTextureFileConfig.js#L1


ImageFileConfig

<static> ImageFileConfig

nametypeoptionaldefaultdescription
keystringNoThe key of the file. Must be unique within both the Loader and the Texture Manager.
urlstringYesThe absolute or relative URL to load the file from.
extensionstringYes"'png'"The default file extension to use if no url is provided.
normalMapstringYesThe filename of an associated normal map. It uses the same path and url to load as the image.
frameConfigPhaser.Types.Loader.FileTypes.ImageFrameConfigYesThe frame configuration object. Only provided for, and used by, Sprite Sheets.
xhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for this file.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/ImageFileConfig.js#L1


ImageFrameConfig

<static> ImageFrameConfig

nametypeoptionaldefaultdescription
frameWidthnumberNoThe width of the frame in pixels.
frameHeightnumberYesThe height of the frame in pixels. Uses the frameWidth value if not provided.
startFramenumberYes0The first frame to start parsing from.
endFramenumberYesThe frame to stop parsing at. If not provided it will calculate the value based on the image and frame dimensions.
marginnumberYes0The margin in the image. This is the space around the edge of the frames.
spacingnumberYes0The spacing between each frame in the image.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/ImageFrameConfig.js#L1


JSONFileConfig

<static> JSONFileConfig

nametypeoptionaldefaultdescription
keystringNoThe key of the file. Must be unique within both the Loader and the JSON Cache.
urlstring | anyYesThe 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.
extensionstringYes"'json'"The default file extension to use if no url is provided.
dataKeystringYesIf 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.
xhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for this file.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/JSONFileConfig.js#L1


MultiAtlasFileConfig

<static> MultiAtlasFileConfig

nametypeoptionaldefaultdescription
keystringNoThe key of the file. Must be unique within both the Loader and the Texture Manager.
atlasURLstringYesThe absolute or relative URL to load the multi atlas json file from. Or, a well formed JSON object.
urlstringYesAn alias for 'atlasURL'. If given, it overrides anything set in 'atlasURL'.
atlasExtensionstringYes"'json'"The default file extension to use for the atlas json if no url is provided.
atlasXhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for the atlas json file.
pathstringYesOptional path to use when loading the textures defined in the atlas data.
baseURLstringYesOptional Base URL to use when loading the textures defined in the atlas data.
textureXhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for the texture files.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/MultiAtlasFileConfig.js#L1


MultiScriptFileConfig

<static> MultiScriptFileConfig

nametypeoptionaldefaultdescription
keystringNoThe key of the file. Must be unique within the Loader.
urlArray.<string>YesAn array of absolute or relative URLs to load the script files from. They are processed in the order given in the array.
extensionstringYes"'js'"The default file extension to use if no url is provided.
xhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for these files.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/MultiScriptFileConfig.js#L1


OBJFileConfig

<static> OBJFileConfig

nametypeoptionaldefaultdescription
keystringNoThe key of the file. Must be unique within both the Loader and the OBJ Cache.
urlstringYesThe 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".
extensionstringYes"'obj'"The default file extension to use if no url is provided.
flipUVbooleanYesFlip the UV coordinates stored in the model data?
matURLstringYesAn optional absolute or relative URL to the object material file from. If undefined or null, no material file will be loaded.
matExtensionstringYes"'mat'"The default material file extension to use if no url is provided.
xhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for this file.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/OBJFileConfig.js#L1


PackFileConfig

<static> PackFileConfig

nametypeoptionaldefaultdescription
keystringNoThe key of the file. Must be unique within both the Loader and the JSON Cache.
urlstring | anyYesThe 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.
extensionstringYes"'json'"The default file extension to use if no url is provided.
dataKeystringYesIf 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.
xhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for this file.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/PackFileConfig.js#L1


PackFileSection

<static> PackFileSection

nametypeoptionaldescription
filesArray.<Phaser.Types.Loader.FileConfig>NoThe files to load. See {@link Phaser.Types.Loader.FileTypes}.
baseURLstringYesA URL used to resolve paths in files. Example: 'http://labs.phaser.io/assets/'.
defaultTypestringYesThe default {@link Phaser.Types.Loader.FileConfig} type.
pathstringYesA URL path used to resolve relative paths in files. Example: 'images/sprites/'.
prefixstringYesAn optional prefix that is automatically prepended to each file key.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/PackFileSection.js#L1


PluginFileConfig

<static> PluginFileConfig

nametypeoptionaldefaultdescription
keystringNoThe key of the file. Must be unique within the Loader.
urlstringYesThe absolute or relative URL to load the file from.
extensionstringYes"'js'"The default file extension to use if no url is provided.
startbooleanYesfalseAutomatically start the plugin after loading?
mappingstringYesIf this plugin is to be injected into the Scene, this is the property key used.
xhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for this file.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/PluginFileConfig.js#L1


SVGFileConfig

<static> SVGFileConfig

nametypeoptionaldefaultdescription
keystringNoThe key of the file. Must be unique within both the Loader and the Texture Manager.
urlstringYesThe absolute or relative URL to load the file from.
extensionstringYes"'svg'"The default file extension to use if no url is provided.
xhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for this file.
svgConfigPhaser.Types.Loader.FileTypes.SVGSizeConfigYesThe svg size configuration object.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/SVGFileConfig.js#L1


SVGSizeConfig

<static> SVGSizeConfig

nametypeoptionaldescription
widthnumberYesAn optional width. The SVG will be resized to this size before being rendered to a texture.
heightnumberYesAn optional height. The SVG will be resized to this size before being rendered to a texture.
scalenumberYesAn 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

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/SVGSizeConfig.js#L1


SceneFileConfig

<static> SceneFileConfig

nametypeoptionaldefaultdescription
keystringNoThe key of the file. Must be unique within both the Loader and the Text Cache.
urlstringYesThe absolute or relative URL to load the file from.
extensionstringYes"'js'"The default file extension to use if no url is provided.
xhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for this file.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/SceneFileConfig.js#L1


ScenePluginFileConfig

<static> ScenePluginFileConfig

nametypeoptionaldefaultdescription
keystringNoThe key of the file. Must be unique within the Loader.
urlstring | functionYesThe absolute or relative URL to load the file from. Or, a Scene Plugin.
extensionstringYes"'js'"The default file extension to use if no url is provided.
systemKeystringYesIf this plugin is to be added to Scene.Systems, this is the property key for it.
sceneKeystringYesIf this plugin is to be added to the Scene, this is the property key for it.
xhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for this file.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/ScenePluginFileConfig.js#L1


ScriptFileConfig

<static> ScriptFileConfig

nametypeoptionaldefaultdescription
keystringNoThe key of the file. Must be unique within the Loader.
urlstringYesThe absolute or relative URL to load the file from.
extensionstringYes"'js'"The default file extension to use if no url is provided.
typestringYes"'script'"The script type. Should be either 'script' for classic JavaScript, or 'module' if the file contains an exported module.
xhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for this file.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/ScriptFileConfig.js#L1


SpriteSheetFileConfig

<static> SpriteSheetFileConfig

nametypeoptionaldefaultdescription
keystringNoThe key of the file. Must be unique within both the Loader and the Texture Manager.
urlstringYesThe absolute or relative URL to load the file from.
extensionstringYes"'png'"The default file extension to use if no url is provided.
normalMapstringYesThe filename of an associated normal map. It uses the same path and url to load as the image.
frameConfigPhaser.Types.Loader.FileTypes.ImageFrameConfigYesThe frame configuration object.
xhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for this file.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/SpriteSheetFileConfig.js#L1


TextFileConfig

<static> TextFileConfig

nametypeoptionaldefaultdescription
keystringNoThe key of the file. Must be unique within both the Loader and the Text Cache.
urlstringYesThe absolute or relative URL to load the file from.
extensionstringYes"'txt'"The default file extension to use if no url is provided.
xhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for this file.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/TextFileConfig.js#L1


TilemapCSVFileConfig

<static> TilemapCSVFileConfig

nametypeoptionaldefaultdescription
keystringNoThe key of the file. Must be unique within both the Loader and the Tilemap Cache.
urlstringYesThe absolute or relative URL to load the file from.
extensionstringYes"'csv'"The default file extension to use if no url is provided.
xhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for this file.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/TilemapCSVFileConfig.js#L1


TilemapImpactFileConfig

<static> TilemapImpactFileConfig

nametypeoptionaldefaultdescription
keystringNoThe key of the file. Must be unique within both the Loader and the Tilemap Cache.
urlstringYesThe absolute or relative URL to load the file from.
extensionstringYes"'json'"The default file extension to use if no url is provided.
xhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for this file.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/TilemapImpactFileConfig.js#L1


TilemapJSONFileConfig

<static> TilemapJSONFileConfig

nametypeoptionaldefaultdescription
keystringNoThe key of the file. Must be unique within both the Loader and the Tilemap Cache.
urlobject | stringYesThe absolute or relative URL to load the file from. Or, a well formed JSON object.
extensionstringYes"'json'"The default file extension to use if no url is provided.
xhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for this file.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/TilemapJSONFileConfig.js#L1


UnityAtlasFileConfig

<static> UnityAtlasFileConfig

nametypeoptionaldefaultdescription
keystringNoThe key of the file. Must be unique within both the Loader and the Texture Manager.
textureURLstringYesThe absolute or relative URL to load the texture image file from.
textureExtensionstringYes"'png'"The default file extension to use for the image texture if no url is provided.
textureXhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for the texture image file.
normalMapstringYesThe filename of an associated normal map. It uses the same path and url to load as the texture image.
atlasURLstringYesThe absolute or relative URL to load the atlas data file from.
atlasExtensionstringYes"'txt'"The default file extension to use for the atlas data if no url is provided.
atlasXhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for the atlas data file.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/UnityAtlasFileConfig.js#L1


VideoFileConfig

<static> VideoFileConfig

nametypeoptionaldescription
keystring | Phaser.Types.Loader.FileTypes.VideoFileConfigNoThe key to use for this file, or a file configuration object.
urlstring | Array.<string>Phaser.Types.Loader.FileTypes.VideoFileURLConfigArray.<Phaser.Types.Loader.FileTypes.VideoFileURLConfig>
noAudiobooleanYesDoes the video have an audio track? If not you can enable auto-playing on it.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/VideoFileConfig.js#L1


VideoFileURLConfig

<static> VideoFileURLConfig

nametypeoptionaldescription
typestringNoThe video file format. See property names in {@link Phaser.Device.Video}.
urlstringNoThe absolute or relative URL of the video file.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/VideoFileURLConfig.js#L1


XMLFileConfig

<static> XMLFileConfig

nametypeoptionaldefaultdescription
keystringNoThe key of the file. Must be unique within both the Loader and the Text Cache.
urlstringYesThe absolute or relative URL to load the file from.
extensionstringYes"'xml'"The default file extension to use if no url is provided.
xhrSettingsPhaser.Types.Loader.XHRSettingsObjectYesExtra XHR Settings specifically for this file.

Type: object

Member of: Phaser.Types.Loader.FileTypes

Source: src/loader/filetypes/typedefs/XMLFileConfig.js#L1