File

.Loader. File

加载程序可以支持的所有文件类型使用的基本文件类. 您不应该直接创建文件的实例,而应该用自己的类扩展它,设置自定义类型和处理方法.

Constructor

new File(loader, fileConfig)

Since:
  • 3.0.0
Parameters:
Name Type Description
loader Phaser.Loader.LoaderPlugin 将要加载此文件的加载程序.
fileConfig Phaser.Types.Loader.FileConfig 由文件类型创建的文件配置对象.

Members

bytesLoaded :number

Since:
  • 3.0.0
Default Value:
  • -1
文件加载时更新. 仅在通过XHR装货时设置.
Type:
  • number

bytesTotal :number

Since:
  • 3.0.0
Default Value:
  • 0
该文件的总大小. 由onProgress设置,仅当通过XHR装载时.
Type:
  • number

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

Since:
  • 3.7.0
一个对缓存或纹理管理器的引用,如果加载的话,它将存储这个文件.
Type:

config :*

Since:
  • 3.0.0
文件类型可以用来存储过渡数据的配置对象.
Type:
  • *

crossOrigin :string|undefined

Since:
  • 3.0.0
对于基于CORs的加载. 如果这是未定义的,那么文件将检查基线加载器.交叉原点并使用它(如果设置)
Type:
  • string | undefined

data :*

Since:
  • 3.0.0
文件加载后存储在此处的已处理文件数据.
Type:
  • *

key :string

Since:
  • 3.0.0
唯一的缓存键(在其文件类型中是唯一的)
Type:
  • string

(nullable) linkFile :Phaser.Loader.File

Since:
  • 3.7.0
此文件是否有关联的链接文件?例如图像和法线贴图. 地图集和位图字体使用多文件,因为这些文件需要一起加载,但不需要 实际上是被数据绑定的,比如链接文件.
Type:

loader :Phaser.Loader.LoaderPlugin

Since:
  • 3.0.0
对将要加载此文件的加载程序的引用.
Type:

(nullable) multiFile :Phaser.Loader.MultiFile

Since:
  • 3.7.0
如果这是一个多部分文件,即.一个地图集和它的json在一起,那么这是一个参考 到父多文件.由加载程序或特定文件类型在内部设置和使用.
Type:

percentComplete :number

Since:
  • 3.0.0
Default Value:
  • -1
一个介于0和1之间的百分比值,表示该文件的加载量. 仅在通过XHR装货时设置.
Type:
  • number

src :string

Since:
  • 3.0.0
此文件将加载的最终网址,包括基本网址和路径. 当加载程序在此文件上调用 `load` 时自动设置.
Type:
  • string

state :number

Since:
  • 3.0.0
文件的当前状态.FILE_CONST值之一.
Type:
  • number

type :string

Since:
  • 3.0.0
用于在加载器中排序的文件类型字符串(图像,json等).
Type:
  • string

url :object|string

Since:
  • 3.0.0
文件的网址,不包括基本网址. 如果是字符串,则自动在前面加上Loader.path. 也可以是JavaScript Object,比如解析JSON数据的结果.
Type:
  • object | string

(nullable) xhrLoader :XMLHttpRequest

Since:
  • 3.0.0
正在加载该文件的XMLHttpRequest实例(由XHR加载器创建).
Type:
  • XMLHttpRequest

xhrSettings :Phaser.Types.Loader.XHRSettingsObject

Since:
  • 3.0.0
此文件的合并XHRSettings.
Type:

Methods

(static) createObjectURL(image, blob, defaultType)

Since:
  • 3.7.0
使用URL API创建对象URL并将其设置为图像 `src` 属性的静态方法. 如果不支持URL API(通常在旧的浏览器上),它会退回到使用FileReader创建Base64编码的URL.
Parameters:
Name Type Description
image HTMLImageElement `src` 属性应该设置为对象URL的图像对象.
blob Blob 要为其创建对象网址的Blob对象.
defaultType string 如果blob类型不可用,则使用默认mime类型.

(static) revokeObjectURL(image)

Since:
  • 3.7.0
用于释放先前创建的现有对象网址的静态方法 通过调用File#createObjectURL方法.
Parameters:
Name Type Description
image HTMLImageElement 应该撤销其 `src` 属性的图像对象.

addToCache()

Since:
  • 3.7.0
成功加载和处理后,将此文件添加到其目标缓存中. 该方法经常被特定的文件类型覆盖.

destroy()

Since:
  • 3.7.0
销毁此文件及其包含的任何引用.

hasCacheConflict() → {boolean}

Since:
  • 3.7.0
检查目标缓存中是否存在与该文件使用的密钥匹配的密钥. 这是由LoaderPlugin自动调用的,以决定文件是否可以安全保存 加载或会冲突.
Returns:
`true` 如果添加此文件会导致冲突,则为 `afus` .
Type
boolean

load()

Since:
  • 3.0.0
由加载程序调用,开始实际的文件下载. 在加载过程中,基于XHR事件调用方法onLoad,onError和onProgress. 您通常不应该直接调用这个方法,它应该由加载器调用.

onError(xhr, event)

Since:
  • 3.0.0
如果加载时文件出错,则调用该函数,并发送一个DOM ProgressEvent.
Parameters:
Name Type Description
xhr XMLHttpRequest 导致此onload事件的XMLHttpRequest.
event ProgressEvent 由该错误导致的DOM ProgressEvent.

onLoad(xhr, event)

Since:
  • 3.0.0
当文件完成加载时调用,并发送一个DOM ProgressEvent.
Parameters:
Name Type Description
xhr XMLHttpRequest 导致此onload事件的XMLHttpRequest.
event ProgressEvent 由此加载产生的DOM ProgressEvent.

onProcess()

Since:
  • 3.0.0
通常由文件类型覆盖,由加载器调用. 这个方法控制这个文件用它加载的数据做什么额外的工作,例如一个JSON文件将在这个阶段解析自己.

onProcessComplete()

Since:
  • 3.7.0
当文件完成处理时调用. 检查其多文件的状态(如果已设置).

onProcessError()

Since:
  • 3.7.0
当文件完成处理但产生错误时调用. 检查其多文件的状态(如果已设置).

onProgress(event)

Since:
  • 3.0.0
在文件加载过程中调用.被发送一个DOM ProgressEvent.
Parameters:
Name Type Description
event ProgressEvent DOM ProgressEvent.
Fires:

pendingDestroy()

Since:
  • 3.7.0
一旦文件被添加到其缓存中,并且现在准备从加载程序中删除,就会调用该函数. 它将从LoaderPlugin中发出一个 `filecomplete` 事件.
Fires:

resetXHR()

Since:
  • 3.0.0
重置该文件正在使用的XHRLoader实例.
Since:
  • 3.7.0
将此文件与另一个文件链接,因此它们在加载和处理时相互依赖.
Parameters:
Name Type Description
fileB Phaser.Loader.File 要链接到此的文件.