构造函数

new Loader(game)

装载机装载的所有外部内容的处理如图像,声音,纹理地图集和数据文件。

参数

名称 类型 参数 默认值 描述
game Phaser.Game 一个参考目前正在运行的游戏。

公共属性

[static] PHYSICS_LIME_CORONA_JSON : number

一个计数器:如果超过零,文件将被自动添加为一个同步点。

Source code: loader/Loader.js (Line 299)

[static] PHYSICS_PHASER_JSON : number

如果你想在任何资产的路径上附加一个网址,你可以在这里设置这个。

Source code: loader/Loader.js (Line 305)

[static] TEXTURE_ATLAS_JSON_ARRAY : number

到phaser.cache本地参考。

Source code: loader/Loader.js (Line 281)

[static] TEXTURE_ATLAS_JSON_HASH : number

的crossorigin值用于加载图像。很经常这需要设置为“匿名”。

Source code: loader/Loader.js (Line 287)

[static] TEXTURE_ATLAS_JSON_PYXEL : number

如果真(默认),然后将启用并行下载。

Source code: loader/Loader.js (Line 311)

[static] TEXTURE_ATLAS_XML_STARLING : number

本地参考游戏。

Source code: loader/Loader.js (Line 293)

_withSyncPointDepth

如果队列中的所有资产都已完成加载。

Source code: loader/Loader.js (Line 204)

baseURL : string

如果装载程序在加载队列的过程中是正确的。

Source code: loader/Loader.js (Line 83)

<internal> cache : Phaser.Cache

并发/并行资源的数量,以尝试和获取在一次。

Source code: loader/Loader.js (Line 36)

crossOrigin : boolean | string

此事件被发送时,文件已加载或不加载。

Source code: loader/Loader.js (Line 74)

enableParallel : boolean

此事件被发送当一个文件(或包)的错误,作为一个结果的负载请求。

Source code: loader/Loader.js (Line 188)

<internal> game : Phaser.Game

此事件在文件启动加载前立即发出。

Source code: loader/Loader.js (Line 29)

hasLoaded : boolean

此事件被调度时,在加载队列中的最后文件已被加载或失败。

Source code: loader/Loader.js (Line 57)

isLoading : boolean

此事件将在加载过程启动时发出:在第一个文件已被请求之前,

Source code: loader/Loader.js (Line 50)

<internal> maxParallelDownloads : integer

当资产包加载或未能加载时,该事件被调度。

Source code: loader/Loader.js (Line 198)

onFileComplete : Phaser.Signal

如果设置为“代码”的值,如果设置,则放置在任何<时间>相对< /。例如:

Source code: loader/Loader.js (Line 152)

onFileError : Phaser.Signal

你可以选择链接进度雪碧与< a href =“相位。装载机。HTML # setpreloadsprite”> setpreloadsprite 。

Source code: loader/Loader.js (Line 163)

onFileStart : Phaser.Signal

圆形的负载进度百分比值(从0到100)。看< a href =“相位。装载机。HTML # progressfloat”>相位。装载机# progressfloat 。

Source code: loader/Loader.js (Line 139)

onLoadComplete : Phaser.Signal

非圆形的负载进展值(从0到100)。

Source code: loader/Loader.js (Line 118)

onLoadStart : Phaser.Signal

如果真的所有的电话,loader.reset将被忽略。如果你需要在交换到预载状态创建负载队列。

Source code: loader/Loader.js (Line 111)

onPackComplete : Phaser.Signal

如果是真的,如果浏览器支持xdomainrequest,它将优先使用XHR。

Source code: loader/Loader.js (Line 129)

公共方法

addSyncPoint(type, key) → {Phaser.Loader}

在负载队列中添加一个特定的文件/资产的同步点。

参数

名称 类型 参数 默认值 描述
type string <将资源类型转为一个同步点(图像、音频、XML等)。
key string 你要把文件的键变成一个同步点。

Source code: loader/Loader.js (Line 1648)


<internal> addToFileList(type, key, url, properties, overwrite, extension) → {Phaser.Loader}

内部函数,增加了一个新的输入到文件列表。不要直接打电话。

参数

