phaser/resources/docgen/output/Phaser.Cache.json

{"class":{"name":"Phaser.Cache","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null}],"help":"A game only has one instance of a Cache and it is used to store all externally loaded assets such as images, sounds\\nand data files as a result of Loader calls. Cached items use string based keys for look-up."},"consts":[{"name":"BINARY","type":"number","help":"","line":186},{"name":"BITMAPDATA","type":"number","help":"","line":192},{"name":"BITMAPFONT","type":"number","help":"","line":198},{"name":"CANVAS","type":"number","help":"","line":144},{"name":"IMAGE","type":"number","help":"","line":150},{"name":"JSON","type":"number","help":"","line":204},{"name":"PHYSICS","type":"number","help":"","line":174},{"name":"SOUND","type":"number","help":"","line":162},{"name":"TEXT","type":"number","help":"","line":168},{"name":"TEXTURE","type":"number","help":"","line":156},{"name":"TILEMAP","type":"number","help":"","line":180},{"name":"XML","type":"number","help":"","line":210}],"methods":{"public":[{"name":"addBinary","static":false,"returns":null,"help":"Add a binary object in to the cache.","line":235,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key for this binary data.","optional":false,"default":null},{"name":"binaryData","type":["object"],"help":"The binary object to be addded to the cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addBitmapData","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"The BitmapData object to be addded to the cache."},"help":"Add a BitmapData object in to the cache.","line":250,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key for this BitmapData.","optional":false,"default":null},{"name":"bitmapData","type":["Phaser.BitmapData"],"help":"The BitmapData object to be addded to the cache.","optional":false,"default":null},{"name":"frameData","type":["Phaser.FrameData"],"help":"Optional FrameData set associated with the given BitmapData.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addBitmapFont","static":false,"returns":null,"help":"Add a new Bitmap Font to the Cache.","line":363,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The unique key by which you will reference this object.","optional":false,"default":null},{"name":"url","type":["string"],"help":"URL of this font xml file.","optional":false,"default":null},{"name":"data","type":["object"],"help":"Extra font data.","optional":false,"default":null},{"name":"xmlData","type":["object"],"help":"Texture atlas frames data.","optional":false,"default":null},{"name":"xSpacing","type":["number"],"help":"If you'd like to add additional horizontal spacing between the characters then set the pixel value here.","optional":true,"default":"0"},{"name":"ySpacing","type":["number"],"help":"If you'd like to add additional vertical spacing between the lines then set the pixel value here.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"addCanvas","static":false,"returns":null,"help":"Add a new canvas object in to the cache.","line":222,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key for this canvas.","optional":false,"default":null},{"name":"canvas","type":["HTMLCanvasElement"],"help":"Canvas DOM element.","optional":false,"default":null},{"name":"context","type":["CanvasRenderingContext2D"],"help":"Render context of this canvas.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addImage","static":false,"returns":null,"help":"Adds an Image file into the Cache. The file must have already been loaded, typically via Phaser.Loader.","line":491,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The unique key by which you will reference this object.","optional":false,"default":null},{"name":"url","type":["string"],"help":"URL of this image file.","optional":false,"default":null},{"name":"data","type":["object"],"help":"Extra image data.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addJSON","static":false,"returns":null,"help":"Add a new json object into the cache.","line":461,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key for the json data.","optional":false,"default":null},{"name":"url","type":["string"],"help":"URL of this json data file.","optional":false,"default":null},{"name":"data","type":["object"],"help":"Extra json data.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addRenderTexture","static":false,"returns":null,"help":"Add a new Phaser.RenderTexture in to the cache.","line":267,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The unique key by which you will reference this object.","optional":false,"default":null},{"name":"texture","type":["Phaser.RenderTexture"],"help":"The texture to use as the base of the RenderTexture.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addSound","static":false,"returns":null,"help":"Adds a Sound file into the Cache. The file must have already been loaded, typically via Phaser.Loader.","line":516,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key for the sound.","optional":false,"default":null},{"name":"url","type":["string"],"help":"URL of this sound file.","optional":false,"default":null},{"name":"data","type":["object"],"help":"Extra sound data.","optional":false,"default":null},{"name":"webAudio","type":["boolean"],"help":"True if the file is using web audio.","optional":false,"default":null},{"name":"audioTag","type":["boolean"],"help":"True if the file is using legacy HTML audio.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addSpriteSheet","static":false,"returns":null,"help":"Add a new sprite sheet in to the cache.","line":288,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The unique key by which you will reference this object.","optional":false,"default":null},{"name":"url","type":["string"],"help":"URL of this sprite sheet file.","optional":false,"default":null},{"name":"data","type":["object"],"help":"Extra sprite sheet data.","optional":false,"default":null},{"name":"frameWidth","type":["number"],"help":"Width of the sprite sheet.","optional":false,"default":null},{"name":"frameHeight","type":["number"],"help":"Height of the sprite sheet.","optional":false,"default":null},{"name":"frameMax","type":["number"],"help":"How many frames stored in the sprite sheet. If -1 then it divides the whole sheet evenly.","optional":true,"default":"-1"},{"name":"margin","type":["number"],"help":"If the frames have been drawn with a margin, specify the amount here.","optional":true,"default":"0"},{"name":"spacing","type":["number"],"help":"If the frames have been drawn with spacing between them, specify the amount here.","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"addText","static":false,"returns":null,"help":"Add a new text data.","line":445,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key for the text data.","optional":false,"default":null},{"name":"url","type":["string"],"help":"URL of this text data file.","optional":false,"default":null},{"name":"data","type":["object"],"help":"Extra text data.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addTextureAtlas","static":false,"returns":null,"help":"Add a new texture atlas to the Cache.","line":328,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The unique key by which you will reference this object.","optional":false,"default":null},{"name":"url","type":["string"],"help":"URL of this texture atlas file.","optional":false,"default":null},{"name":"data","type":["object"],"help":"Extra texture atlas data.","optional":false,"default":null},{"name":"atlasData","type":["object"],"help":"  - Texture atlas frames data.","optional":false,"default":null},{"name":"format","type":["number"],"help":"The format of the texture atlas.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addTilemap","static":false,"returns":null,"help":"Add a new physics data object to the Cache.","line":387,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The unique key by which you will reference this object.","optional":false,"default":null},{"name":"url","type":["string"],"help":"URL of the physics json data.","optional":false,"default":null},{"name":"JSONData","type":["object"],"help":"The physics data object (a JSON file).","optional":false,"default":null},{"name":"format","type":["number"],"help":"The format of the physics data.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"addXML","static":false,"returns":null,"help":"Add a new xml object into the cache.","line":477,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key for the xml file.","optional":false,"default":null},{"name":"url","type":["string"],"help":"URL of this xml file.","optional":false,"default":null},{"name":"data","type":["object"],"help":"Extra text data.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkBinaryKey","static":false,"returns":{"types":["boolean"],"help":"True if the key exists, otherwise false."},"help":"Checks if the given key exists in the Binary Cache.","line":842,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the binary file to check is in the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkBitmapDataKey","static":false,"returns":{"types":["boolean"],"help":"True if the key exists, otherwise false."},"help":"Checks if the given key exists in the BitmapData Cache.","line":855,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the BitmapData to check is in the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkBitmapFontKey","static":false,"returns":{"types":["boolean"],"help":"True if the key exists, otherwise false."},"help":"Checks if the given key exists in the BitmapFont Cache.","line":868,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the BitmapFont to check is in the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkCanvasKey","static":false,"returns":{"types":["boolean"],"help":"True if the key exists, otherwise false."},"help":"Checks if the given key exists in the Canvas Cache.","line":751,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the canvas to check is in the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkImageKey","static":false,"returns":{"types":["boolean"],"help":"True if the key exists, otherwise false."},"help":"Checks if the given key exists in the Image Cache. Note that this also includes Texture Atlases, Sprite Sheets and Retro Fonts.","line":764,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the image to check is in the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkJSONKey","static":false,"returns":{"types":["boolean"],"help":"True if the key exists, otherwise false."},"help":"Checks if the given key exists in the JSON Cache.","line":881,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the JSON file to check is in the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkKey","static":false,"returns":{"types":["boolean"],"help":"True if the key exists, otherwise false."},"help":"Checks if a key for the given cache object type exists.","line":733,"public":true,"protected":false,"private":false,"parameters":[{"name":"type","type":["number"],"help":"The Cache type to check against. I.e. Phaser.Cache.CANVAS, Phaser.Cache.IMAGE, Phaser.Cache.JSON, etc.","optional":false,"default":null},{"name":"key","type":["string"],"help":"Asset key of the image to check is in the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkPhysicsKey","static":false,"returns":{"types":["boolean"],"help":"True if the key exists, otherwise false."},"help":"Checks if the given key exists in the Physics Cache.","line":816,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the physics data file to check is in the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkSoundKey","static":false,"returns":{"types":["boolean"],"help":"True if the key exists, otherwise false."},"help":"Checks if the given key exists in the Sound Cache.","line":790,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the sound file to check is in the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkTextKey","static":false,"returns":{"types":["boolean"],"help":"True if the key exists, otherwise false."},"help":"Checks if the given key exists in the Text Cache.","line":803,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the text file to check is in the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkTextureKey","static":false,"returns":{"types":["boolean"],"help":"True if the key exists, otherwise false."},"help":"Checks if the given key exists in the Texture Cache.","line":777,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the image to check is in the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkTilemapKey","static":false,"returns":{"types":["boolean"],"help":"True if the key exists, otherwise false."},"help":"Checks if the given key exists in the Tilemap Cache.","line":829,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the Tilemap to check is in the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkUrl","static":false,"returns":{"types":["boolean"],"help":"True if the url exists, otherwise false."},"help":"Checks if the given URL has been loaded into the Cache.","line":907,"public":true,"protected":false,"private":false,"parameters":[{"name":"url","type":["string"],"help":"The url to check for in the cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkXMLKey","static":false,"returns":{"types":["boolean"],"help":"True if the key exists, otherwise false."},"help":"Checks if the given key exists in the XML Cache.","line":894,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the XML file to check is in the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"decodedSound","static":false,"returns":null,"help":"Add a new decoded sound.","line":594,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key for the sound.","optional":false,"default":null},{"name":"data","type":["object"],"help":"Extra sound data.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"destroy","static":false,"returns":null,"help":"Clears the cache. Removes every local cache object reference.","line":1497,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"getBinary","static":false,"returns":{"types":["object"],"help":"The binary data object."},"help":"Get binary data by key.","line":1237,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the binary data object to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getBitmapData","static":false,"returns":{"types":["Phaser.BitmapData"],"help":"The requested BitmapData object if found, or null if not."},"help":"Get a BitmapData object from the cache by its key.","line":629,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the BitmapData object to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getBitmapFont","static":false,"returns":{"types":["Phaser.BitmapFont"],"help":"The requested BitmapFont object if found, or null if not."},"help":"Get a BitmapFont object from the cache by its key.","line":649,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the BitmapFont object to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getCanvas","static":false,"returns":{"types":["object"],"help":"The canvas object."},"help":"Get a canvas object from the cache by its key.","line":609,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the canvas to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getFrame","static":false,"returns":{"types":["Phaser.Frame"],"help":"The frame data."},"help":"Get a single frame by key. You'd only do this to get the default Frame created for a non-atlas\/spritesheet image.","line":1036,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the frame data to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getFrameByIndex","static":false,"returns":{"types":["Phaser.Frame"],"help":"The frame object."},"help":"Get a single frame out of a frameData set by key.","line":1002,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the frame data to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getFrameByName","static":false,"returns":{"types":["Phaser.Frame"],"help":"The frame object."},"help":"Get a single frame out of a frameData set by key.","line":1019,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the frame data to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getFrameCount","static":false,"returns":{"types":["number"],"help":"Then number of frames. 0 if the image is not found."},"help":"Get the number of frames in this image.","line":1159,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the image you want.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getFrameData","static":false,"returns":{"types":["Phaser.FrameData"],"help":"The frame data."},"help":"Get frame data by key.","line":967,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the frame data to retrieve from the Cache.","optional":false,"default":null},{"name":"map","type":["string"],"help":"The asset map to get the frameData from, for example `Phaser.Cache.IMAGE`.","optional":true,"default":"Phaser.Cache.IMAGE"}],"inherited":false,"inheritedFrom":""},{"name":"getImage","static":false,"returns":{"types":["object"],"help":"The image data if found in the Cache, otherwise `null`."},"help":"Get image data by key.","line":925,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the image to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getJSON","static":false,"returns":{"types":["object"],"help":"The JSON object."},"help":"Get a JSON object by key from the cache.","line":1197,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the json object to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getKeys","static":false,"returns":{"types":["array"],"help":"The array of item keys."},"help":"Gets all keys used by the Cache for the given data type.","line":1277,"public":true,"protected":false,"private":false,"parameters":[{"name":"type","type":["number"],"help":"The type of Cache keys you wish to get. Can be Cache.CANVAS, Cache.IMAGE, Cache.SOUND, etc.","optional":true,"default":"Phaser.Cache.IMAGE"}],"inherited":false,"inheritedFrom":""},{"name":"getPhysicsData","static":false,"returns":{"types":["object"],"help":"The requested physics object data if found."},"help":"Get a physics data object from the cache by its key. You can get either the entire data set, a single object or a single fixture of an object from it.","line":671,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the physics data object to retrieve from the Cache.","optional":false,"default":null},{"name":"object","type":["string"],"help":"If specified it will return just the physics object that is part of the given key, if null it will return them all.","optional":true,"default":"null"},{"name":"fixtureKey","type":["string"],"help":"Fixture key of fixture inside an object. This key can be set per fixture with the Phaser Exporter.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getSound","static":false,"returns":{"types":["Phaser.Sound"],"help":"The sound object."},"help":"Get sound by key.","line":1090,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the sound to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getSoundData","static":false,"returns":{"types":["object"],"help":"The sound data."},"help":"Get sound data by key.","line":1110,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the sound to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getText","static":false,"returns":{"types":["object"],"help":"The text data."},"help":"Get text data by key.","line":1177,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the text data to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getTexture","static":false,"returns":{"types":["Phaser.RenderTexture"],"help":"The RenderTexture object."},"help":"Get a RenderTexture by key.","line":1070,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the RenderTexture to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getTextureFrame","static":false,"returns":{"types":["Phaser.Frame"],"help":"The frame data."},"help":"Get a single texture frame by key. You'd only do this to get the default Frame created for a non-atlas\/spritesheet image.","line":1053,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the frame to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getTilemapData","static":false,"returns":{"types":["object"],"help":"The raw tilemap data in CSV or JSON format."},"help":"Get tilemap data by key.","line":946,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the tilemap data to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getUrl","static":false,"returns":{"types":["object"],"help":"The cached object."},"help":"Get a cached object by the URL.","line":1257,"public":true,"protected":false,"private":false,"parameters":[{"name":"url","type":["string"],"help":"The url for the object loaded to get from the cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getXML","static":false,"returns":{"types":["object"],"help":"The XML object."},"help":"Get a XML object by key from the cache.","line":1217,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the XML object to retrieve from the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"isSoundDecoded","static":false,"returns":{"types":["boolean"],"help":"The decoded state of the Sound object."},"help":"Check if the given sound has finished decoding.","line":1130,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the sound in the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"isSoundReady","static":false,"returns":{"types":["boolean"],"help":"True if the sound is decoded and the device is not touch locked."},"help":"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.","line":1146,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key of the sound in the Cache.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"reloadSound","static":false,"returns":null,"help":"Reload a Sound file from the server.","line":540,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key for the sound.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"reloadSoundComplete","static":false,"returns":null,"help":"Fires the onSoundUnlock event when the sound has completed reloading.","line":562,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key for the sound.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeBinary","static":false,"returns":null,"help":"Removes a binary file from the cache.","line":1447,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Key of the asset you want to remove.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeBitmapData","static":false,"returns":null,"help":"Removes a bitmap data from the cache.","line":1457,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Key of the asset you want to remove.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeBitmapFont","static":false,"returns":null,"help":"Removes a bitmap font from the cache.","line":1467,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Key of the asset you want to remove.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeCanvas","static":false,"returns":null,"help":"Removes a canvas from the cache.","line":1357,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Key of the asset you want to remove.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeImage","static":false,"returns":null,"help":"Removes an image from the cache and optionally from the Pixi.BaseTextureCache as well.","line":1368,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Key of the asset you want to remove.","optional":false,"default":null},{"name":"removeFromPixi","type":["boolean"],"help":"Should this image also be removed from the Pixi BaseTextureCache?","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"removeJSON","static":false,"returns":null,"help":"Removes a json object from the cache.","line":1407,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Key of the asset you want to remove.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removePhysics","static":false,"returns":null,"help":"Removes a physics data file from the cache.","line":1427,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Key of the asset you want to remove.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeSound","static":false,"returns":null,"help":"Removes a sound from the cache.","line":1387,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Key of the asset you want to remove.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeText","static":false,"returns":null,"help":"Removes a text from the cache.","line":1397,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Key of the asset you want to remove.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeTilemap","static":false,"returns":null,"help":"Removes a tilemap from the cache.","line":1437,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Key of the asset you want to remove.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeXML","static":false,"returns":null,"help":"Removes a xml object from the cache.","line":1417,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Key of the asset you want to remove.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"updateFrameData","static":false,"returns":null,"help":"Replaces a set of frameData with a new Phaser.FrameData object.","line":986,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"The unique key by which you will reference this object.","optional":false,"default":null},{"name":"frameData","type":["number"],"help":"The new FrameData.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"updateSound","static":false,"returns":null,"help":"Updates the sound object in the cache.","line":578,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["string"],"help":"Asset key for the sound.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[{"name":"addDefaultImage","static":false,"returns":null,"help":"Adds a default image to be used in special cases such as WebGL Filters. Is mapped to the key __default.","line":401,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"addMissingImage","static":false,"returns":null,"help":"Adds an image to be used when a key is wrong \/ missing. Is mapped to the key __missing.","line":422,"public":false,"protected":true,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"private":[{"name":"_resolveUrl","static":false,"returns":{"types":["string"],"help":"The resolved URL."},"help":"Resolves a URL to its absolute form.","line":1479,"public":false,"protected":false,"private":true,"parameters":[{"name":"url","type":["string"],"help":"The URL to resolve.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"_cacheMap","type":["array"],"help":"","inlineHelp":"Const to cache object look-up array.","line":123,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"Local reference to game.","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"onSoundUnlock","type":["Phaser.Signal"],"help":"","inlineHelp":"This event is dispatched when the sound system is unlocked via a touch event on cellular devices.","line":118,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_binary","type":["object"],"help":"","inlineHelp":"Binary file key-value container.","line":80,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_bitmapDatas","type":["object"],"help":"","inlineHelp":"BitmapData key-value container.","line":86,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_bitmapFont","type":["object"],"help":"","inlineHelp":"BitmapFont key-value container.","line":92,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_canvases","type":["object"],"help":"","inlineHelp":"Canvas key-value container.","line":26,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_images","type":["object"],"help":"","inlineHelp":"Image key-value container.","line":32,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_json","type":["object"],"help":"","inlineHelp":"JSOIN key-value container.","line":56,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_physics","type":["object"],"help":"","inlineHelp":"Physics data key-value container.","line":68,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_sounds","type":["object"],"help":"","inlineHelp":"Sound key-value container.","line":44,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_text","type":["object"],"help":"","inlineHelp":"Text key-value container.","line":50,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_textures","type":["object"],"help":"","inlineHelp":"RenderTexture key-value container.","line":38,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_tilemaps","type":["object"],"help":"","inlineHelp":"Tilemap key-value container.","line":74,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_urlMap","type":["object"],"help":"","inlineHelp":"Maps URLs to resources.","line":98,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_urlResolver","type":["Image"],"help":"","inlineHelp":"Used to resolve URLs to the absolute path.","line":104,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_urlTemp","type":["string"],"help":"","inlineHelp":"Temporary variable to hold a resolved url.","line":110,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_xml","type":["object"],"help":"","inlineHelp":"XML key-value container.","line":62,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}}