本篇文档翻译者:安之亮
Phaser.Cache
new Cache(game)
Phaser只有一个Cache(缓存)来存储所有素材。
缓存被分成区,如图片,音效,视频,json文件等。这些素材使用唯一的字符键作为标识。但不同区域的素材可以使用同一个键名。例如一个sprite sheet(精灵表)和声音文件可以使用同一键名“playerWalking”。缓存的内容是由Phaser.Loader自动装入的。当你用loader获取一个外部素材(如图片)时,这些素材就被自动装入缓存中对应的位置。最常用的游戏对象,如Sprite或视频会自动查询缓存来抽取素材,从而实例化它们。
你可以在一个State中使用this.cache来处理缓存。如此便可以使用它拥有的公共方法。包括添加新的内容,删除或查询。当你从缓存中获得一个素材时,你得到的是一个引用而不是拷贝。所以当你取得一个素材并修改它,缓存中的素材也会被修改,即使你没有将它放回缓存。
默认情况下,改变State不会清空缓存,但如果你的游戏需要的话,还是有一个选项可以清空缓存的。在一般游戏里,缓存只在游戏被读取后才被装入素材,仅此一次。之后缓存就被当做一个素材库来使用。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
game | Phaser.Game | 当前运行的游戏的一个引用。 |
源码 - loader/Cache.js, line 34
成员
<static, constant>BINARY : number
源码 - loader/Cache.js, line 166
<static, constant>BITMAPDATA : number
源码 - loader/Cache.js, line 172
<static, constant>BITMAPFONT : number
源码 - loader/Cache.js, line 178
<static, constant>CANVAS : number
源码 - loader/Cache.js, line 124
<static, constant>DEFAULT : PIXI.Texture
纹理的默认图片。
源码 - loader/Cache.js, line 215
<static, constant>IMAGE : number
源码 - loader/Cache.js, line 130
<static, constant>JSON : number
源码 - loader/Cache.js, line 184
<static, constant>MISSING : PIXI.Texture
当纹理的源图片丢失时的默认图片。
源码 - loader/Cache.js, line 222
<static, constant>PHYSICS : number
源码 - loader/Cache.js, line 154
<static, constant>RENDER_TEXTURE : number
源码 - loader/Cache.js, line 208
<static, constant>SHADER : number
源码 - loader/Cache.js, line 202
<static, constant>SOUND : number
源码 - loader/Cache.js, line 142
<static, constant>TEXT : number
源码 - loader/Cache.js, line 148
<static, constant>TEXTURE : number
源码 - loader/Cache.js, line 136
<static, constant>TILEMAP : number
源码 - loader/Cache.js, line 160
<static, constant>VIDEO : number
源码 - loader/Cache.js, line 196
<static, constant>XML : number
源码 - loader/Cache.js, line 190
autoResolveURL : boolean
当使用Cache.getURL方法时自动解析网址为绝对路径。
源码 - loader/Cache.js, line 45
game : Phaser.Game
游戏的本地引用。
源码 - loader/Cache.js, line 39
onSoundUnlock : Phaser.Signal
当移动设备上的声音系统通过触摸事件解锁时,此事件将被触发。
源码 - loader/Cache.js, line 91
方法
addBinary(key, binaryData)
在缓存中增加一个二进制对象。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 将被存储到缓存中的素材所对应的键。在这个缓存中此键名应该唯一。 |
binaryData | object | 将被装入缓存的二进制对象。 |
源码 - loader/Cache.js, line 424
addBitmapData(key, bitmapData, frameData) : Phaser.BitmapData
向缓存添加一个BitmapData(位图数据)对象。
参数:
参数名 | 参数类型 | 是否可选 | 默认值 | 描述 |
---|---|---|---|---|
key | string | 这个素材在缓存中的键名称。在这个缓存中应该唯一。 | ||
bitmapData | Phaser.BitmapData | 要被加入缓存的图像数据对象。 | ||
frameData | Phaser.FrameData | null | 可选 | (自动创建) | 可选的帧数据设置关联已有的图像数据。如果没有特别说明(或未定义),一个包含图像帧的帧数据对象将被创建。如果指定null(空),没有帧数据会被创建。 |
返回:Phaser.BitmapData,将被存入缓存的图像数据对象。
源码 - loader/Cache.js, line 437
addBitmapFont(key, url, data, atlasData, atlasType, xSpacing, ySpacing)
向缓存添加一个新的位图字体。
参数:
参数名 | 参数类型 | 是否可选 | 默认值 | 描述 |
---|---|---|---|---|
key | string | 这个素材在缓存中的键名称。在这个缓存中应该唯一。 | ||
url | string | 载入素材的url。如果没有素材被载入则设置为空。 | ||
data | object | 额外字体数据。 | ||
atlasData | object | 位图字体数据。 | ||
atlasType | string | 可选 | 'xml' | 位图字体数据文件的格式:json或xml。 |
xSpacing | number | 可选 | 0 | 字符水平间距的像素值。 |
ySpacing | number | 可选 | 0 | 字符垂直间距的像素值。 |
源码 - loader/Cache.js, line 462
addCanvas(key, canvas, context)
向缓存中添加一个新的canvas对象。
参数:
参数名 | 参数类型 | 参数 | 描述 |
---|---|---|---|
key | string | 这个素材在缓存中的键名称。在这个缓存中应该唯一。 | |
canvas | HTMLCanvasElement | Canvas 的dom元素。 | |
context | CanvasRenderingContext2D | 可选 | canvas元素的内容。如果没有特别说明默认为canvas.getContext('2d')。 |
源码 - loader/Cache.js, line 230
addImage(key, url, data) : object
添加一个位图文件。这个文件通常是通过Loader事先载入。 但也可以事先被载入到DOM. If如果之前有一个同键名的位图 存在缓存中,那这个位图将被删除销毁,新的位图将被插入它在缓存的位置。
如果位图没有被获取(成功或失败),则会在控制台显示一条警告信息。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 将被存储到缓存中的素材所对应的键。在这个缓存中此键名应该唯一。 |
url | string | 载入素材的url。如果没有素材被载入则设置为空。 |
data | object | 额外位图数据。 |
返回:object,完整的位图对象被载入缓存。
源码 - loader/Cache.js, line 246
addJSON(key, url, data)
添加一个json对象。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 将被存储到缓存中的素材所对应的键。在这个缓存中此键名应该唯一。 |
url | string | 载入素材的url。如果没有素材被载入则设置为空。 |
data | object | 额外json数据。 |
源码 - loader/Cache.js, line 501
addPhysicsData(key, url, JSONData, format)
添加一个物理数据对象。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 将被存储到缓存中的素材所对应的键。在这个缓存中此键名应该唯一。 |
url | string | 载入素材的url。如果没有素材被载入则设置为空。 |
JSONData | object | 物理数据对象(一个Json文件)。 |
format | number | 物理数据的格式。 |
源码 - loader/Cache.js, line 390
addRenderTexture(key, texture)
添加一个新的Phaser.RenderTexture。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 将被存储到缓存中的素材所对应的键。在这个缓存中此键名应该唯一。 |
texture | Phaser.RenderTexture | 被用作 RenderTexture的基础纹理。 |
源码 - loader/Cache.js, line 566
addShader(key, url, data)
在缓存中添加一个片段着色。该文件必须已经加载,通常通过Phaser.Loader。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 将被存储到缓存中的素材所对应的键。在这个缓存中此键名应该唯一。 |
url | string | 载入素材的url。如果没有素材被载入则设置为空。 |
data | object | 额外的着色数据。 |
源码 - loader/Cache.js, line 550
addSound(key, url, data, webAudio, audioTag)
将声音文件添加到缓存中。该文件必须已经加载,通常通过phaser.Loader。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 将被存储到缓存中的素材所对应的键。在这个缓存中此键名应该唯一。 |
url | string | 载入素材的url。如果没有素材被载入则设置为空。 |
data | object | 额外的声音数据。 |
webAudio | boolean | 如果是网络声音文件则返回True。 |
audioTag | boolean | 如果文件是使用传统的HTML音频则返回True。 |
源码 - loader/Cache.js, line 338
addSpriteSheet(key, url, data, frameWidth, frameHeight, frameMax, margin, spacing)
在缓存中添加一个新的精灵表。
参数:
参数名 | 参数类型 | 是否可选 | 默认值 | 描述 |
---|---|---|---|---|
key | string | 这个素材在缓存中的键名称。在这个缓存中应该唯一。 | ||
url | string | 载入素材的url。如果没有素材被载入则设置为空。 | ||
data | object | 额外的精灵表数据。 | ||
frameWidth | number | 每一帧精灵的宽度。 | ||
frameHeight | number | 每一帧精灵的高度。 | ||
frameMax | number | 可选 | -1 | 精灵表的帧数。如果返回-1则将精灵表平均地分割。 |
margin | number | 可选 | 0 | 如果有margin,设置margin的值。 |
spacing | number | 可选 | 0 | 如果有spacing,设置spacing的值。 |
源码 - loader/Cache.js, line 579
addText(key, url, data)
添加一个新的文本数据。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 将被存储到缓存中的素材所对应的键。在这个缓存中此键名应该唯一。 |
url | string | 载入素材的url。如果没有素材被载入则设置为空。 |
data | object | 额外的文本数据。 |
源码 - loader/Cache.js, line 374
addTextureAtlas(key, url, data, atlasData, format)
添加一个新的纹理atlas。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 将被存储到缓存中的素材所对应的键。在这个缓存中此键名应该唯一。 |
url | string | 载入素材的url。如果没有素材被载入则设置为空。 |
data | object | 额外的纹理atlas数据。 |
atlasData | object | 纹理atlas帧数据。 |
format | number | 纹理atlas的文件格式。 |
源码 - loader/Cache.js, line 616
addTilemap(key, url, mapData, format)
添加一个新的tilemap。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 将被存储到缓存中的素材所对应的键。在这个缓存中此键名应该唯一。 |
url | string | 载入素材的url。如果没有素材被载入则设置为空。 |
mapData | object | tilemap数据对象 (可以是CSV或 JSON文件)。 |
format | number | tilemap数据的格式。 |
源码 - loader/Cache.js, line 407
addVideo(key, url, data, isBlob)
将视频文件添加到缓存中。该文件必须已经加载,通常通过Phaser.Loader。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 将被存储到缓存中的素材所对应的键。在这个缓存中此键名应该唯一。 |
url | string | 载入素材的url。如果没有素材被载入则设置为空。 |
data | object | 额外的视频数据。 |
isBlob | boolean | 如果文件预装通过XHR和数据参数是一个Blob返回True。假如果一个视频标签被创建,返回False。 |
源码 - loader/Cache.js, line 533
addXML(key, url, data)
添加一个xml数据对象。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 将被存储到缓存中的素材所对应的键。在这个缓存中此键名应该唯一。 |
url | string | 载入素材的url。如果没有素材被载入则设置为空。 |
data | object | 额外的XML数据。 |
源码 - loader/Cache.js, line 517
checkBinaryKey(key) : boolean
检查二进制高速缓存中是否存在给定的键。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 缓存中游戏素材的键名称。 |
返回:boolean,键名存在返回true,否则返回false。
源码 - loader/Cache.js, line 915
checkBitmapDataKey(key) : boolean
检查键名是否在位图数据缓存中。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 缓存中的键值。 |
返回:boolean,键名存在返回true,否则返回false。
源码 - loader/Cache.js, line 928
checkBitmapFontKey(key) : boolean
检查键名是否在位图字体缓存中。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 缓存中的键值。 |
返回:boolean,键名存在返回true,否则返回false。
源码 - loader/Cache.js, line 941
checkCanvasKey(key) : boolean
检查键名是否在Canvas缓存中。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 缓存中的键值。 |
返回:boolean,键名存在返回true,否则返回false。
源码 - loader/Cache.js, line 824
checkImageKey(key) : boolean
检查键名是否在位图缓存中。注意包括纹理atlases,精灵表和Retro字体。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 缓存中的键值。 |
返回:boolean,键名存在返回true,否则返回false。
源码 - loader/Cache.js, line 837
checkJSONKey(key) : boolean
检查键名是否在Json缓存中。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 缓存中的键值。 |
返回:boolean,键名存在返回true,否则返回false。
源码 - loader/Cache.js, line 954
checkKey(cache, key) : boolean
检查一个给定的对象类型的键是否在缓存中。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
cache | integer | 搜索缓存。为常量,如Phaser.Cache.IMAGE或haser.Cache.SOUND。 |
key | string | 缓存中的键值。 |
返回:boolean,键名存在返回true,否则返回false。
源码 - loader/Cache.js, line 784
checkPhysicsKey(key) : boolean
检查键名是否在物理缓存中。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 缓存中的键值。 |
返回:boolean,键名存在返回true,否则返回false。
源码 - loader/Cache.js, line 889
checkRenderTextureKey(key) : boolean
检查键名是否在纹理渲染缓存中。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 缓存中的键值。 |
返回:boolean,键名存在返回true,否则返回false。
源码 - loader/Cache.js, line 1006
checkShaderKey(key) : boolean
检查键名是否在片段着色器缓存中。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 缓存中的键值。 |
返回:boolean,键名存在返回true,否则返回false。
源码 - loader/Cache.js, line 993
checkSoundKey(key) : boolean
检查键名是否在Sound缓存中。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 缓存中的键值。 |
返回:boolean,键名存在返回true,否则返回false。
源码 - loader/Cache.js, line 863
checkTextKey(key) : boolean
检查键名是否在文本缓存中。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 缓存中的键值。 |
返回:boolean,键名存在返回true,否则返回false。
源码 - loader/Cache.js, line 876
checkTextureKey(key) : boolean
检查键名是否在纹理缓存中。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 缓存中的键值。 |
返回:boolean,键名存在返回true,否则返回false。
源码 - loader/Cache.js, line 850
checkTilemapKey(key) : boolean
检查键名是否在Tilemap缓存中。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 缓存中的键值。 |
返回:boolean,键名存在返回true,否则返回false。
源码 - loader/Cache.js, line 902
checkURL(url) : boolean
检查一个给定的URL是否被载入缓存。只有在所有的preloading发生前把Cache.autoResolveURL设置为True时,这个方法才有效。这个方法还会触发一个给定的URL的DOM src事件,所以请注意文件类型,比如Sound文件在Firefox上回发生2次载入实例。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
url | string | 缓存中要检查的url。 |
返回:boolean,url存在返回true,否则返回false。
源码 - loader/Cache.js, line 803
checkVideoKey(key) : boolean
检查键名是否在视频缓存中。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 缓存中的键值。 |
返回:boolean,键名存在返回true,否则返回false。
源码 - loader/Cache.js, line 980
checkXMLKey(key) : boolean
检查键名是否在XML缓存中。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 缓存中的键值。 |
返回:boolean,键名存在返回true,否则返回false。
源码 - loader/Cache.js, line 967
decodedSound(key, data)
添加一个解码的声音文件。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 缓存中的键值。 |
data | object | 额外的声音数据。 |
源码 - loader/Cache.js, line 726
destroy()
清除缓存,移除所有缓存对象。如果缓存对象有destroy方法,它也会被调用。
源码 - loader/Cache.js, line 1947
getBaseTexture(key, cache) : PIXI.BaseTexture
获得一个PIXI.BaseTexture。
参数:
参数名 | 参数类型 | 是否可选 | 默认值 | 描述 |
---|---|---|---|---|
key | string | 图像中BaseTexture的键名。 | ||
cache | integer | 可选 | Phaser.Cache.IMAGE | 用来搜索素材的缓存。 |
返回:PIXI.BaseTexture,BaseTexture对象。
源码 - loader/Cache.js, line 1426
getBinary(key) : object
在缓存中获取一个二进制对象。
这个对象有给定的键来查询。
注意:如果对象违背找到,控制台会发出一条警告信息。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 缓存中的键值。 |
返回:object,二进制数据对象。
源码 - loader/Cache.js, line 1266
getBitmapData(key) : Phaser.BitmapData
从缓存中获取一个位图数据对象。
这个对象有给定的键来查询。
注意:如果对象违背找到,控制台会发出一条警告信息。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 缓存中的键值。 |
返回:Phaser.BitmapData,如果查询成功返回Phaser.BitmapData,否则返回空值。
源码 - loader/Cache.js, line 1283
getBitmapFont(key) : Phaser.BitmapFont
从缓存中获取一个位图字体对象。
这个对象有给定的键来查询。
注意:如果对象违背找到,控制台会发出一条警告信息。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 缓存中的键值。 |
返回:Phaser.BitmapFont,如果查询成功返回Phaser.BitmapFont,否则返回空值。
源码 - loader/Cache.js, line 1300
getCanvas(key) : object
从缓存中获取一个Canvas对象。
这个对象有给定的键来查询。
注意:如果对象违背找到,控制台会发出一条警告信息。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 缓存中的键值。 |
返回:object,如果此对象被找到则返回canvas对象,否则返回空值。
源码 - loader/Cache.js, line 1061
getFrame(key, cache) : Phaser.Frame
根据键名获取一个帧。目的是为了创建一个非atlas精灵表位图。
参数:
参数名 | 参数类型 | 是否可选 | 默认值 | 描述 |
---|---|---|---|---|
key | string | 帧数据在缓存中的键名。 | ||
cache | integer | 可选 | Phaser.Cache.IMAGE | 搜索缓存中的内容。 |
返回:Phaser.Frame,帧数据。
源码 - loader/Cache.js, line 1442
getFrameByIndex(key, index, cache) : Phaser.Frame
根据键名获取一个帧数据以外的单一帧。
参数:
参数名 | 参数类型 | 是否可选 | 默认值 | 描述 |
---|---|---|---|---|
key | string | 帧数据在缓存中的键名。 | ||
index | number | 帧序列号。 | ||
cache | integer | 可选 | Phaser.Cache.IMAGE | 查询缓存常量如Phaser.Cache.IMAGE 或Phaser.Cache.SOUND。 |
返回:Phaser.Frame,帧数据。
源码 - loader/Cache.js, line 1536
getFrameByName(key, name, cache) : Phaser.Frame
根据键名获取一个帧数据以外的单一帧。
参数:
参数名 | 参数类型 | 是否可选 | 默认值 | 描述 |
---|---|---|---|---|
key | string | 帧数据在缓存中的键名。 | ||
name | string | 帧名称。 | ||
cache | integer | 可选 | Phaser.Cache.IMAGE | 查询缓存常量如Phaser.Cache.IMAGE 或Phaser.Cache.SOUND。 |
返回:Phaser.Frame,帧数据。
源码 - loader/Cache.js, line 1560
getFrameCount(key, cache) : number
根据给定的键名获取帧的总数。
参数:
参数名 | 参数类型 | 是否可选 | 默认值 | 描述 |
---|---|---|---|---|
key | string | 帧数据在缓存中的键名。 | ||
cache | integer | 可选 | Phaser.Cache.IMAGE | 搜索缓存中的内容。 |
返回:number,返回帧的总数,如果没有找到位图则返回0。
源码 - loader/Cache.js, line 1458
getFrameData(key, cache) : Phaser.FrameData
从位图缓存中获取帧数据对象。
这个对象有给定的键来查询。
注意:如果对象违背找到,控制台会发出一条警告信息。
参数:
参数名 | 参数类型 | 是否可选 | 默认值 | 描述 |
---|---|---|---|---|
key | string | 帧数据在缓存中的键名。 | ||
cache | integer | 可选 | Phaser.Cache.IMAGE | 搜索缓存中的内容。 |
返回:Phaser.FrameData,帧数据。
源码 - loader/Cache.js, line 1458
getImage(key, full) : Image
获得一个位图对象。是DOM位图而不是Phaer.Image对象。
这个对象有给定的键来查询。
注意:如果对象未被找到,控制台会发出一条警告信息。
只查询缓存的Image区域,包括位图,精灵表和纹理Atlas。
如果图片被位图字体使用,请使用get方法。
参数:
参数名 | 参数类型 | 是否可选 | 默认值 | 描述 |
---|---|---|---|---|
key | string | 可选 | 素材在缓存中的键。如果没有或空返回一个默认位图。如果有但是没找到则抛出异常并返回丢失的位图。 | |
full | boolean | 可选 | false | 如果是true则返回整个位图对象,如果false则返回HTML位图。 |
返回:Image,若果在缓存中找到则返回位图对象,否则返回空值。当full为真时返回一个JavaScript对象。
源码 - loader/Cache.js, line 1078
getItem(key, cache, method, property) : object
根据属性或键获得一个item。
通常在内部使用,一般被类似getImage的方法实用,但是也可以单独调用。
参数:
参数名 | 参数类型 | 是否可选 | 描述 |
---|---|---|---|
key | string | 数据在缓存中的键。 | |
cache | integer | 查询缓存常量如Phaser.Cache.IMAGE或Phaser.Cache.SOUND。 | |
method | string | 可选 | 可以为空,控制台则不发出警告。 |
property | string | 可选 | 如果你需要一个特别的属性,在此说明。 |
返回:object,找到则返回item,否则返回空。如果键无效控制台发出警告。
源码 - loader/Cache.js, line 1023
getJSON(key, clone) : object
在缓存中获得一个JSON对象。
这个对象有给定的键来查询。
注意:如果对象未被找到,控制台会发出一条警告信息。
可以返回对象的引用(默认),或设置true来返回一份复制。
参数:
参数名 | 参数类型 | 是否可选 | 默认值 | 描述 |
---|---|---|---|---|
key | string | 数据在缓存中的键。 | ||
clone | boolean | 可选 | false | 返回原始对象的复制(true)或引用(false)。 |
返回:object,JSON对象或数组(如果键指向数组属性的话)。如果属性未被找到则返回null。
源码 - loader/Cache.js, line 1317
getKeys(cache) : Array
再被查询的缓存中获得其中所有的键。
参数:
参数名 | 参数类型 | 是否可选 | 默认值 | 描述 |
---|---|---|---|---|
cache | integer | 可选 | Phaser.Cache.IMAGE | 获得缓存中的键。为常量,如Phaser.Cache.IMAGE或haser.Cache.SOUND。 |
返回:Array,缓存中所有键组成的数组。
源码 - loader/Cache.js, line 1609
getPhysicsData(key, object, fixtureKey) : object
获得一个物理数据对象。
根据给定的键查找。
注意:如果对象未被找到,控制台会发出一条警告信息。
你可以获得整个数据链,或一个对象或一个一个兑现的修正。
参数:
参数名 | 参数类型 | 是否可选 | 默认值 | 描述 |
---|---|---|---|---|
key | string | 从缓存中获取的键。 | ||
object | string | 可选 | null | 如果指定了它将返回给定的一部分的物理对象,如果空,它将返回所有的对象。 |
fixtureKey | string | 被修正对象的修正键。可以通过PhaserExporter修正此键。 |
返回:object,返回物理对象如果被找到的话。
源码 - loader/Cache.js, line 1187
getRenderTexture(key) : object
从缓存中获取一个RenderTexture对象。
通过给定的键来查找此对象。
注意:如果对象未被找到,控制台会发出一条警告信息。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 缓存中的键值。 |
返回:object,带有选软纹理和帧的对象。
源码 - loader/Cache.js, line 1405
getShader(key) : string
从缓存中获取一个片段着色对象。
通过给定的键来查找此对象。
注意:如果对象未被找到,控制台会发出一条警告信息。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 缓存中的键值。 |
返回:string,着色对象。
源码 - loader/Cache.js, line 1388
getSound(key) : Phaser.Sound
获得一个声音对象。
通过给定的键来查找此对象。
注意:如果对象未被找到,控制台会发出一条警告信息。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 缓存中的键值。 |
返回:Phaser.Sound,声音对象。
源码 - loader/Cache.js, line 1136
getSoundData(key) : object
获得一个原始声音数据对象。
通过给定的键来查找此对象。
注意:如果对象未被找到,控制台会发出一条警告信息。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 缓存中的键值。 |
返回:object,声音数据。
源码 - loader/Cache.js, line 1153
getText(key) : object
获得一个文本对象。
通过给定的键来查找此对象。
注意:如果对象未被找到,控制台会发出一条警告信息。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 缓存中的键值。 |
返回:object,文本数据对象。
源码 - loader/Cache.js, line 1170
getTextureFrame(key) : Phaser.Frame
由键来获得单个纹理帧。
这个默认的帧只能用来创建非atlas,非精灵表位图。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 缓存中的键值。 |
返回:Phaser.Frame,帧数据。
源码 - loader/Cache.js, line 1121
getTilemapData(key) : object
获得一个原始的Tilemap数据对象。可以使CSV或JSON格式。
通过给定的键来查找此对象。
注意:如果对象未被找到,控制台会发出一条警告信息。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 缓存中的键值。 |
返回:object,CSV或JSON格式中的原始tailemap数据。
源码 - loader/Cache.js, line 1249
getURL(url) : object
通过URL获取缓存对象。通过设置Cache.autoResolveURL t来返回一个值。注意每次使用这个方法都会触发一个Dom路径查询,所以小心以免在目标设备会浏览器中两次检查。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
url | string | 用来载入对象的url。 |
返回:object,缓存对象。
源码 - loader/Cache.js, line 1584
getVideo(key) : Phaser.Video
获取一个视频对象。
通过给定的键来查找此对象。
注意:如果对象未被找到,控制台会发出一条警告信息。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 从缓存中获取的键。 |
返回:Phaser.Video,视频对象。
源码 - loader/Cache.js, line 1371
getXML(key) : object
获取一个XML对象。
通过给定的键来查找此对象。
注意:如果对象未被找到,控制台会发出一条警告信息。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 从缓存中获取的键。 |
返回:object,XML对象。
源码 - loader/Cache.js, line 1354
hasFrameData(key, cache) : boolean
检查整数据对应的键是否在位图缓存中。
参数:
参数名 | 参数类型 | 是否可选 | 默认值 | 描述 |
---|---|---|---|---|
key | string | 从缓存中获取的键。 | ||
cache | string | 可选 | Phaser.Cache.IMAGE | 用来搜索对象的缓存。 |
返回:boolean,如果给定的键有整数据则返回true,否则返回false。
源码 - loader/Cache.js, line 1501
isSoundDecoded(key) : boolean
检查声音对象是否已完成解码。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 从缓存中获取的键。 |
返回:boolean,声音对象是否已解码。
源码 - loader/Cache.js, line 743
isSoundReady(key) : boolean
检查声音对象是否可以播放。当一个声音对象完成解码并且设备不在触摸锁定时,就可以准备播放了。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 从缓存中获取的键。 |
返回:boolean,当声音已解码并且设备部再触摸锁定时,返回true。
源码 - loader/Cache.js, line 761
reloadSound(key)
从服务器上从新读取一个声音文件。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 从缓存中获取的键。 |
源码 - loader/Cache.js, line 666
reloadSoundComplete(key)
当声音从新载入完成后触发onSoundUnlock事件。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 从缓存中获取的键。 |
源码 - loader/Cache.js, line 691
removeBinary(key)
从缓存中删除一个二进制文件。
注意这只是从Phaser.Cache删除,如果你程序的其他地方还有对象的引用,那么它还会在内存中。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 要删除的对象的键。 |
源码 - loader/Cache.js, line 1747
removeBitmapData(key)
从缓存中删除一个位图数据。
注意这只是从Phaser.Cache删除,如果你程序的其他地方还有对象的引用,那么它还会在内存中。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 要删除的对象的键。 |
源码 - loader/Cache.js, line 1762
removeBitmapFont(key)
从缓存中删除一个位图字体。
注意这只是从Phaser.Cache删除,如果你程序的其他地方还有对象的引用,那么它还会在内存中。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 要删除的对象的键。 |
源码 - loader/Cache.js, line 1777
removeCanvas(key)
从缓存中删除一个画布。
注意这只是从Phaser.Cache删除,如果你程序的其他地方还有对象的引用,那么它还会在内存中。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 要删除的对象的键。 |
源码 - loader/Cache.js, line 1641
removeImage(key, destroyBaseTexture)
从缓存中删除一个图片。
你可以选择从内存中删除它,这将会调用BaseTexture.destroy。
注意这只是从Phaser.Cache删除,如果你程序的其他地方还有对象的引用,那么它还会在内存中。
参数:
参数名 | 参数类型 | 是否可选 | 默认值 | 描述 |
---|---|---|---|---|
key | string | 要删除的对象的键。 | ||
destroyBaseTexture | boolean | 可选 | true | 和图像绑定的BaseTexture是否应该被销毁。 |
源码 - loader/Cache.js, line 1656
removeJSON(key)
从缓存中删除一个json对象。
注意这只是从Phaser.Cache删除,如果你程序的其他地方还有对象的引用,那么它还会在内存中。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 要删除的对象的键。 |
源码 - loader/Cache.js, line 1792
removePhysics(key)
从缓存中删除一个物理数据文件。
注意这只是从Phaser.Cache删除,如果你程序的其他地方还有对象的引用,那么它还会在内存中。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 要删除的对象的键。 |
源码 - loader/Cache.js, line 1717
removeRenderTexture(key)
从缓存中删除一个渲染纹理。
注意这只是从Phaser.Cache删除,如果你程序的其他地方还有对象的引用,那么它还会在内存中。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 要删除的对象的键。 |
源码 - loader/Cache.js, line 1852
removeShader(key)
从缓存中删除一个着色器。
注意这只是从Phaser.Cache删除,如果你程序的其他地方还有对象的引用,那么它还会在内存中。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 要删除的对象的键。 |
源码 - loader/Cache.js, line 1837
removeSound(key)
从缓存中删除一个音频。
如果有其他Phaser.Sound对象使用了用该方法移除的音频文件,它们会自动销毁。如果你想要更加全面的控制,你可以自己先做一些清理工作,然后再调用该方法。
注意这只是从Phaser.Cache删除,如果你程序的其他地方还有对象的引用,那么它还会在内存中。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 要删除的对象的键。 |
源码 - loader/Cache.js, line 1683
removeSpriteSheet(key)
从缓存中删除一个精灵图集。
注意这只是从Phaser.Cache删除,如果你程序的其他地方还有对象的引用,那么它还会在内存中。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 要删除的对象的键。 |
源码 - loader/Cache.js, line 1867
removeText(key)
从缓存中删除一个精灵图集。
注意这只是从Phaser.Cache删除,如果你程序的其他地方还有对象的引用,那么它还会在内存中。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 要删除的对象的键。 |
源码 - loader/Cache.js, line 1702
removeTextureAtlas(key)
从缓存中删除一个Atlas纹理。
注意这只是从Phaser.Cache删除,如果你程序的其他地方还有对象的引用,那么它还会在内存中。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 要删除的对象的键。 |
源码 - loader/Cache.js, line 1882
removeTilemap(key)
从缓存中删除一个瓦片地图。
注意这只是从Phaser.Cache删除,如果你程序的其他地方还有对象的引用,那么它还会在内存中。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 要删除的对象的键。 |
源码 - loader/Cache.js, line 1732
removeVideo(key)
从缓存中删除一个视频。
注意这只是从Phaser.Cache删除,如果你程序的其他地方还有对象的引用,那么它还会在内存中。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 要删除的对象的键。 |
源码 - loader/Cache.js, line 1822
removeXML(key)
从缓存中删除一个XML对象。
注意这只是从Phaser.Cache删除,如果你程序的其他地方还有对象的引用,那么它还会在内存中。
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 要删除的对象的键。 |
源码 - loader/Cache.js, line 1807
updateFrameData(key, frameData, cache)
更新一组帧数据。
参数:
参数名 | 参数类型 | 是否可选 | 默认值 | 描述 |
---|---|---|---|---|
key | string | 获得对象引用的唯一键名。 | ||
frameData | number | 新的帧数据。 | ||
cache | integer | 可选 | Phaser.Cache.IMAGE | 获得缓存中的键。为常量,如Phaser.Cache.IMAGE或haser.Cache.SOUND。 |
源码 - loader/Cache.js, line 1517
updateSound(key)
更新缓存中的声音对象
参数:
参数名 | 参数类型 | 描述 |
---|---|---|
key | string | 素材在缓存中的键名。 |
源码 - loader/Cache.js, line 709