Cache#onSoundUnlock

onSoundUnlock : Phaser.Signal This event is dispatched when the sound system is unlocked via a touch event on cellular devices. Source code: loader/Cache.js (Line 91)

Cache#isSoundReady()

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 boolean - True if the sound is decoded and the device is not touch locked. Source code: loader/Cache.js (Line 761)

Cache#isSoundDecoded()

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 boolean - The decoded state of the Sound object. Source code: loader/Cache.js (Line 743)

Cache#hasFrameData()

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 boolean - True if the given key has frameData in the cache, otherwise false. Source code: loader/Cache.js (Line 1501)

Cache#getXML()

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 object - The XML object. Source code: loader/Cache.js (Line 1354)

Cache#getVideo()

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 Phaser.Video - The video object. Source code: loader/Cache.js (Line 1371)

Cache#getURL()

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 object - The cached object. Source code: loader/Cache.js (Line 1584)

Cache#getTilemapData()

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 object - The raw tilemap data in CSV or JSON format. Source code: loader/Cache.js (Line 1249)

Cache#getTextureFrame()

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 Phaser.Frame - The frame data. Source code: loader/Cache.js (Line 1121)

Cache#getText()

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 object - The text data. Source code: loader/Cache.js (Line 1170)