AtlasJSONFile

.Loader.FileTypes. AtlasJSONFile

一个基于JSON的纹理图谱文件,适合由加载器加载. 这些是在你使用相位器时创建的.Loader.LoaderPlugin#atlas方法,通常不直接创建. 有关所有参数和配置选项的含义的文档,请参见Phaser.Loader.LoaderPlugin#atlas. https://www.codeandweb.com/texturepacker/tutorials/how-to-create-sprite-sheets-for-phaser3?source=photonstorm

Constructor

new AtlasJSONFile(loader, key, textureURLopt, atlasURLopt, textureXhrSettingsopt, atlasXhrSettingsopt)

Since:
  • 3.0.0
Parameters:
Name Type Attributes Description
loader Phaser.Loader.LoaderPlugin 对负责此文件的加载程序的引用.
key string | Phaser.Types.Loader.FileTypes.AtlasJSONFileConfig 用于此文件或文件配置对象的密钥.
textureURL string | Array.<string> <optional>
要从中加载纹理图像文件的绝对或相对网址.如果未定义或 `null` ,它将被设置为 `.png` ,即.如果 `key` 是 `alien` ,那么网址将是 `alien.png` .
atlasURL object | string <optional>
加载纹理图集json数据文件的绝对或相对URL.如果未定义或 `null` ,它将被设置为 `.json` ,即.如果 `key` 是 `alien` ,那么网址将是 `alien.json` .或者,格式良好的JSON对象.
textureXhrSettings Phaser.Types.Loader.XHRSettingsObject <optional>
地图集图像文件的XHR设置配置对象.用于替换装载机的默认XHR设置.
atlasXhrSettings Phaser.Types.Loader.XHRSettingsObject <optional>
图集json文件的XHR设置配置对象.用于替换装载机的默认XHR设置.

Extends

Members

baseURL :string

Since:
  • 3.20.0
Inherited From:
创建此多文件时对加载器基本URL的引用. 用于填充子文件.
Type:
  • string

complete :boolean

Since:
  • 3.7.0
Inherited From:
Default Value:
  • false
此多文件的完成状态.
Type:
  • boolean

config :any

Since:
  • 3.7.0
Inherited From:
加载文件所需的临时数据的存储容器.
Type:
  • any

failed :number

Since:
  • 3.7.0
Inherited From:
Default Value:
  • 0
未能加载的文件数.
Type:
  • number

files :Array.<Phaser.Loader.File>

Since:
  • 3.7.0
Inherited From:
组成此多文件的文件数组.
Type:

key :string

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

loader :Phaser.Loader.LoaderPlugin

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

path :string

Since:
  • 3.20.0
Inherited From:
创建此多文件时对加载程序路径的引用. 用于填充子文件.
Type:
  • string

pending :number

Since:
  • 3.7.0
Inherited From:
要加载的文件数.
Type:
  • number

prefix :string

Since:
  • 3.20.0
Inherited From:
创建此多文件时对加载程序前缀的引用. 用于填充子文件.
Type:
  • string

type :string

Since:
  • 3.7.0
Inherited From:
用于在加载器中排序的文件类型字符串.
Type:
  • string

Methods

addToCache()

Since:
  • 3.7.0
成功加载和处理后,将此文件添加到其目标缓存中.

addToMultiFile(files) → {Phaser.Loader.MultiFile}

Since:
  • 3.7.0
Inherited From:
向此多文件添加另一个子文件,增加挂起计数并重置完成状态.
Parameters:
Name Type Description
files Phaser.Loader.File 要添加到此多文件的文件.
Returns:
此多文件实例.
Type
Phaser.Loader.MultiFile

isReadyToProcess() → {boolean}

Since:
  • 3.7.0
Inherited From:
检查此多文件是否准备好处理其子文件.
Returns:
如果此多文件的所有子文件都已加载,则为 `true` ,否则为 `false` .
Type
boolean

onFileComplete(file)

Since:
  • 3.7.0
Inherited From:
每个文件在完成加载时调用.
Parameters:
Name Type Description
file Phaser.Loader.File 已完成处理的文件.

onFileFailed(file)

Since:
  • 3.7.0
Inherited From:
由无法加载的每个文件调用.
Parameters:
Name Type Description
file Phaser.Loader.File 无法加载的文件.