名称 类型 参数 默认值 描述
type string <资源的类型添加到列表(图像、音频、XML等)。
key string 该资源的唯一缓存标识号。
url string <optional>
<该资产将从中加载。
properties object <optional>
(none) <为加载该文件所需的任何附加属性。这些都是直接添加到添加的文件对象,并覆盖任何默认值。
overwrite boolean <optional>
false 如果真的话,那么这将覆盖相同类型/密钥的文件资产。否则,它只会增加一个新的资产。如果覆盖是真的,那么该资产已经被加载(或已被加载),那么它就被追加。
extension string <optional>
如果没有一组链接,加载程序有时会自动生成基于密钥的地址,使用此作为扩展。

Source code: loader/Loader.js (Line 492)


atlas(key, textureURL, atlasURL, atlasData, format) → {Phaser.Loader}

将纹理阿特拉斯文件添加到当前的负载队列中。

参数

名称 类型 参数 默认值 描述
key string “阿特拉斯文件的唯一资产密钥”
textureURL string <optional>
阿特拉斯图像文件的网址。如果未定义或<代码>空< /代码> URL将被设置为<密码> & lt;关键>;。PNG <代码>,即<代码>键< /代码>是";外星人";然后URL将";PNG和外星人。quot;。

atlasURL string <optional>
<纹理阿特拉斯数据文件的网址。如果未定义或<代码> < /代码>没有空atlasdata给出,URL将被设置为<密码> & lt;关键>;。JSON < /代码>,即<代码>键< /代码>是";外星人";然后将与URL quot;外星人JSON ";。

atlasData object <optional>

JSON或XML数据对象。你不需要这些数据是从一个网址加载。

format number <optional>
数据格式的格式。可以phaser.loader.texture_atlas_json_array(默认),phaser.loader.texture_atlas_json_hash或相位。装载机。texture_atlas_xml_starling。

Source code: loader/Loader.js (Line 1517)


atlasJSONArray(key, textureURL, atlasURL, atlasData) → {Phaser.Loader}

将纹理阿特拉斯文件添加到当前的负载队列中。

参数

名称 类型 参数 默认值 描述
key string “阿特拉斯文件的唯一资产密钥”
textureURL string <optional>
阿特拉斯图像文件的网址。如果未定义或<代码>空< /代码> URL将被设置为<密码> & lt;关键>;。PNG <代码>,即<代码>键< /代码>是";外星人";然后URL将";PNG和外星人。quot;。

atlasURL string <optional>
<纹理阿特拉斯数据文件的网址。如果未定义或<代码> < /代码>没有空atlasdata给出,URL将被设置为<密码> & lt;关键>;。JSON < /代码>,即<代码>键< /代码>是";外星人";然后将与URL quot;外星人JSON ";。

atlasData object <optional>

JSON数据对象。你不需要这些数据是从一个网址加载。

Source code: loader/Loader.js (Line 1371)


atlasJSONHash(key, textureURL, atlasURL, atlasData) → {Phaser.Loader}

将纹理阿特拉斯文件添加到当前的负载队列中。

参数

名称 类型 参数 默认值 描述
key string “阿特拉斯文件的唯一资产密钥”
textureURL string <optional>
阿特拉斯图像文件的网址。如果未定义或<代码>空< /代码> URL将被设置为<密码> & lt;关键>;。PNG <代码>,即<代码>键< /代码>是";外星人";然后URL将";PNG和外星人。quot;。

atlasURL string <optional>
<纹理阿特拉斯数据文件的网址。如果未定义或<代码> < /代码>没有空atlasdata给出,URL将被设置为<密码> & lt;关键>;。JSON < /代码>,即<代码>键< /代码>是";外星人";然后将与URL quot;外星人JSON ";。

atlasData object <optional>

JSON数据对象。你不需要这些数据是从一个网址加载。

Source code: loader/Loader.js (Line 1417)


atlasXML(key, textureURL, atlasURL, atlasData) → {Phaser.Loader}

将纹理阿特拉斯文件添加到当前的负载队列中。

参数

名称 类型 参数 默认值 描述
key string “阿特拉斯文件的唯一资产密钥”
textureURL string <optional>
阿特拉斯图像文件的网址。如果未定义或<代码>空< /代码> URL将被设置为<密码> & lt;关键>;。PNG <代码>,即<代码>键< /代码>是";外星人";然后URL将";PNG和外星人。quot;。

