Cache
Class: Phaser.Cache
Constructor
new Cache(game)
Phaser has one single cache in which it stores all assets.
The cache is split up into sections, such as images, sounds, video, json, etc. All assets are stored using
a unique string-based key as their identifier. Assets stored in different areas of the cache can have the
same key, for example 'playerWalking' could be used as the key for both a sprite sheet and an audio file,
because they are unique data types.
The cache is automatically populated by the Phaser.Loader. When you use the loader to pull in external assets
such as images they are automatically placed into their respective cache. Most common Game Objects, such as
Sprites and Videos automatically query the cache to extract the assets they need on instantiation.
You can access the cache from within a State via this.cache
. From here you can call any public method it has,
including adding new entries to it, deleting them or querying them.
Understand that almost without exception when you get an item from the cache it will return a reference to the
item stored in the cache, not a copy of it. Therefore if you retrieve an item and then modify it, the original
object in the cache will also be updated, even if you don't put it back into the cache again.
By default when you change State the cache is not cleared, although there is an option to clear it should
your game require it. In a typical game set-up the cache is populated once after the main game has loaded and
then used as an asset store.
Parameters
Name | Type | Description |
---|---|---|
game | Phaser.Game | A reference to the currently running game. |
- Source code: loader/Cache.js (Line 34)
Public Properties
- Source code: loader/Cache.js (Line 166)
- Source code: loader/Cache.js (Line 172)
- Source code: loader/Cache.js (Line 178)
- Source code: loader/Cache.js (Line 124)
- Source code: loader/Cache.js (Line 215)
- Source code: loader/Cache.js (Line 130)
- Source code: loader/Cache.js (Line 184)
- Source code: loader/Cache.js (Line 222)
- Source code: loader/Cache.js (Line 154)
- Source code: loader/Cache.js (Line 208)
- Source code: loader/Cache.js (Line 202)
- Source code: loader/Cache.js (Line 142)
- Source code: loader/Cache.js (Line 148)
- Source code: loader/Cache.js (Line 136)
- Source code: loader/Cache.js (Line 160)
- Source code: loader/Cache.js (Line 196)
- Source code: loader/Cache.js (Line 190)
- Source code: loader/Cache.js (Line 45)
- Source code: loader/Cache.js (Line 39)
- Source code: loader/Cache.js (Line 91)
[static] BINARY : number
[static] BITMAPDATA : number
[static] BITMAPFONT : number
[static] CANVAS : number
[static] DEFAULT : PIXI.Texture
The default image used for a texture when no other is specified.
[static] IMAGE : number
[static] JSON : number
[static] MISSING : PIXI.Texture
The default image used for a texture when the source image is missing.
[static] PHYSICS : number
[static] RENDER_TEXTURE : number
[static] SHADER : number
[static] SOUND : number
[static] TEXT : number
[static] TEXTURE : number
[static] TILEMAP : number
[static] VIDEO : number
[static] XML : number
autoResolveURL : boolean
Automatically resolve resource URLs to absolute paths for use with the Cache.getURL method.
game : Phaser.Game
Local reference to game.
onSoundUnlock : Phaser.Signal
This event is dispatched when the sound system is unlocked via a touch event on cellular devices.
Public Methods
- Source code: loader/Cache.js (Line 424)
- Source code: loader/Cache.js (Line 437)
- Source code: loader/Cache.js (Line 462)
- Source code: loader/Cache.js (Line 230)
- Internal:
- This member is internal (protected) and may be modified or removed in the future.
- Source code: loader/Cache.js (Line 291)
- Source code: loader/Cache.js (Line 246)
- Source code: loader/Cache.js (Line 501)
- Internal:
- This member is internal (protected) and may be modified or removed in the future.
- Source code: loader/Cache.js (Line 316)
- Source code: loader/Cache.js (Line 390)
- Source code: loader/Cache.js (Line 566)
- Source code: loader/Cache.js (Line 550)
- Source code: loader/Cache.js (Line 338)
- Source code: loader/Cache.js (Line 579)
- Source code: loader/Cache.js (Line 374)
- Source code: loader/Cache.js (Line 616)
- Source code: loader/Cache.js (Line 407)
- Source code: loader/Cache.js (Line 533)
- Source code: loader/Cache.js (Line 517)
- Source code: loader/Cache.js (Line 915)
- Source code: loader/Cache.js (Line 928)
- Source code: loader/Cache.js (Line 941)
- Source code: loader/Cache.js (Line 824)
- Source code: loader/Cache.js (Line 837)
- Source code: loader/Cache.js (Line 954)
- Source code: loader/Cache.js (Line 784)
- Source code: loader/Cache.js (Line 889)
- Source code: loader/Cache.js (Line 1006)
- Source code: loader/Cache.js (Line 993)
- Source code: loader/Cache.js (Line 863)
- Source code: loader/Cache.js (Line 876)
- Source code: loader/Cache.js (Line 850)
- Source code: loader/Cache.js (Line 902)
- Source code: loader/Cache.js (Line 803)
- Source code: loader/Cache.js (Line 980)
- Source code: loader/Cache.js (Line 967)
- Internal:
- This member is internal (protected) and may be modified or removed in the future.
- Source code: loader/Cache.js (Line 1897)
- Source code: loader/Cache.js (Line 726)
- Source code: loader/Cache.js (Line 1947)
- Source code: loader/Cache.js (Line 1426)
- Source code: loader/Cache.js (Line 1266)
- Source code: loader/Cache.js (Line 1283)
- Source code: loader/Cache.js (Line 1300)
- Source code: loader/Cache.js (Line 1061)
- Source code: loader/Cache.js (Line 1442)
- Source code: loader/Cache.js (Line 1536)
- Source code: loader/Cache.js (Line 1560)
- Source code: loader/Cache.js (Line 1458)
- Source code: loader/Cache.js (Line 1481)
- Source code: loader/Cache.js (Line 1078)
- Source code: loader/Cache.js (Line 1023)
- Source code: loader/Cache.js (Line 1317)
- Source code: loader/Cache.js (Line 1609)
- Source code: loader/Cache.js (Line 1187)
- Source code: loader/Cache.js (Line 1405)
- Source code: loader/Cache.js (Line 1388)
- Source code: loader/Cache.js (Line 1136)
- Source code: loader/Cache.js (Line 1153)
- Source code: loader/Cache.js (Line 1170)
- Source code: loader/Cache.js (Line 1121)
- Source code: loader/Cache.js (Line 1249)
- Source code: loader/Cache.js (Line 1584)
- Source code: loader/Cache.js (Line 1371)
- Source code: loader/Cache.js (Line 1354)
- Source code: loader/Cache.js (Line 1501)
- Source code: loader/Cache.js (Line 743)
- Source code: loader/Cache.js (Line 761)
- Source code: loader/Cache.js (Line 666)
- Source code: loader/Cache.js (Line 691)
- Source code: loader/Cache.js (Line 1747)
- Source code: loader/Cache.js (Line 1762)
- Source code: loader/Cache.js (Line 1777)
- Source code: loader/Cache.js (Line 1641)
- Source code: loader/Cache.js (Line 1656)
- Source code: loader/Cache.js (Line 1792)
- Source code: loader/Cache.js (Line 1717)
- Source code: loader/Cache.js (Line 1852)
- Source code: loader/Cache.js (Line 1837)
- Source code: loader/Cache.js (Line 1683)
- Source code: loader/Cache.js (Line 1867)
- Source code: loader/Cache.js (Line 1702)
- Source code: loader/Cache.js (Line 1882)
- Source code: loader/Cache.js (Line 1732)
- Source code: loader/Cache.js (Line 1822)
- Source code: loader/Cache.js (Line 1807)
- Source code: loader/Cache.js (Line 1517)
- Source code: loader/Cache.js (Line 709)
addBinary(key, binaryData)
Add a binary object in to the cache.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key that this asset will be stored in the cache under. This should be unique within this cache. |
binaryData | object | The binary object to be added to the cache. |
addBitmapData(key, bitmapData, frameData) → {Phaser.BitmapData}
Add a BitmapData object to the cache.
Parameters
Name | Type | Argument | Default | Description |
---|---|---|---|---|
key | string | The key that this asset will be stored in the cache under. This should be unique within this cache. | ||
bitmapData | Phaser.BitmapData | The BitmapData object to be addded to the cache. | ||
frameData | Phaser.FrameData | null | <optional> | (auto create) | Optional FrameData set associated with the given BitmapData. If not specified (or |
Returns
The BitmapData object to be addded to the cache.
addBitmapFont(key, url, data, atlasData, atlasType, xSpacing, ySpacing)
Add a new Bitmap Font to the Cache.
Parameters
Name | Type | Argument | Default | Description |
---|---|---|---|---|
key | string | The key that this asset will be stored in the cache under. This should be unique within this cache. | ||
url | string | The URL the asset was loaded from. If the asset was not loaded externally set to | ||
data | object | Extra font data. | ||
atlasData | object | Texture atlas frames data. | ||
atlasType | string | <optional> | 'xml' | The format of the texture atlas ( 'json' or 'xml' ). |
xSpacing | number | <optional> | 0 | If you'd like to add additional horizontal spacing between the characters then set the pixel value here. |
ySpacing | number | <optional> | 0 | If you'd like to add additional vertical spacing between the lines then set the pixel value here. |
addCanvas(key, canvas, context)
Add a new canvas object in to the cache.
Parameters
Name | Type | Argument | Description |
---|---|---|---|
key | string | The key that this asset will be stored in the cache under. This should be unique within this cache. | |
canvas | HTMLCanvasElement | The Canvas DOM element. | |
context | CanvasRenderingContext2D | <optional> | The context of the canvas element. If not specified it will default go |
<internal> addDefaultImage()
Adds a default image to be used in special cases such as WebGL Filters.
It uses the special reserved key of __default
.
This method is called automatically when the Cache is created.
This image is skipped when Cache.destroy
is called due to its internal requirements.
addImage(key, url, data) → {object}
Adds an Image file into the Cache. The file must have already been loaded, typically via Phaser.Loader, but can also have been loaded into the DOM.
If an image already exists in the cache with the same key then it is removed and destroyed, and the new image inserted in its place.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key that this asset will be stored in the cache under. This should be unique within this cache. |
url | string | The URL the asset was loaded from. If the asset was not loaded externally set to |
data | object | Extra image data. |
Returns
The full image object that was added to the cache.
addJSON(key, url, data)
Add a new json object into the cache.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key that this asset will be stored in the cache under. This should be unique within this cache. |
url | string | The URL the asset was loaded from. If the asset was not loaded externally set to |
data | object | Extra json data. |
<internal> addMissingImage()
Adds an image to be used when a key is wrong / missing.
It uses the special reserved key of __missing
.
This method is called automatically when the Cache is created.
This image is skipped when Cache.destroy
is called due to its internal requirements.
addPhysicsData(key, url, JSONData, format)
Add a new physics data object to the Cache.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key that this asset will be stored in the cache under. This should be unique within this cache. |
url | string | The URL the asset was loaded from. If the asset was not loaded externally set to |
JSONData | object | The physics data object (a JSON file). |
format | number | The format of the physics data. |
addRenderTexture(key, texture)
Add a new Phaser.RenderTexture in to the cache.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key that this asset will be stored in the cache under. This should be unique within this cache. |
texture | Phaser.RenderTexture | The texture to use as the base of the RenderTexture. |
addShader(key, url, data)
Adds a Fragment Shader in to the Cache. The file must have already been loaded, typically via Phaser.Loader.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key that this asset will be stored in the cache under. This should be unique within this cache. |
url | string | The URL the asset was loaded from. If the asset was not loaded externally set to |
data | object | Extra shader data. |
addSound(key, url, data, webAudio, audioTag)
Adds a Sound file into the Cache. The file must have already been loaded, typically via Phaser.Loader.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key that this asset will be stored in the cache under. This should be unique within this cache. |
url | string | The URL the asset was loaded from. If the asset was not loaded externally set to |
data | object | Extra sound data. |
webAudio | boolean | True if the file is using web audio. |
audioTag | boolean | True if the file is using legacy HTML audio. |
addSpriteSheet(key, url, data, frameWidth, frameHeight, frameMax, margin, spacing)
Add a new sprite sheet in to the cache.
Parameters
Name | Type | Argument | Default | Description |
---|---|---|---|---|
key | string | The key that this asset will be stored in the cache under. This should be unique within this cache. | ||
url | string | The URL the asset was loaded from. If the asset was not loaded externally set to | ||
data | object | Extra sprite sheet data. | ||
frameWidth | number | Width of the sprite sheet. | ||
frameHeight | number | Height of the sprite sheet. | ||
frameMax | number | <optional> | -1 | How many frames stored in the sprite sheet. If -1 then it divides the whole sheet evenly. |
margin | number | <optional> | 0 | If the frames have been drawn with a margin, specify the amount here. |
spacing | number | <optional> | 0 | If the frames have been drawn with spacing between them, specify the amount here. |
addText(key, url, data)
Add a new text data.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key that this asset will be stored in the cache under. This should be unique within this cache. |
url | string | The URL the asset was loaded from. If the asset was not loaded externally set to |
data | object | Extra text data. |
addTextureAtlas(key, url, data, atlasData, format)
Add a new texture atlas to the Cache.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key that this asset will be stored in the cache under. This should be unique within this cache. |
url | string | The URL the asset was loaded from. If the asset was not loaded externally set to |
data | object | Extra texture atlas data. |
atlasData | object | Texture atlas frames data. |
format | number | The format of the texture atlas. |
addTilemap(key, url, mapData, format)
Add a new tilemap to the Cache.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key that this asset will be stored in the cache under. This should be unique within this cache. |
url | string | The URL the asset was loaded from. If the asset was not loaded externally set to |
mapData | object | The tilemap data object (either a CSV or JSON file). |
format | number | The format of the tilemap data. |
addVideo(key, url, data, isBlob)
Adds a Video file into the Cache. The file must have already been loaded, typically via Phaser.Loader.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key that this asset will be stored in the cache under. This should be unique within this cache. |
url | string | The URL the asset was loaded from. If the asset was not loaded externally set to |
data | object | Extra video data. |
isBlob | boolean | True if the file was preloaded via xhr and the data parameter is a Blob. false if a Video tag was created instead. |
addXML(key, url, data)
Add a new xml object into the cache.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key that this asset will be stored in the cache under. This should be unique within this cache. |
url | string | The URL the asset was loaded from. If the asset was not loaded externally set to |
data | object | Extra text data. |
checkBinaryKey(key) → {boolean}
Checks if the given key exists in the Binary Cache.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset within the cache. |
Returns
True if the key exists in the cache, otherwise false.
checkBitmapDataKey(key) → {boolean}
Checks if the given key exists in the BitmapData Cache.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset within the cache. |
Returns
True if the key exists in the cache, otherwise false.
checkBitmapFontKey(key) → {boolean}
Checks if the given key exists in the BitmapFont Cache.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset within the cache. |
Returns
True if the key exists in the cache, otherwise false.
checkCanvasKey(key) → {boolean}
Checks if the given key exists in the Canvas Cache.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset within the cache. |
Returns
True if the key exists in the cache, otherwise false.
checkImageKey(key) → {boolean}
Checks if the given key exists in the Image Cache. Note that this also includes Texture Atlases, Sprite Sheets and Retro Fonts.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset within the cache. |
Returns
True if the key exists in the cache, otherwise false.
checkJSONKey(key) → {boolean}
Checks if the given key exists in the JSON Cache.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset within the cache. |
Returns
True if the key exists in the cache, otherwise false.
checkKey(cache, key) → {boolean}
Checks if a key for the given cache object type exists.
Parameters
Name | Type | Description |
---|---|---|
cache | integer | The cache to search. One of the Cache consts such as |
key | string | The key of the asset within the cache. |
Returns
True if the key exists, otherwise false.
checkPhysicsKey(key) → {boolean}
Checks if the given key exists in the Physics Cache.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset within the cache. |
Returns
True if the key exists in the cache, otherwise false.
checkRenderTextureKey(key) → {boolean}
Checks if the given key exists in the Render Texture Cache.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset within the cache. |
Returns
True if the key exists in the cache, otherwise false.
checkShaderKey(key) → {boolean}
Checks if the given key exists in the Fragment Shader Cache.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset within the cache. |
Returns
True if the key exists in the cache, otherwise false.
checkSoundKey(key) → {boolean}
Checks if the given key exists in the Sound Cache.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset within the cache. |
Returns
True if the key exists in the cache, otherwise false.
checkTextKey(key) → {boolean}
Checks if the given key exists in the Text Cache.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset within the cache. |
Returns
True if the key exists in the cache, otherwise false.
checkTextureKey(key) → {boolean}
Checks if the given key exists in the Texture Cache.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset within the cache. |
Returns
True if the key exists in the cache, otherwise false.
checkTilemapKey(key) → {boolean}
Checks if the given key exists in the Tilemap Cache.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset within the cache. |
Returns
True if the key exists in the cache, otherwise false.
checkURL(url) → {boolean}
Checks if the given URL has been loaded into the Cache.
This method will only work if Cache.autoResolveURL was set to true
before any preloading took place.
The method will make a DOM src call to the URL given, so please be aware of this for certain file types, such as Sound files on Firefox
which may cause double-load instances.
Parameters
Name | Type | Description |
---|---|---|
url | string | The url to check for in the cache. |
Returns
True if the url exists, otherwise false.
checkVideoKey(key) → {boolean}
Checks if the given key exists in the Video Cache.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset within the cache. |
Returns
True if the key exists in the cache, otherwise false.
checkXMLKey(key) → {boolean}
Checks if the given key exists in the XML Cache.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset within the cache. |
Returns
True if the key exists in the cache, otherwise false.
<internal> clearGLTextures()
Empties out all of the GL Textures from Images stored in the cache.
This is called automatically when the WebGL context is lost and then restored.
decodedSound(key, data)
Add a new decoded sound.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset within the cache. |
data | object | Extra sound data. |
destroy()
Clears the cache. Removes every local cache object reference.
If an object in the cache has a destroy
method it will also be called.
getBaseTexture(key, cache) → {PIXI.BaseTexture}
Gets a PIXI.BaseTexture by key from the given Cache.
Parameters
Name | Type | Argument | Default | Description |
---|---|---|---|---|
key | string | Asset key of the image for which you want the BaseTexture for. | ||
cache | integer | <optional> | Phaser.Cache.IMAGE | The cache to search for the item in. |
Returns
The BaseTexture object.
getBinary(key) → {object}
Gets a binary object from the cache.
The object is looked-up based on the key given.
Note: If the object cannot be found a console.warn
message is displayed.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset to retrieve from the cache. |
Returns
The binary data object.
getBitmapData(key) → {Phaser.BitmapData}
Gets a BitmapData object from the cache.
The object is looked-up based on the key given.
Note: If the object cannot be found a console.warn
message is displayed.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset to retrieve from the cache. |
Returns
The requested BitmapData object if found, or null if not.
getBitmapFont(key) → {Phaser.BitmapFont}
Gets a Bitmap Font object from the cache.
The object is looked-up based on the key given.
Note: If the object cannot be found a console.warn
message is displayed.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset to retrieve from the cache. |
Returns
The requested BitmapFont object if found, or null if not.
getCanvas(key) → {object}
Gets a Canvas object from the cache.
The object is looked-up based on the key given.
Note: If the object cannot be found a console.warn
message is displayed.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset to retrieve from the cache. |
Returns
The canvas object or null
if no item could be found matching the given key.
getFrame(key, cache) → {Phaser.Frame}
Get a single frame by key. You'd only do this to get the default Frame created for a non-atlas/spritesheet image.
Parameters
Name | Type | Argument | Default | Description |
---|---|---|---|---|
key | string | Asset key of the frame data to retrieve from the Cache. | ||
cache | integer | <optional> | Phaser.Cache.IMAGE | The cache to search for the item in. |
Returns
The frame data.
getFrameByIndex(key, index, cache) → {Phaser.Frame}
Get a single frame out of a frameData set by key.
Parameters
Name | Type | Argument | Default | Description |
---|---|---|---|---|
key | string | Asset key of the frame data to retrieve from the Cache. | ||
index | number | The index of the frame you want to get. | ||
cache | integer | <optional> | Phaser.Cache.IMAGE | The cache to search. One of the Cache consts such as |
Returns
The frame object.
getFrameByName(key, name, cache) → {Phaser.Frame}
Get a single frame out of a frameData set by key.
Parameters
Name | Type | Argument | Default | Description |
---|---|---|---|---|
key | string | Asset key of the frame data to retrieve from the Cache. | ||
name | string | The name of the frame you want to get. | ||
cache | integer | <optional> | Phaser.Cache.IMAGE | The cache to search. One of the Cache consts such as |
Returns
The frame object.
getFrameCount(key, cache) → {number}
Get the total number of frames contained in the FrameData object specified by the given key.
Parameters
Name | Type | Argument | Default | Description |
---|---|---|---|---|
key | string | Asset key of the FrameData you want. | ||
cache | integer | <optional> | Phaser.Cache.IMAGE | The cache to search for the item in. |
Returns
Then number of frames. 0 if the image is not found.
getFrameData(key, cache) → {Phaser.FrameData}
Gets a Phaser.FrameData object from the Image Cache.
The object is looked-up based on the key given.
Note: If the object cannot be found a console.warn
message is displayed.
Parameters
Name | Type | Argument | Default | Description |
---|---|---|---|---|
key | string | Asset key of the frame data to retrieve from the Cache. | ||
cache | integer | <optional> | Phaser.Cache.IMAGE | The cache to search for the item in. |
Returns
The frame data.
getImage(key, full) → {Image}
Gets a Image object from the cache. This returns a DOM Image object, not a Phaser.Image object.
The object is looked-up based on the key given.
Note: If the object cannot be found a console.warn
message is displayed.
Only the Image cache is searched, which covers images loaded via Loader.image, Sprite Sheets and Texture Atlases.
If you need the image used by a bitmap font or similar then please use those respective 'get' methods.
Parameters
Name | Type | Argument | Default | Description |
---|---|---|---|---|
key | string | <optional> | The key of the asset to retrieve from the cache. If not given or null it will return a default image. If given but not found in the cache it will throw a warning and return the missing image. | |
full | boolean | <optional> | false | If true the full image object will be returned, if false just the HTML Image object is returned. |
Returns
The Image object if found in the Cache, otherwise null
. If full
was true then a JavaScript object is returned.
getItem(key, cache, method, property) → {object}
Get an item from a cache based on the given key and property.
This method is mostly used internally by other Cache methods such as getImage
but is exposed
publicly for your own use as well.
Parameters
Name | Type | Argument | Description |
---|---|---|---|
key | string | The key of the asset within the cache. | |
cache | integer | The cache to search. One of the Cache consts such as | |
method | string | <optional> | The string name of the method calling getItem. Can be empty, in which case no console warning is output. |
property | string | <optional> | If you require a specific property from the cache item, specify it here. |
Returns
The cached item if found, otherwise null
. If the key is invalid and method
is set then a console.warn is output.
getJSON(key, clone) → {object}
Gets a JSON object from the cache.
The object is looked-up based on the key given.
Note: If the object cannot be found a console.warn
message is displayed.
You can either return the object by reference (the default), or return a clone
of it by setting the clone
argument to true
.
Parameters
Name | Type | Argument | Default | Description |
---|---|---|---|---|
key | string | The key of the asset to retrieve from the cache. | ||
clone | boolean | <optional> | false | Return a clone of the original object (true) or a reference to it? (false) |
Returns
The JSON object, or an Array if the key points to an Array property. If the property wasn't found, it returns null.
getKeys(cache) → {Array}
Gets all keys used in the requested Cache.
Parameters
Name | Type | Argument | Default | Description |
---|---|---|---|---|
cache | integer | <optional> | Phaser.Cache.IMAGE | The Cache you wish to get the keys from. Can be any of the Cache consts such as |
Returns
The array of keys in the requested cache.
getPhysicsData(key, object, fixtureKey) → {object}
Gets a Physics Data object from the cache.
The object is looked-up based on the key given.
Note: If the object cannot be found a console.warn
message is displayed.
You can get either the entire data set, a single object or a single fixture of an object from it.
Parameters
Name | Type | Argument | Default | Description |
---|---|---|---|---|
key | string | The key of the asset to retrieve from the cache. | ||
object | string | <optional> | null | If specified it will return just the physics object that is part of the given key, if null it will return them all. |
fixtureKey | string | Fixture key of fixture inside an object. This key can be set per fixture with the Phaser Exporter. |
Returns
The requested physics object data if found.
getRenderTexture(key) → {Object}
Gets a RenderTexture object from the cache.
The object is looked-up based on the key given.
Note: If the object cannot be found a console.warn
message is displayed.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset to retrieve from the cache. |
Returns
The object with Phaser.RenderTexture and Phaser.Frame.
getShader(key) → {string}
Gets a fragment shader object from the cache.
The object is looked-up based on the key given.
Note: If the object cannot be found a console.warn
message is displayed.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset to retrieve from the cache. |
Returns
The shader object.
getSound(key) → {Phaser.Sound}
Gets a Phaser.Sound object from the cache.
The object is looked-up based on the key given.
Note: If the object cannot be found a console.warn
message is displayed.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset to retrieve from the cache. |
Returns
The sound object.
getSoundData(key) → {object}
Gets a raw Sound data object from the cache.
The object is looked-up based on the key given.
Note: If the object cannot be found a console.warn
message is displayed.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset to retrieve from the cache. |
Returns
The sound data.
getText(key) → {object}
Gets a Text object from the cache.
The object is looked-up based on the key given.
Note: If the object cannot be found a console.warn
message is displayed.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset to retrieve from the cache. |
Returns
The text data.
getTextureFrame(key) → {Phaser.Frame}
Get a single texture frame by key.
You'd only do this to get the default Frame created for a non-atlas / spritesheet image.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset to retrieve from the cache. |
Returns
The frame data.
getTilemapData(key) → {object}
Gets a raw Tilemap data object from the cache. This will be in either CSV or JSON format.
The object is looked-up based on the key given.
Note: If the object cannot be found a console.warn
message is displayed.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset to retrieve from the cache. |
Returns
The raw tilemap data in CSV or JSON format.
getURL(url) → {object}
Get a cached object by the URL.
This only returns a value if you set Cache.autoResolveURL to true
before starting the preload of any assets.
Be aware that every call to this function makes a DOM src query, so use carefully and double-check for implications in your target browsers/devices.
Parameters
Name | Type | Description |
---|---|---|
url | string | The url for the object loaded to get from the cache. |
Returns
The cached object.
getVideo(key) → {Phaser.Video}
Gets a Phaser.Video object from the cache.
The object is looked-up based on the key given.
Note: If the object cannot be found a console.warn
message is displayed.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset to retrieve from the cache. |
Returns
The video object.
getXML(key) → {object}
Gets an XML object from the cache.
The object is looked-up based on the key given.
Note: If the object cannot be found a console.warn
message is displayed.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset to retrieve from the cache. |
Returns
The XML object.
hasFrameData(key, cache) → {boolean}
Check if the FrameData for the given key exists in the Image Cache.
Parameters
Name | Type | Argument | Default | Description |
---|---|---|---|---|
key | string | Asset key of the frame data to retrieve from the Cache. | ||
cache | integer | <optional> | Phaser.Cache.IMAGE | The cache to search for the item in. |
Returns
True if the given key has frameData in the cache, otherwise false.
isSoundDecoded(key) → {boolean}
Check if the given sound has finished decoding.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset within the cache. |
Returns
The decoded state of the Sound object.
isSoundReady(key) → {boolean}
Check if the given sound is ready for playback.
A sound is considered ready when it has finished decoding and the device is no longer touch locked.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset within the cache. |
Returns
True if the sound is decoded and the device is not touch locked.
reloadSound(key)
Reload a Sound file from the server.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset within the cache. |
reloadSoundComplete(key)
Fires the onSoundUnlock event when the sound has completed reloading.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset within the cache. |
removeBinary(key)
Removes a binary file from the cache.
Note that this only removes it from the Phaser.Cache. If you still have references to the data elsewhere
then it will persist in memory.
Parameters
Name | Type | Description |
---|---|---|
key | string | Key of the asset you want to remove. |
removeBitmapData(key)
Removes a bitmap data from the cache.
Note that this only removes it from the Phaser.Cache. If you still have references to the data elsewhere
then it will persist in memory.
Parameters
Name | Type | Description |
---|---|---|
key | string | Key of the asset you want to remove. |
removeBitmapFont(key)
Removes a bitmap font from the cache.
Note that this only removes it from the Phaser.Cache. If you still have references to the data elsewhere
then it will persist in memory.
Parameters
Name | Type | Description |
---|---|---|
key | string | Key of the asset you want to remove. |
removeCanvas(key)
Removes a canvas from the cache.
Note that this only removes it from the Phaser.Cache. If you still have references to the data elsewhere
then it will persist in memory.
Parameters
Name | Type | Description |
---|---|---|
key | string | Key of the asset you want to remove. |
removeImage(key, destroyBaseTexture)
Removes an image from the cache.
You can optionally elect to destroy it as well. This calls BaseTexture.destroy on it.
Note that this only removes it from the Phaser Cache. If you still have references to the data elsewhere
then it will persist in memory.
Parameters
Name | Type | Argument | Default | Description |
---|---|---|---|---|
key | string | Key of the asset you want to remove. | ||
destroyBaseTexture | boolean | <optional> | true | Should the BaseTexture behind this image also be destroyed? |
removeJSON(key)
Removes a json object from the cache.
Note that this only removes it from the Phaser.Cache. If you still have references to the data elsewhere
then it will persist in memory.
Parameters
Name | Type | Description |
---|---|---|
key | string | Key of the asset you want to remove. |
removePhysics(key)
Removes a physics data file from the cache.
Note that this only removes it from the Phaser.Cache. If you still have references to the data elsewhere
then it will persist in memory.
Parameters
Name | Type | Description |
---|---|---|
key | string | Key of the asset you want to remove. |
removeRenderTexture(key)
Removes a Render Texture from the cache.
Note that this only removes it from the Phaser.Cache. If you still have references to the data elsewhere
then it will persist in memory.
Parameters
Name | Type | Description |
---|---|---|
key | string | Key of the asset you want to remove. |
removeShader(key)
Removes a shader from the cache.
Note that this only removes it from the Phaser.Cache. If you still have references to the data elsewhere
then it will persist in memory.
Parameters
Name | Type | Description |
---|---|---|
key | string | Key of the asset you want to remove. |
removeSound(key)
Removes a sound from the cache.
If any Phaser.Sound
objects use the audio file in the cache that you remove with this method, they will
automatically destroy themselves. If you wish to have full control over when Sounds are destroyed then
you must finish your house-keeping and destroy them all yourself first, before calling this method.
Note that this only removes it from the Phaser.Cache. If you still have references to the data elsewhere
then it will persist in memory.
Parameters
Name | Type | Description |
---|---|---|
key | string | Key of the asset you want to remove. |
removeSpriteSheet(key)
Removes a Sprite Sheet from the cache.
Note that this only removes it from the Phaser.Cache. If you still have references to the data elsewhere
then it will persist in memory.
Parameters
Name | Type | Description |
---|---|---|
key | string | Key of the asset you want to remove. |
removeText(key)
Removes a text file from the cache.
Note that this only removes it from the Phaser.Cache. If you still have references to the data elsewhere
then it will persist in memory.
Parameters
Name | Type | Description |
---|---|---|
key | string | Key of the asset you want to remove. |
removeTextureAtlas(key)
Removes a Texture Atlas from the cache.
Note that this only removes it from the Phaser.Cache. If you still have references to the data elsewhere
then it will persist in memory.
Parameters
Name | Type | Description |
---|---|---|
key | string | Key of the asset you want to remove. |
removeTilemap(key)
Removes a tilemap from the cache.
Note that this only removes it from the Phaser.Cache. If you still have references to the data elsewhere
then it will persist in memory.
Parameters
Name | Type | Description |
---|---|---|
key | string | Key of the asset you want to remove. |
removeVideo(key)
Removes a video from the cache.
Note that this only removes it from the Phaser.Cache. If you still have references to the data elsewhere
then it will persist in memory.
Parameters
Name | Type | Description |
---|---|---|
key | string | Key of the asset you want to remove. |
removeXML(key)
Removes a xml object from the cache.
Note that this only removes it from the Phaser.Cache. If you still have references to the data elsewhere
then it will persist in memory.
Parameters
Name | Type | Description |
---|---|---|
key | string | Key of the asset you want to remove. |
updateFrameData(key, frameData, cache)
Replaces a set of frameData with a new Phaser.FrameData object.
Parameters
Name | Type | Argument | Default | Description |
---|---|---|---|---|
key | string | The unique key by which you will reference this object. | ||
frameData | number | The new FrameData. | ||
cache | integer | <optional> | Phaser.Cache.IMAGE | The cache to search. One of the Cache consts such as |
updateSound(key)
Updates the sound object in the cache.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key of the asset within the cache. |
© 2016 Richard Davey, Photon Storm Ltd.
Licensed under the MIT License.
http://phaser.io/docs/2.6.2/Phaser.Cache.html