Class: File

Phaser.Loader. File

The base File class used by all File Types that the Loader can support. You shouldn't create an instance of a File directly, but should extend it with your own class, setting a custom type and processing methods.


new File(loader, fileConfig)

Parameters:
Name Type Description
loader Phaser.Loader.LoaderPlugin

The Loader that is going to load this File.

fileConfig FileConfig

The file configuration object, as created by the file type.

Since: 3.0.0
Source: src/loader/File.js (Line 29)

Members


bytesLoaded :number

Updated as the file loads. Only set if loading via XHR.

Type:
  • number
Since: 3.0.0
Default Value:
  • -1
Source: src/loader/File.js (Line 168)

bytesTotal :number

The total size of this file. Set by onProgress and only if loading via XHR.

Type:
  • number
Since: 3.0.0
Default Value:
  • 0
Source: src/loader/File.js (Line 157)

cache :Phaser.Cache.BaseCache|Phaser.Textures.TextureManager

A reference to the Cache, or Texture Manager, that is going to store this file if it loads.

Type:
Since: 3.7.0
Source: src/loader/File.js (Line 57)

config :*

A config object that can be used by file types to store transitional data.

Type:
  • *
Since: 3.0.0
Source: src/loader/File.js (Line 209)

crossOrigin :string|undefined

For CORs based loading. If this is undefined then the File will check BaseLoader.crossOrigin and use that (if set)

Type:
  • string | undefined
Since: 3.0.0
Source: src/loader/File.js (Line 190)

data :*

The processed file data, stored here after the file has loaded.

Type:
  • *
Since: 3.0.0
Source: src/loader/File.js (Line 200)

key :string

Unique cache key (unique within its file type)

Type:
  • string
Since: 3.0.0
Source: src/loader/File.js (Line 75)

<nullable> linkFile :Phaser.Loader.File

Does this file have an associated linked file? Such as an image and a normal map. Atlases and Bitmap Fonts use the multiFile, because those files need loading together but aren't actually bound by data, where-as a linkFile is.

Type:
Since: 3.7.0
Source: src/loader/File.js (Line 228)

loader :Phaser.Loader.LoaderPlugin

A reference to the Loader that is going to load this file.

Type:
Since: 3.0.0
Source: src/loader/File.js (Line 48)

<nullable> multiFile :Phaser.Loader.MultiFile

If this is a multipart file, i.e. an atlas and its json together, then this is a reference to the parent MultiFile. Set and used internally by the Loader or specific file types.

Type:
Since: 3.7.0
Source: src/loader/File.js (Line 218)

percentComplete :number

A percentage value between 0 and 1 indicating how much of this file has loaded. Only set if loading via XHR.

Type:
  • number
Since: 3.0.0
Default Value:
  • -1
Source: src/loader/File.js (Line 179)

src :string

The final URL this file will load from, including baseURL and path. Set automatically when the Loader calls 'load' on this file.

Type:
  • string
Since: 3.0.0
Source: src/loader/File.js (Line 115)

state :integer

The current state of the file. One of the FILE_CONST values.

Type:
  • integer
Since: 3.0.0
Source: src/loader/File.js (Line 148)

type :string

The file type string (image, json, etc) for sorting within the Loader.

Type:
  • string
Since: 3.0.0
Source: src/loader/File.js (Line 66)

url :string

The URL of the file, not including baseURL. Automatically has Loader.path prepended to it.

Type:
  • string
Since: 3.0.0
Source: src/loader/File.js (Line 96)

<nullable> xhrLoader :XMLHttpRequest

The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.

Type:
  • XMLHttpRequest
Since: 3.0.0
Source: src/loader/File.js (Line 139)

xhrSettings :XHRSettingsObject

The merged XHRSettings for this file.

Type:
Since: 3.0.0
Source: src/loader/File.js (Line 125)

Methods


<static> createObjectURL(image, blob, defaultType)

Static method for creating object URL using URL API and setting it as image 'src' attribute. If URL API is not supported (usually on old browsers) it falls back to creating Base64 encoded url using FileReader.

Parameters:
Name Type Description
image HTMLImageElement

Image object which 'src' attribute should be set to object URL.

blob Blob

A Blob object to create an object URL for.

defaultType string

Default mime type used if blob type is not available.

Source: src/loader/File.js (Line 496)

<static> revokeObjectURL(image)

Static method for releasing an existing object URL which was previously created by calling File#createObjectURL method.

Parameters:
Name Type Description
image HTMLImageElement

Image object which 'src' attribute should be revoked.

Source: src/loader/File.js (Line 528)

addToCache()

Adds this file to its target cache upon successful loading and processing. This method is often overridden by specific file types.

Since: 3.7.0
Source: src/loader/File.js (Line 439)

destroy()

Destroy this File and any references it holds.

Since: 3.7.0
Source: src/loader/File.js (Line 478)

hasCacheConflict()

Checks if a key matching the one used by this file exists in the target Cache or not. This is called automatically by the LoaderPlugin to decide if the file can be safely loaded or will conflict.

Since: 3.7.0
Source: src/loader/File.js (Line 424)
Returns:

true if adding this file will cause a conflict, otherwise false.

Type
boolean

load()

Called by the Loader, starts the actual file downloading. During the load the methods onLoad, onError and onProgress are called, based on the XHR events. You shouldn't normally call this method directly, it's meant to be invoked by the Loader.

Since: 3.0.0
Source: src/loader/File.js (Line 271)

onError(xhr, event)

Called if the file errors while loading, is sent a DOM ProgressEvent.

Parameters:
Name Type Description
xhr XMLHttpRequest

The XMLHttpRequest that caused this onload event.

event ProgressEvent

The DOM ProgressEvent that resulted from this error.

Since: 3.0.0
Source: src/loader/File.js (Line 334)

onLoad(xhr, event)

Called when the file finishes loading, is sent a DOM ProgressEvent.

Parameters:
Name Type Description
xhr XMLHttpRequest

The XMLHttpRequest that caused this onload event.

event ProgressEvent

The DOM ProgressEvent that resulted from this load.

Since: 3.0.0
Source: src/loader/File.js (Line 308)

onProcess()

Usually overridden by the FileTypes and is called by Loader.nextFile. This method controls what extra work this File does with its loaded data, for example a JSON file will parse itself during this stage.

Since: 3.0.0
Source: src/loader/File.js (Line 372)

onProcessComplete()

Called when the File has completed processing. Checks on the state of its multifile, if set.

Since: 3.7.0
Source: src/loader/File.js (Line 386)

onProcessError()

Called when the File has completed processing but it generated an error. Checks on the state of its multifile, if set.

Since: 3.7.0
Source: src/loader/File.js (Line 405)

onProgress(event)

Called during the file load progress. Is sent a DOM ProgressEvent.

Parameters:
Name Type Description
event ProgressEvent

The DOM ProgressEvent.

Since: 3.0.0
Source: src/loader/File.js (Line 350)
Fires:

pendingDestroy()

Called once the file has been added to its cache and is now ready for deletion from the Loader. It will emit a filecomplete event from the LoaderPlugin.

Since: 3.7.0
Source: src/loader/File.js (Line 456)
Fires:

resetXHR()

Resets the XHRLoader instance this file is using.

Since: 3.0.0
Source: src/loader/File.js (Line 255)

Links this File with another, so they depend upon each other for loading and processing.

Parameters:
Name Type Description
fileB Phaser.Loader.File

The file to link to this one.

Since: 3.7.0
Source: src/loader/File.js (Line 240)