atlasURL string <optional>
<纹理阿特拉斯数据文件的网址。如果未定义或<代码> < /代码>没有空atlasdata给出,URL将被设置为<密码> & lt;关键>;。JSON < /代码>,即<代码>键< /代码>是";外星人";然后将与URL quot;外星人。XML ";。

atlasData object <optional>
一个数据对象。你不需要这些数据是从一个网址加载。

Source code: loader/Loader.js (Line 1463)


audio(key, urls, autoDecode) → {Phaser.Loader}

将音频文件添加到当前的负载队列中。

参数

名称 类型 参数 默认值 描述
key string 音频文件的独特的资产密钥。
urls string | Array.<string> | Array.<object>

无论是一个字符串或<代码> { URI的URI或对数组类型::..,.. }

autoDecode boolean <optional>
true 当使用网络音频时,音频文件可以在加载时间或运行时进行解码。

Source code: loader/Loader.js (Line 968)


audiosprite(key, urls, jsonURL, jsonData, autoDecode) → {Phaser.Loader}

将音频精灵文件添加到当前的负载队列中。

参数

名称 类型 参数 默认值 描述
key string 音频文件的独特的资产密钥。
urls Array | string

一个数组包含的音频文件,URL即:[ audiosprite。MP3,OGG ',' ' audiosprite。audiosprite .m4a”]或一个字符串只包含一个网址。

jsonURL string <optional>
null

的audiosprite配置JSON对象的URL。如果你想通过数据直接将此参数设置为空。

jsonData string | object <optional>
null

JSON对象或字符串包含audiosprite配置数据。这是如果jsonurl不空忽视。

autoDecode boolean <optional>
true 当使用网络音频时,音频文件可以在加载时间或运行时进行解码。

Source code: loader/Loader.js (Line 1011)


audiosprite(key, urls, jsonURL, jsonData, autoDecode) → {Phaser.Loader}

一个别名loader.audiosprite遗产。请参阅文件的方法。

参数

名称 类型 参数 默认值 描述
key string 音频文件的独特的资产密钥。
urls Array | string

一个数组包含的音频文件,URL即:[ audiosprite。MP3,OGG ',' ' audiosprite。audiosprite .m4a”]或一个字符串只包含一个网址。

jsonURL string <optional>
null

的audiosprite配置JSON对象的URL。如果你想通过数据直接将此参数设置为空。

jsonData string | object <optional>
null

JSON对象或字符串包含audiosprite配置数据。这是如果jsonurl不空忽视。

autoDecode boolean <optional>
true 当使用网络音频时,音频文件可以在加载时间或运行时进行解码。

Source code: loader/Loader.js (Line 1070)


binary(key, url, callback, callbackContext) → {Phaser.Loader}

将二进制文件添加到当前的负载队列中。

参数

名称 类型 参数 默认值 描述
key string <二进制文件的唯一的资产密钥。
url string <optional>
<二进制文件的网址。如果未定义或<代码>空< /代码> URL将被设置为<密码> & lt;关键>;。本<代码>,即<代码>键< /代码>是";外星人";然后URL将";外星人。桶quot;。

callback function <optional>
(none) 在加载后,将通过该文件的可选择的回拨,这样你就可以进行额外的处理。
callbackContext object <optional>
在该背景下,该回调将被应用。如果没有指定,它将使用回调本身作为上下文。

Source code: loader/Loader.js (Line 888)


bitmapFont(key, textureURL, atlasURL, atlasData, xSpacing, ySpacing) → {Phaser.Loader}

将位图字体文件添加到当前的负载队列中。

参数

名称 类型 参数 默认值 描述
key string 该位图字体的独特的资产密钥。
textureURL string 位图字体纹理文件的网址。如果未定义或<代码>空< /代码> URL将被设置为<密码> & lt;关键>;。PNG <代码>,即<代码>键< /代码>是";megafont ";然后将网址";megafont PNG和。quot;。

atlasURL string

URL的位图字体文件(XML或JSON)阿特拉斯。如果未定义或<代码> < >和<空/代码代码> atlasdata < /代码>是null,URL将被设置为<密码> & lt;关键>;XML < /代码>,即<代码>键< /代码>是";megafont ";然后将网址";megafont。XML ";。

atlasData object

可选的位图字体阿特拉斯以字符串形式(字符化XML、JSON)。

xSpacing number <optional>
0 如果你想在字符之间添加一个额外的水平间隔,那么在这里设置像素值。
ySpacing number <optional>
0 如果你想在这条线之间添加额外的垂直间隔,那么就把像素值设置在这里。

Source code: loader/Loader.js (Line 1280)


checkKeyExists(type, key) → {boolean}

检查是否有特定的密钥的文件/资产排队等待加载。

参数

名称 类型 参数 默认值 描述
type string 你要检查的资产类型。”
key string 你要检查的资产的关键。

Source code: loader/Loader.js (Line 367)


getAsset(type, key) → {any}

找到一个特定的密钥文件/资产。

参数

名称 类型 参数 默认值 描述
type string 你要检查的资产类型。”
key string 你要检查的资产的关键。

Source code: loader/Loader.js (Line 418)


getAssetIndex(type, key) → {number}

获得特定密钥的文件/资产的队列索引。

参数

名称 类型 参数 默认值 描述
type string 你要检查的资产类型。”
key string 你要检查的资产的关键。

Source code: loader/Loader.js (Line 383)


image(key, url, overwrite) → {Phaser.Loader}

将图像添加到当前的负载队列中。

参数

名称 类型 参数 默认值 描述
key string 该映像文件的唯一资产密钥。
url string <optional>
一个图像文件的网址。如果未定义或<代码>空< /代码> URL将被设置为<密码> & lt;关键>;。PNG <代码>,即<代码>键< /代码>是";外星人";然后URL将";PNG和外星人。quot;。

overwrite boolean <optional>
false 如果在队列中已存在匹配密钥的卸载文件,该条目将改写它。

Source code: loader/Loader.js (Line 670)


images(keys, urls) → {Phaser.Loader}

将图像添加到当前的负载队列中。

参数

名称 类型 参数 默认值 描述
keys array <映像文件的唯一资产密钥的数组。
urls array <optional>
<可选择数组的网址。如果未定义或<代码>空< /代码> URL将被设置为<密码> & lt;关键>;。PNG <代码>,即<代码>键< /代码>是";外星人";然后URL将";PNG和外星人。quot;。如果提供的网址数组长度必须匹配的密钥长度。

Source code: loader/Loader.js (Line 699)


json(key, url, overwrite) → {Phaser.Loader}

增加了一个JSON文件的当前负载队列。

参数

名称 类型 参数 默认值 描述
key string

独特资产关键的JSON文件。

url string <optional>

URL的JSON文件。如果未定义或<代码>空< /代码> URL将被设置为<密码> & lt;关键>;。JSON < /代码>,即<代码>键< /代码>是";外星人";然后URL将";JSON和外星人。quot;。

overwrite boolean <optional>
false 如果在队列中已存在匹配密钥的卸载文件,该条目将改写它。

Source code: loader/Loader.js (Line 771)


pack(key, url, data, callbackContext) → {Phaser.Loader}

添加一个JSON资源包('packfile ')的装载机。

参数

名称 类型 参数 默认值 描述
key string 该资源包的唯一资产密钥。
url string <optional>

URL的资产包的JSON文件。如果你想通过一个JSON对象设置为空,而不是通过对象作为数据参数。

data object <optional>

资产包的JSON数据。用这个在JSON数据传递对象而不是加载它的URL。TODO

callbackContext object <optional>
(loader)

有装载机操作,如二进制和脚本需要的回调上下文。在这里传递上下文。

Source code: loader/Loader.js (Line 590)


physics(key, url, data, format) → {Phaser.Loader}

将物理数据文件添加到当前的负载队列中。

参数

名称 类型 参数 默认值 描述
key string

独特资产关键物理的JSON数据。

url string <optional>
物理数据文件的网址。如果未定义或<代码> > < /编码空无数据给出的URL将被设置为<密码> & lt;关键>;。JSON < /代码>,即<代码>键< /代码>是";外星人";然后将“URL;外星人JSON ";。

data object | string <optional>

可选的JSON数据对象。如果给定的URL是忽略这个JSON对象用于物理数据代替。

format string <optional>
Phaser.Physics.LIME_CORONA_JSON <物理数据的格式>。

Source code: loader/Loader.js (Line 1219)


<internal> removeAll()

删除所有文件加载请求-这是<电磁>不足< /时间>停止当前加载。使用<代码>重置< /代码>。

Source code: loader/Loader.js (Line 1695)


<internal> removeFile(type, key)

从加载队列中删除文件/资产。

参数

名称 类型 参数 默认值 描述
type string <资源的类型添加到列表(图像、音频、XML等)。
key string 你要删除的文件的键。

Source code: loader/Loader.js (Line 1671)


<internal> replaceInFileList(type, key, url, properties)

替换在文件列表中替换现有项的内部函数。不要直接打电话。

参数

名称 类型 参数 默认值 描述
type string <资源的类型添加到列表(图像、音频、XML等)。
key string 该资源的唯一缓存标识号。
url string <该资产将从中加载。
properties object <加载该文件所需的任何附加属性。

Source code: loader/Loader.js (Line 574)


<internal> reset(hard, clearEvents)

重置装载机和清除任何排队的资产。如果<代码>装载机。resetlocked 是真的该操作将中止。

参数

名称 类型 参数 默认值 描述
hard boolean <optional>
false 如果真的话,那么预加载精灵和其他工件也可能被清除。
clearEvents boolean <optional>
false

如果真那么所有装载机信号会全部叫他们。

Source code: loader/Loader.js (Line 442)


<internal> resize()

所谓的自动调整大小scalemanager当游戏在ScaleMode。

Source code: loader/Loader.js (Line 350)


script(key, url, callback, callbackContext) → {Phaser.Loader}

增加了一个JavaScript文件的当前负载队列。

参数

名称 类型 参数 默认值 描述
key string 该脚本文件的独特的资产密钥。
url string <optional>

URL的JavaScript文件。如果未定义或<代码>空< /代码> URL将被设置为<密码> & lt;关键>;。JS < /代码>,即<代码>键< /代码>是";外星人";然后URL将";JS和外星人。quot;。

callback function <optional>
(none) 当脚本标签加载后,会调用一个可选的回调函数,这样你就可以进行额外的处理。
callbackContext object <optional>
(loader) 在该背景下,该回调将被应用。如果没有指定,将使用移相器装载机为背景。

Source code: loader/Loader.js (Line 853)


setPreloadSprite(sprite, direction)

把一个精灵设置为“预载”,把它传递给这个方法。

参数

名称 类型 参数 默认值 描述
sprite Phaser.Sprite | Phaser.Image 在负载时将被裁剪的精灵或图像。
direction number <optional>
0 “零均值的值意味着精灵会被横向裁剪,1的值意味着它将被垂直裁剪。”

Source code: loader/Loader.js (Line 315)


shader(key, url, overwrite) → {Phaser.Loader}

将一个片段着色文件添加到当前的负载队列中。

参数

名称 类型 参数 默认值 描述
key string 文件碎片文件的独特的资产密钥。
url string <optional>
“碎片文件”的网址。如果未定义或<代码>空< /代码> URL将被设置为<密码> & lt;关键>;。破片< /代码>,即<代码>键< /代码>是";模糊";然后将网址";破片和模糊。quot;。

overwrite boolean <optional>
false 如果在队列中已存在匹配密钥的卸载文件,该条目将改写它。

Source code: loader/Loader.js (Line 799)


spritesheet(key, url, frameWidth, frameHeight, frameMax, margin, spacing) → {Phaser.Loader}

将精灵片添加到当前的负载队列中。

参数

名称 类型 参数 默认值 描述
key string <文件文件的唯一资产密钥。
url string <精灵文件的网址。如果未定义或<代码>空< /代码> URL将被设置为<密码> & lt;关键>;。PNG <代码>,即<代码>键< /代码>是";外星人";然后URL将";PNG和外星人。quot;。

frameWidth number 在精灵片中一个单一帧的像素的宽度。
frameHeight number 在精灵片中一个单一帧的像素高度。
frameMax number <optional>
-1 在这个精灵片中有多少帧。如果没有指定,它会把整个图像分割成帧。
margin number <optional>
0 如果该帧已被绘制,在这里指定的量。
spacing number <optional>
0 如果这些帧已被绘制到它们之间的间隔,指定这里的量。

Source code: loader/Loader.js (Line 926)


start()

开始载入资产。通常你不需要为自己的状态管理器会这么做。

Source code: loader/Loader.js (Line 1708)


text(key, url, overwrite) → {Phaser.Loader}

将一个文本文件添加到当前的负载队列中。

参数

名称 类型 参数 默认值 描述
key string “文本文件的唯一资产密钥”。
url string <optional>
“文本文件”的网址。如果未定义或<代码>空< /代码> URL将被设置为<密码> & lt;关键>;.txt ,即<代码>键< /代码>是";外星人";然后URL将";外星人.txt & quot;。

overwrite boolean <optional>
false 如果在队列中已存在匹配密钥的卸载文件,该条目将改写它。

Source code: loader/Loader.js (Line 744)


tilemap(key, url, data, format) → {Phaser.Loader}

将瓦片地图数据文件添加到当前的负载队列中。

参数

名称 类型 参数 默认值 描述
key string

独特资产关键tilemap数据。

url string <optional>
“地图文件”的网址。如果未定义或<代码> > < /编码空无数据给出的URL将被设置为<密码> & lt;关键>;。JSON < /代码>,即<代码>键< /代码>是";一级";然后将“URL;一级。JSON ";。

data object | string <optional>

可选的JSON数据对象。如果给定的URL是忽略这个JSON对象用于地图数据代替。

format number <optional>
Phaser.Tilemap.CSV “地图数据格式”。无论是phaser.tilemap.csv或相位。tilemap。tiled_json。

Source code: loader/Loader.js (Line 1142)


<internal> totalLoadedFiles() → {number}

返回已加载的文件的数量,即使他们有错误的。

Source code: loader/Loader.js (Line 2951)


<internal> totalLoadedPacks() → {number}

收益资产包已加载的数量,即使他们有错误的。

Source code: loader/Loader.js (Line 2977)


<internal> totalQueuedFiles() → {number}

返回在负载队列中等待处理的文件的数量。此值随队列中的每个文件被加载。

Source code: loader/Loader.js (Line 2964)


<internal> totalQueuedPacks() → {number}

返回在负载队列中等待处理的资产包数。此值随队列中的每一个包被加载。

Source code: loader/Loader.js (Line 2990)


<internal> transformUrl(url, file) → {string}

转换资产网址。

参数

名称 类型 参数 默认值 描述
url string < >的网址转换。
file object <文件对象正在被转换。

Source code: loader/Loader.js (Line 2036)


video(key, urls, loadEvent, asBlob) → {Phaser.Loader}

将视频文件添加到当前的负载队列中。

参数

名称 类型 参数 默认值 描述
key string 视频文件的独特的资产密钥。
urls string | Array.<string> | Array.<object>

无论是一个字符串或<代码> { URI的URI或对数组类型::..,.. }

loadEvent string <optional>
'canplaythrough' 这台设置的视频源事件在负载被认为是完整的。
asBlob boolean <optional>
false

视频文件可以被加载通过视频元素的src属性的创作集。

Source code: loader/Loader.js (Line 1088)


withSyncPoints(callback, callbackContext) → {Phaser.Loader}

在所提供的回调函数中添加一个同步点到资产/文件添加。

参数

名称 类型 参数 默认值 描述
callback function 该回调函数被调用,并提供一个单一的参数:装载机。
callbackContext object <optional>
(loader) <回调的背景下。

Source code: loader/Loader.js (Line 1622)


xml(key, url, overwrite) → {Phaser.Loader}

将XML文件添加到当前的负载队列中。

参数

名称 类型 参数 默认值 描述
key string P<0.05文件的独特的资产密钥。
url string <optional>
<0文件的网址。如果未定义或<代码>空< /代码> URL将被设置为<密码> & lt;关键>;XML < /代码>,即<代码>键< /代码>是";外星人";然后URL将";XML与外星人。quot;。

overwrite boolean <optional>
false 如果在队列中已存在匹配密钥的卸载文件,该条目将改写它。

Source code: loader/Loader.js (Line 826)