Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-12-19 09:34:02 +00:00
Code Issues Projects Releases Packages Wiki Activity
phaser/docs/Phaser.Cache.html
photonstorm e33455e34f 2.3.0 API Docs
2015-03-26 02:55:18 +00:00

12714 lines
No EOL
174 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Phaser Class: Cache</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/default.css">
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
<div style="position: absolute; width: 143px; height: 31px; right: 10px; top: 10px; z-index: 1050"><a href="http://phaser.io"><img src="img/phaser.png" border="0" /></a></div>
<div class="navbar-inner">
<a class="brand" href="index.html">Phaser API</a>
<ul class="nav">
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-0">
<a href="Phaser.html">Phaser</a>
</li>
<li class="class-depth-0">
<a href="PIXI.html">PIXI</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-0">
<a href="Matrix.html">Matrix</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Animation.html">Animation</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AnimationManager.html">AnimationManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AnimationParser.html">AnimationParser</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ArraySet.html">ArraySet</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ArrayUtils.html">ArrayUtils</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Button.html">Button</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Cache.html">Cache</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Camera.html">Camera</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Canvas.html">Canvas</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Circle.html">Circle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Color.html">Color</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Angle.html">Angle</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Animation.html">Animation</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.AutoCull.html">AutoCull</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Bounds.html">Bounds</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.BringToTop.html">BringToTop</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Core.html">Core</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Crop.html">Crop</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Delta.html">Delta</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Destroy.html">Destroy</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.FixedToCamera.html">FixedToCamera</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Health.html">Health</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.InCamera.html">InCamera</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.InputEnabled.html">InputEnabled</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.InWorld.html">InWorld</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.LifeSpan.html">LifeSpan</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.LoadTexture.html">LoadTexture</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Overlap.html">Overlap</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.PhysicsBody.html">PhysicsBody</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Reset.html">Reset</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.ScaleMinMax.html">ScaleMinMax</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Smoothed.html">Smoothed</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Device.html">Device</a>
</li>
<li class="class-depth-1">
<a href="Phaser.DOM.html">DOM</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Easing.html">Easing</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Back.html">Back</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Bounce.html">Bounce</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Circular.html">Circular</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Cubic.html">Cubic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Elastic.html">Elastic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Exponential.html">Exponential</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Linear.html">Linear</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quadratic.html">Quadratic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quartic.html">Quartic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quintic.html">Quintic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Ellipse.html">Ellipse</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Events.html">Events</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Filter.html">Filter</a>
</li>
<li class="class-depth-1">
<a href="Phaser.FlexGrid.html">FlexGrid</a>
</li>
<li class="class-depth-1">
<a href="Phaser.FlexLayer.html">FlexLayer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Frame.html">Frame</a>
</li>
<li class="class-depth-1">
<a href="Phaser.FrameData.html">FrameData</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Game.html">Game</a>
</li>
<li class="class-depth-1">
<a href="Phaser.GameObjectCreator.html">GameObjectCreator</a>
</li>
<li class="class-depth-1">
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Gamepad.html">Gamepad</a>
</li>
<li class="class-depth-1">
<a href="Phaser.GamepadButton.html">GamepadButton</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Graphics.html">Graphics</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Group.html">Group</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Image.html">Image</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Input.html">Input</a>
</li>
<li class="class-depth-1">
<a href="Phaser.InputHandler.html">InputHandler</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Key.html">Key</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Keyboard.html">Keyboard</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Line.html">Line</a>
</li>
<li class="class-depth-1">
<a href="Phaser.LinkedList.html">LinkedList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Loader.html">Loader</a>
</li>
<li class="class-depth-1">
<a href="Phaser.LoaderParser.html">LoaderParser</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Math.html">Math</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Mouse.html">Mouse</a>
</li>
<li class="class-depth-1">
<a href="Phaser.MSPointer.html">MSPointer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Net.html">Net</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Particle.html">Particle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Physics.html">Physics</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Physics.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Arcade.Body.html">Body</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Arcade.html#TilemapCollision">TilemapCollision</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Physics.Ninja.html">Ninja</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.AABB.html">AABB</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Body.html">Body</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Circle.html">Circle</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Tile.html">Tile</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Physics.P2.html">P2</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Body.html">Body</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.BodyDebug.html">BodyDebug</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.DistanceConstraint.html">DistanceConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.FixtureList.html">FixtureList</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.GearConstraint.html">GearConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.InversePointProxy.html">InversePointProxy</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.LockConstraint.html">LockConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Material.html">Material</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PointProxy.html">PointProxy</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PrismaticConstraint.html">PrismaticConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RevoluteConstraint.html">RevoluteConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RotationalSpring.html">RotationalSpring</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Spring.html">Spring</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Plugin.html">Plugin</a>
</li>
<li class="class-depth-1">
<a href="Phaser.PluginManager.html">PluginManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Point.html">Point</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Pointer.html">Pointer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Polygon.html">Polygon</a>
</li>
<li class="class-depth-1">
<a href="Phaser.QuadTree.html">QuadTree</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Rectangle.html">Rectangle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RenderTexture.html">RenderTexture</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RetroFont.html">RetroFont</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Rope.html">Rope</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ScaleManager.html">ScaleManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Signal.html">Signal</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SignalBinding.html">SignalBinding</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SinglePad.html">SinglePad</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Sound.html">Sound</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SoundManager.html">SoundManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Sprite.html">Sprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SpriteBatch.html">SpriteBatch</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Stage.html">Stage</a>
</li>
<li class="class-depth-1">
<a href="Phaser.State.html">State</a>
</li>
<li class="class-depth-1">
<a href="Phaser.StateManager.html">StateManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Text.html">Text</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tile.html">Tile</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tilemap.html">Tilemap</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TilemapParser.html">TilemapParser</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tileset.html">Tileset</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Time.html">Time</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Timer.html">Timer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TimerEvent.html">TimerEvent</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Touch.html">Touch</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tween.html">Tween</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TweenData.html">TweenData</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TweenManager.html">TweenManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Utils.html">Utils</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Utils.Debug.html">Debug</a>
</li>
<li class="class-depth-1">
<a href="Phaser.World.html">World</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AbstractFilter.html">AbstractFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BaseTexture.html">BaseTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BitmapText.html">BitmapText</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasBuffer.html">CanvasBuffer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasGraphics.html">CanvasGraphics</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasMaskManager.html">CanvasMaskManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasRenderer.html">CanvasRenderer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasTinter.html">CanvasTinter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ComplexPrimitiveShader.html">ComplexPrimitiveShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DisplayObject.html">DisplayObject</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DisplayObjectContainer.html">DisplayObjectContainer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Event.html">Event</a>
</li>
<li class="class-depth-1">
<a href="PIXI.EventTarget.html">EventTarget</a>
</li>
<li class="class-depth-1">
<a href="PIXI.FilterTexture.html">FilterTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Graphics.html">Graphics</a>
</li>
<li class="class-depth-1">
<a href="PIXI.GraphicsData.html">GraphicsData</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PIXI.html">PIXI</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PixiFastShader.html">PixiFastShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PixiShader.html">PixiShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PolyK.html">PolyK</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PrimitiveShader.html">PrimitiveShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.RenderTexture.html">RenderTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Rope.html">Rope</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Sprite.html">Sprite</a>
</li>
<li class="class-depth-1">
<a href="PIXI.SpriteBatch.html">SpriteBatch</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Stage.html">Stage</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Strip.html">Strip</a>
</li>
<li class="class-depth-1">
<a href="PIXI.StripShader.html">StripShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Text.html">Text</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Texture.html">Texture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.TilingSprite.html">TilingSprite</a>
</li>
<li class="class-depth-1">
<a href="PIXI.VideoTexture.html">VideoTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLBlendModeManager.html">WebGLBlendModeManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLFastSpriteBatch.html">WebGLFastSpriteBatch</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLFilterManager.html">WebGLFilterManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLRenderer.html">WebGLRenderer</a>
</li>
<li class="class-depth-0">
<a href="RoundedRectangle.html">RoundedRectangle</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-0">
<a href="global.html#append">append</a>
</li>
<li class="class-depth-0">
<a href="global.html#apply">apply</a>
</li>
<li class="class-depth-0">
<a href="global.html#applyInverse">applyInverse</a>
</li>
<li class="class-depth-0">
<a href="global.html#blendModes">blendModes</a>
</li>
<li class="class-depth-0">
<a href="global.html#clone">clone</a>
</li>
<li class="class-depth-0">
<a href="global.html#contains">contains</a>
</li>
<li class="class-depth-0">
<a href="global.html#fromArray">fromArray</a>
</li>
<li class="class-depth-0">
<a href="global.html#identity">identity</a>
</li>
<li class="class-depth-0">
<a href="global.html#rotate">rotate</a>
</li>
<li class="class-depth-0">
<a href="global.html#scale">scale</a>
</li>
<li class="class-depth-0">
<a href="global.html#scaleModes">scaleModes</a>
</li>
<li class="class-depth-0">
<a href="global.html#sort">sort</a>
</li>
<li class="class-depth-0">
<a href="global.html#toArray">toArray</a>
</li>
<li class="class-depth-0">
<a href="global.html#translate">translate</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Core<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.Game.html">Game</a></li>
<li class="class-depth-1"><a href="Phaser.Group.html">Group</a></li>
<li class="class-depth-1"><a href="Phaser.World.html">World</a></li>
<li class="class-depth-1"><a href="Phaser.Loader.html">Loader</a></li>
<li class="class-depth-1"><a href="Phaser.Time.html">Time</a></li>
<li class="class-depth-1"><a href="Phaser.Camera.html">Camera</a></li>
<li class="class-depth-1"><a href="Phaser.StateManager.html">State Manager</a></li>
<li class="class-depth-1"><a href="Phaser.TweenManager.html">Tween Manager</a></li>
<li class="class-depth-1"><a href="Phaser.SoundManager.html">Sound Manager</a></li>
<li class="class-depth-1"><a href="Phaser.Input.html">Input Manager</a></li>
<li class="class-depth-1"><a href="Phaser.ScaleManager.html">Scale Manager</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Game Objects<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.GameObjectFactory.html">Factory (game.add)</a></li>
<li class="class-depth-1"><a href="Phaser.GameObjectCreator.html">Creator (game.make)</a></li>
<li class="class-depth-1"><a href="Phaser.Sprite.html">Sprite</a></li>
<li class="class-depth-1"><a href="Phaser.Image.html">Image</a></li>
<li class="class-depth-1"><a href="Phaser.Sound.html">Sound</a></li>
<li class="class-depth-1"><a href="Phaser.Particles.Arcade.Emitter.html">Particle Emitter</a></li>
<li class="class-depth-1"><a href="Phaser.Particle.html">Particle</a></li>
<li class="class-depth-1"><a href="Phaser.Text.html">Text</a></li>
<li class="class-depth-1"><a href="Phaser.Tween.html">Tween</a></li>
<li class="class-depth-1"><a href="Phaser.BitmapText.html">BitmapText</a></li>
<li class="class-depth-1"><a href="Phaser.Tilemap.html">Tilemap</a></li>
<li class="class-depth-1"><a href="Phaser.BitmapData.html">BitmapData</a></li>
<li class="class-depth-1"><a href="Phaser.RetroFont.html">RetroFont</a></li>
<li class="class-depth-1"><a href="Phaser.Button.html">Button</a></li>
<li class="class-depth-1"><a href="Phaser.Animation.html">Animation</a></li>
<li class="class-depth-1"><a href="Phaser.Graphics.html">Graphics</a></li>
<li class="class-depth-1"><a href="Phaser.RenderTexture.html">RenderTexture</a></li>
<li class="class-depth-1"><a href="Phaser.TileSprite.html">TileSprite</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Geometry<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.Circle.html">Circle</a></li>
<li class="class-depth-1"><a href="Phaser.Rectangle.html">Rectangle</a></li>
<li class="class-depth-1"><a href="Phaser.Point.html">Point</a></li>
<li class="class-depth-1"><a href="Phaser.Line.html">Line</a></li>
<li class="class-depth-1"><a href="Phaser.Ellipse.html">Ellipse</a></li>
<li class="class-depth-1"><a href="Phaser.Polygon.html">Polygon</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Physics<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.Physics.Arcade.html">Arcade Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.Arcade.Body.html">Body</a></li>
<li class="class-depth-1"><a href="Phaser.Physics.P2.html">P2 Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.Body.html">Body</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.Spring.html">Spring</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a></li>
<li class="class-depth-1"><a href="Phaser.Physics.Ninja.html">Ninja Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.Body.html">Body</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Input<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.InputHandler.html">Input Handler</a></li>
<li class="class-depth-1"><a href="Phaser.Pointer.html">Pointer</a></li>
<li class="class-depth-1"><a href="Phaser.Mouse.html">Mouse</a></li>
<li class="class-depth-1"><a href="Phaser.Keyboard.html">Keyboard</a></li>
<li class="class-depth-1"><a href="Phaser.Key.html">Key</a></li>
<li class="class-depth-1"><a href="Phaser.Gamepad.html">Gamepad</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Community<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="http://phaser.io">Phaser Web Site</a></li>
<li class="class-depth-1"><a href="https://github.com/photonstorm/phaser">Phaser Github</a></li>
<li class="class-depth-1"><a href="http://phaser.io/examples">Phaser Examples</a></li>
<li class="class-depth-1"><a href="https://github.com/photonstorm/phaser-plugins">Phaser Plugins</a></li>
<li class="class-depth-1"><a href="http://www.html5gamedevs.com/forum/14-phaser/">Forum</a></li>
<li class="class-depth-1"><a href="http://stackoverflow.com/questions/tagged/phaser-framework">Stack Overflow</a></li>
<li class="class-depth-1"><a href="http://phaser.io/learn">Weekly Coding Tips</a></li>
<li class="class-depth-1"><a href="https://confirmsubscription.com/h/r/369DE48E3E86AF1E">Newsletter</a></li>
<li class="class-depth-1"><a href="http://phaser.io/community/twitter">Twitter</a></li>
<li class="class-depth-1"><a href="http://phaser.io/community/irc">IRC</a></li>
<li class="class-depth-1"><a href="https://www.gittip.com/photonstorm/">Donate to the project</a></li>
<li class="class-depth-1"><a href="https://www.codeandweb.com/texturepacker/phaser">Texture Packer</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span8">
<div id="main">
<!--<h1 class="page-title">Class: Cache</h1>-->
<section>
<header>
<h2>
<span class="ancestors"><a href="Phaser.html">Phaser</a>.</span>
Cache
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name "
id="Cache"><span class="type-signature"></span>new Cache<span class="signature">(game)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>A game only has one instance of a Cache and it is used to store all externally loaded assets such as images, sounds
and data files as a result of Loader calls. Cached items use string based keys for look-up.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>game</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span>
</td>
<td class="description last"><p>A reference to the currently running game.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-15">line 15</a>
</dt>
</dl>
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name "
id="BINARY"><span class="type-signature">&lt;static, constant> </span>BINARY<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-192">line 192</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="BITMAPDATA"><span class="type-signature">&lt;static, constant> </span>BITMAPDATA<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-198">line 198</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="BITMAPFONT"><span class="type-signature">&lt;static, constant> </span>BITMAPFONT<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-204">line 204</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="CANVAS"><span class="type-signature">&lt;static, constant> </span>CANVAS<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-150">line 150</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="IMAGE"><span class="type-signature">&lt;static, constant> </span>IMAGE<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-156">line 156</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="JSON"><span class="type-signature">&lt;static, constant> </span>JSON<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-210">line 210</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="PHYSICS"><span class="type-signature">&lt;static, constant> </span>PHYSICS<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-180">line 180</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="SOUND"><span class="type-signature">&lt;static, constant> </span>SOUND<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-168">line 168</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="TEXT"><span class="type-signature">&lt;static, constant> </span>TEXT<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-174">line 174</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="TEXTURE"><span class="type-signature">&lt;static, constant> </span>TEXTURE<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-162">line 162</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="TILEMAP"><span class="type-signature">&lt;static, constant> </span>TILEMAP<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-186">line 186</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="XML"><span class="type-signature">&lt;static, constant> </span>XML<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-216">line 216</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="autoResolveURL"><span class="type-signature"></span>autoResolveURL<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>Automatically resolve resource URLs to absolute paths for use with the Cache.getURL method.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-25">line 25</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="game"><span class="type-signature"></span>game<span class="type-signature"> :<a href="Phaser.Game.html">Phaser.Game</a></span></h4>
</dt>
<dd>
<div class="description">
<p>Local reference to game.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-20">line 20</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="onSoundUnlock"><span class="type-signature"></span>onSoundUnlock<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4>
</dt>
<dd>
<div class="description">
<p>This event is dispatched when the sound system is unlocked via a touch event on cellular devices.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-123">line 123</a>
</dt>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name "
id="addBinary"><span class="type-signature"></span>addBinary<span class="signature">(key, binaryData)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Add a binary object in to the cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key for this binary data.</p></td>
</tr>
<tr>
<td class="name"><code>binaryData</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The binary object to be addded to the cache.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-234">line 234</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="addBitmapData"><span class="type-signature"></span>addBitmapData<span class="signature">(key, bitmapData, <span class="optional">frameData</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.BitmapData.html">Phaser.BitmapData</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Add a BitmapData object to the cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Asset key for this BitmapData.</p></td>
</tr>
<tr>
<td class="name"><code>bitmapData</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.BitmapData.html">Phaser.BitmapData</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The BitmapData object to be addded to the cache.</p></td>
</tr>
<tr>
<td class="name"><code>frameData</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.FrameData.html">Phaser.FrameData</a></span>
|
<span class="param-type">null</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
(auto create)
</td>
<td class="description last"><p>Optional FrameData set associated with the given BitmapData. If not specified (or <code>undefined</code>) a new FrameData object is created containing the Bitmap's Frame. If <code>null</code> is supplied then no FrameData will be created.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.BitmapData.html">Phaser.BitmapData</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>The BitmapData object to be addded to the cache.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-247">line 247</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="addBitmapFont"><span class="type-signature"></span>addBitmapFont<span class="signature">(key, url, data, xmlData, <span class="optional">xSpacing</span>, <span class="optional">ySpacing</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Add a new Bitmap Font to the Cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The unique key by which you will reference this object.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>URL of this font xml file.</p></td>
</tr>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Extra font data.</p></td>
</tr>
<tr>
<td class="name"><code>xmlData</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Texture atlas frames data.</p></td>
</tr>
<tr>
<td class="name"><code>xSpacing</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>If you'd like to add additional horizontal spacing between the characters then set the pixel value here.</p></td>
</tr>
<tr>
<td class="name"><code>ySpacing</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>If you'd like to add additional vertical spacing between the lines then set the pixel value here.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-364">line 364</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="addCanvas"><span class="type-signature"></span>addCanvas<span class="signature">(key, canvas, context)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Add a new canvas object in to the cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key for this canvas.</p></td>
</tr>
<tr>
<td class="name"><code>canvas</code></td>
<td class="type">
<span class="param-type">HTMLCanvasElement</span>
</td>
<td class="description last"><p>Canvas DOM element.</p></td>
</tr>
<tr>
<td class="name"><code>context</code></td>
<td class="type">
<span class="param-type">CanvasRenderingContext2D</span>
</td>
<td class="description last"><p>Render context of this canvas.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-220">line 220</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="addDefaultImage"><span class="type-signature">&lt;internal> </span>addDefaultImage<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Adds a default image to be used in special cases such as WebGL Filters. Is mapped to the key __default.</p>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-407">line 407</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="addImage"><span class="type-signature"></span>addImage<span class="signature">(key, url, data)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>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.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The unique key by which you will reference this object.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>URL of this image file.</p></td>
</tr>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>Extra image data.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-497">line 497</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="addJSON"><span class="type-signature"></span>addJSON<span class="signature">(key, url, data)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Add a new json object into the cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key for the json data.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>URL of this json data file.</p></td>
</tr>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>Extra json data.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-465">line 465</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="addMissingImage"><span class="type-signature">&lt;internal> </span>addMissingImage<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Adds an image to be used when a key is wrong / missing. Is mapped to the key __missing.</p>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-428">line 428</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="addPhysicsData"><span class="type-signature"></span>addPhysicsData<span class="signature">(key, url, JSONData, format)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Add a new physics data object to the Cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The unique key by which you will reference this object.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>URL of the physics json data.</p></td>
</tr>
<tr>
<td class="name"><code>JSONData</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The physics data object (a JSON file).</p></td>
</tr>
<tr>
<td class="name"><code>format</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The format of the physics data.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-390">line 390</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="addRenderTexture"><span class="type-signature"></span>addRenderTexture<span class="signature">(key, texture)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Add a new Phaser.RenderTexture in to the cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The unique key by which you will reference this object.</p></td>
</tr>
<tr>
<td class="name"><code>texture</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.RenderTexture.html">Phaser.RenderTexture</a></span>
</td>
<td class="description last"><p>The texture to use as the base of the RenderTexture.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-272">line 272</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="addSound"><span class="type-signature"></span>addSound<span class="signature">(key, url, data, webAudio, audioTag)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Adds a Sound file into the Cache. The file must have already been loaded, typically via Phaser.Loader.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key for the sound.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>URL of this sound file.</p></td>
</tr>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>Extra sound data.</p></td>
</tr>
<tr>
<td class="name"><code>webAudio</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>True if the file is using web audio.</p></td>
</tr>
<tr>
<td class="name"><code>audioTag</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>True if the file is using legacy HTML audio.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-526">line 526</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="addSpriteSheet"><span class="type-signature"></span>addSpriteSheet<span class="signature">(key, url, data, frameWidth, frameHeight, <span class="optional">frameMax</span>, <span class="optional">margin</span>, <span class="optional">spacing</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Add a new sprite sheet in to the cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The unique key by which you will reference this object.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>URL of this sprite sheet file.</p></td>
</tr>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Extra sprite sheet data.</p></td>
</tr>
<tr>
<td class="name"><code>frameWidth</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Width of the sprite sheet.</p></td>
</tr>
<tr>
<td class="name"><code>frameHeight</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Height of the sprite sheet.</p></td>
</tr>
<tr>
<td class="name"><code>frameMax</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
-1
</td>
<td class="description last"><p>How many frames stored in the sprite sheet. If -1 then it divides the whole sheet evenly.</p></td>
</tr>
<tr>
<td class="name"><code>margin</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>If the frames have been drawn with a margin, specify the amount here.</p></td>
</tr>
<tr>
<td class="name"><code>spacing</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>If the frames have been drawn with spacing between them, specify the amount here.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-287">line 287</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="addText"><span class="type-signature"></span>addText<span class="signature">(key, url, data)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Add a new text data.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key for the text data.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>URL of this text data file.</p></td>
</tr>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>Extra text data.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-449">line 449</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="addTextureAtlas"><span class="type-signature"></span>addTextureAtlas<span class="signature">(key, url, data, atlasData, format)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Add a new texture atlas to the Cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The unique key by which you will reference this object.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>URL of this texture atlas file.</p></td>
</tr>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>Extra texture atlas data.</p></td>
</tr>
<tr>
<td class="name"><code>atlasData</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>Texture atlas frames data.</p></td>
</tr>
<tr>
<td class="name"><code>format</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The format of the texture atlas.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-330">line 330</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="addTilemap"><span class="type-signature"></span>addTilemap<span class="signature">(key, url, mapData, format)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Add a new tilemap to the Cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The unique key by which you will reference this object.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>URL of the tilemap image.</p></td>
</tr>
<tr>
<td class="name"><code>mapData</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The tilemap data object (either a CSV or JSON file).</p></td>
</tr>
<tr>
<td class="name"><code>format</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The format of the tilemap data.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-313">line 313</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="addXML"><span class="type-signature"></span>addXML<span class="signature">(key, url, data)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Add a new xml object into the cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key for the xml file.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>URL of this xml file.</p></td>
</tr>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>Extra text data.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-481">line 481</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="checkBinaryKey"><span class="type-signature"></span>checkBinaryKey<span class="signature">(key)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Checks if the given key exists in the Binary Cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the binary file to check is in the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">boolean</span>
-
</div>
<div class="returns-desc param-desc">
<p>True if the key exists, otherwise false.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-857">line 857</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="checkBitmapDataKey"><span class="type-signature"></span>checkBitmapDataKey<span class="signature">(key)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Checks if the given key exists in the BitmapData Cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the BitmapData to check is in the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">boolean</span>
-
</div>
<div class="returns-desc param-desc">
<p>True if the key exists, otherwise false.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-870">line 870</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="checkBitmapFontKey"><span class="type-signature"></span>checkBitmapFontKey<span class="signature">(key)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Checks if the given key exists in the BitmapFont Cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the BitmapFont to check is in the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">boolean</span>
-
</div>
<div class="returns-desc param-desc">
<p>True if the key exists, otherwise false.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-883">line 883</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="checkCanvasKey"><span class="type-signature"></span>checkCanvasKey<span class="signature">(key)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Checks if the given key exists in the Canvas Cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the canvas to check is in the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">boolean</span>
-
</div>
<div class="returns-desc param-desc">
<p>True if the key exists, otherwise false.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-766">line 766</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="checkImageKey"><span class="type-signature"></span>checkImageKey<span class="signature">(key)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Checks if the given key exists in the Image Cache. Note that this also includes Texture Atlases, Sprite Sheets and Retro Fonts.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the image to check is in the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">boolean</span>
-
</div>
<div class="returns-desc param-desc">
<p>True if the key exists, otherwise false.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-779">line 779</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="checkJSONKey"><span class="type-signature"></span>checkJSONKey<span class="signature">(key)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Checks if the given key exists in the JSON Cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the JSON file to check is in the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">boolean</span>
-
</div>
<div class="returns-desc param-desc">
<p>True if the key exists, otherwise false.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-896">line 896</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="checkKey"><span class="type-signature"></span>checkKey<span class="signature">(type, key)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Checks if a key for the given cache object type exists.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The Cache type to check against. I.e. Phaser.Cache.CANVAS, Phaser.Cache.IMAGE, Phaser.Cache.JSON, etc.</p></td>
</tr>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the image to check is in the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">boolean</span>
-
</div>
<div class="returns-desc param-desc">
<p>True if the key exists, otherwise false.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-747">line 747</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="checkPhysicsKey"><span class="type-signature"></span>checkPhysicsKey<span class="signature">(key)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Checks if the given key exists in the Physics Cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the physics data file to check is in the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">boolean</span>
-
</div>
<div class="returns-desc param-desc">
<p>True if the key exists, otherwise false.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-831">line 831</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="checkSoundKey"><span class="type-signature"></span>checkSoundKey<span class="signature">(key)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Checks if the given key exists in the Sound Cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the sound file to check is in the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">boolean</span>
-
</div>
<div class="returns-desc param-desc">
<p>True if the key exists, otherwise false.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-805">line 805</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="checkTextKey"><span class="type-signature"></span>checkTextKey<span class="signature">(key)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Checks if the given key exists in the Text Cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the text file to check is in the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">boolean</span>
-
</div>
<div class="returns-desc param-desc">
<p>True if the key exists, otherwise false.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-818">line 818</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="checkTextureKey"><span class="type-signature"></span>checkTextureKey<span class="signature">(key)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Checks if the given key exists in the Texture Cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the image to check is in the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">boolean</span>
-
</div>
<div class="returns-desc param-desc">
<p>True if the key exists, otherwise false.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-792">line 792</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="checkTilemapKey"><span class="type-signature"></span>checkTilemapKey<span class="signature">(key)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Checks if the given key exists in the Tilemap Cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the Tilemap to check is in the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">boolean</span>
-
</div>
<div class="returns-desc param-desc">
<p>True if the key exists, otherwise false.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-844">line 844</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="checkURL"><span class="type-signature"></span>checkURL<span class="signature">(url)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Checks if the given URL has been loaded into the Cache.
This method will only work if Cache.autoResolveURL was set to <code>true</code> 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.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The url to check for in the cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">boolean</span>
-
</div>
<div class="returns-desc param-desc">
<p>True if the url exists, otherwise false.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-922">line 922</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="checkXMLKey"><span class="type-signature"></span>checkXMLKey<span class="signature">(key)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Checks if the given key exists in the XML Cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the XML file to check is in the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">boolean</span>
-
</div>
<div class="returns-desc param-desc">
<p>True if the key exists, otherwise false.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-909">line 909</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="decodedSound"><span class="type-signature"></span>decodedSound<span class="signature">(key, data)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Add a new decoded sound.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key for the sound.</p></td>
</tr>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>Extra sound data.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-607">line 607</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="destroy"><span class="type-signature"></span>destroy<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Clears the cache. Removes every local cache object reference.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1583">line 1583</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getBinary"><span class="type-signature"></span>getBinary<span class="signature">(key)</span><span class="type-signature"> &rarr; {object}</span></h4>
</dt>
<dd>
<div class="description">
<p>Get binary data by key.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the binary data object to retrieve from the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">object</span>
-
</div>
<div class="returns-desc param-desc">
<p>The binary data object.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1285">line 1285</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getBitmapData"><span class="type-signature"></span>getBitmapData<span class="signature">(key)</span><span class="type-signature"> &rarr; {<a href="Phaser.BitmapData.html">Phaser.BitmapData</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Get a BitmapData object from the cache by its key.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the BitmapData object to retrieve from the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.BitmapData.html">Phaser.BitmapData</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>The requested BitmapData object if found, or null if not.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-643">line 643</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getBitmapFont"><span class="type-signature"></span>getBitmapFont<span class="signature">(key)</span><span class="type-signature"> &rarr; {Phaser.BitmapFont}</span></h4>
</dt>
<dd>
<div class="description">
<p>Get a BitmapFont object from the cache by its key.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the BitmapFont object to retrieve from the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">Phaser.BitmapFont</span>
-
</div>
<div class="returns-desc param-desc">
<p>The requested BitmapFont object if found, or null if not.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-664">line 664</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getCanvas"><span class="type-signature"></span>getCanvas<span class="signature">(key)</span><span class="type-signature"> &rarr; {object}</span></h4>
</dt>
<dd>
<div class="description">
<p>Get a canvas object from the cache by its key.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the canvas to retrieve from the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">object</span>
-
</div>
<div class="returns-desc param-desc">
<p>The canvas object.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-622">line 622</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getFrame"><span class="type-signature"></span>getFrame<span class="signature">(key)</span><span class="type-signature"> &rarr; {<a href="Phaser.Frame.html">Phaser.Frame</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Get a single frame by key. You'd only do this to get the default Frame created for a non-atlas/spritesheet image.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the frame data to retrieve from the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Frame.html">Phaser.Frame</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>The frame data.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1055">line 1055</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getFrameByIndex"><span class="type-signature"></span>getFrameByIndex<span class="signature">(key)</span><span class="type-signature"> &rarr; {<a href="Phaser.Frame.html">Phaser.Frame</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Get a single frame out of a frameData set by key.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the frame data to retrieve from the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Frame.html">Phaser.Frame</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>The frame object.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1021">line 1021</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getFrameByName"><span class="type-signature"></span>getFrameByName<span class="signature">(key)</span><span class="type-signature"> &rarr; {<a href="Phaser.Frame.html">Phaser.Frame</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Get a single frame out of a frameData set by key.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the frame data to retrieve from the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Frame.html">Phaser.Frame</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>The frame object.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1038">line 1038</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getFrameCount"><span class="type-signature"></span>getFrameCount<span class="signature">(key)</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<div class="description">
<p>Get the number of frames in this image.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the image you want.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">number</span>
-
</div>
<div class="returns-desc param-desc">
<p>Then number of frames. 0 if the image is not found.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1204">line 1204</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getFrameData"><span class="type-signature"></span>getFrameData<span class="signature">(key, <span class="optional">map</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.FrameData.html">Phaser.FrameData</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Get frame data by key.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Asset key of the frame data to retrieve from the Cache.</p></td>
</tr>
<tr>
<td class="name"><code>map</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
Phaser.Cache.IMAGE
</td>
<td class="description last"><p>The asset map to get the frameData from, for example <code>Phaser.Cache.IMAGE</code>.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.FrameData.html">Phaser.FrameData</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>The frame data.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-985">line 985</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getImage"><span class="type-signature"></span>getImage<span class="signature">(key)</span><span class="type-signature"> &rarr; {Image}</span></h4>
</dt>
<dd>
<div class="description">
<p>Gets an image by its key. Note that this returns a DOM Image object, not a Phaser object.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the image to retrieve from the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">Image</span>
-
</div>
<div class="returns-desc param-desc">
<p>The Image object if found in the Cache, otherwise <code>null</code>.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-943">line 943</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getJSON"><span class="type-signature"></span>getJSON<span class="signature">(key)</span><span class="type-signature"> &rarr; {object}</span></h4>
</dt>
<dd>
<div class="description">
<p>Get a JSON object by key from the cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the json object to retrieve from the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">object</span>
-
</div>
<div class="returns-desc param-desc">
<p>The JSON object.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1243">line 1243</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getKeys"><span class="type-signature"></span>getKeys<span class="signature">(<span class="optional">type</span>)</span><span class="type-signature"> &rarr; {Array}</span></h4>
</dt>
<dd>
<div class="description">
<p>Gets all keys used by the Cache for the given data type.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
Phaser.Cache.IMAGE
</td>
<td class="description last"><p>The type of Cache keys you wish to get. Can be Cache.CANVAS, Cache.IMAGE, Cache.SOUND, etc.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">Array</span>
-
</div>
<div class="returns-desc param-desc">
<p>The array of item keys.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1348">line 1348</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getPhysicsData"><span class="type-signature"></span>getPhysicsData<span class="signature">(key, <span class="optional">object</span>, fixtureKey)</span><span class="type-signature"> &rarr; {object}</span></h4>
</dt>
<dd>
<div class="description">
<p>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.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Asset key of the physics data object to retrieve from the Cache.</p></td>
</tr>
<tr>
<td class="name"><code>object</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>If specified it will return just the physics object that is part of the given key, if null it will return them all.</p></td>
</tr>
<tr>
<td class="name"><code>fixtureKey</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Fixture key of fixture inside an object. This key can be set per fixture with the Phaser Exporter.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">object</span>
-
</div>
<div class="returns-desc param-desc">
<p>The requested physics object data if found.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-685">line 685</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getRenderTexture"><span class="type-signature"></span>getRenderTexture<span class="signature">(key)</span><span class="type-signature"> &rarr; {<a href="Phaser.RenderTexture.html">Phaser.RenderTexture</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Get a RenderTexture by key.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the RenderTexture to retrieve from the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.RenderTexture.html">Phaser.RenderTexture</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>The RenderTexture object.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1089">line 1089</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getSound"><span class="type-signature"></span>getSound<span class="signature">(key)</span><span class="type-signature"> &rarr; {<a href="Phaser.Sound.html">Phaser.Sound</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Get sound by key.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the sound to retrieve from the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Sound.html">Phaser.Sound</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>The sound object.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1133">line 1133</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getSoundData"><span class="type-signature"></span>getSoundData<span class="signature">(key)</span><span class="type-signature"> &rarr; {object}</span></h4>
</dt>
<dd>
<div class="description">
<p>Get sound data by key.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the sound to retrieve from the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">object</span>
-
</div>
<div class="returns-desc param-desc">
<p>The sound data.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1154">line 1154</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getText"><span class="type-signature"></span>getText<span class="signature">(key)</span><span class="type-signature"> &rarr; {object}</span></h4>
</dt>
<dd>
<div class="description">
<p>Get text data by key.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the text data to retrieve from the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">object</span>
-
</div>
<div class="returns-desc param-desc">
<p>The text data.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1222">line 1222</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name toc-deprecated"
id="getTexture"><span class="type-signature"></span>getTexture<span class="signature">(key)</span><span class="type-signature"> &rarr; {<a href="Phaser.RenderTexture.html">Phaser.RenderTexture</a>}</span></h4>
</dt>
<dd>
<dt class="important deprecated-notice">
This method is <em>deprecated</em> and should not be used. It may be removed in the future.
</dt>
<div class="description">
<p>DEPRECATED: Please use Cache.getRenderTexture instead. This method will be removed in Phaser 2.2.0.</p>
<p>Get a RenderTexture by key.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the RenderTexture to retrieve from the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.RenderTexture.html">Phaser.RenderTexture</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>The RenderTexture object.</p>
</div>
</div>
<dl class="details">
<dt class="important tag-deprecated">Deprecated:</dt>
<dd class="tag-deprecated"><ul>
<li>Please use Cache.getRenderTexture instead. This method will be removed in Phaser 2.2.0.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1110">line 1110</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getTextureFrame"><span class="type-signature"></span>getTextureFrame<span class="signature">(key)</span><span class="type-signature"> &rarr; {<a href="Phaser.Frame.html">Phaser.Frame</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Get a single texture frame by key. You'd only do this to get the default Frame created for a non-atlas/spritesheet image.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the frame to retrieve from the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Frame.html">Phaser.Frame</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>The frame data.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1072">line 1072</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getTilemapData"><span class="type-signature"></span>getTilemapData<span class="signature">(key)</span><span class="type-signature"> &rarr; {object}</span></h4>
</dt>
<dd>
<div class="description">
<p>Get tilemap data by key.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the tilemap data to retrieve from the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">object</span>
-
</div>
<div class="returns-desc param-desc">
<p>The raw tilemap data in CSV or JSON format.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-964">line 964</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getURL"><span class="type-signature"></span>getURL<span class="signature">(url)</span><span class="type-signature"> &rarr; {object}</span></h4>
</dt>
<dd>
<div class="description">
<p>Get a cached object by the URL.
This only returns a value if you set Cache.autoResolveURL to <code>true</code> <em>before</em> 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.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The url for the object loaded to get from the cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">object</span>
-
</div>
<div class="returns-desc param-desc">
<p>The cached object.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1306">line 1306</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name toc-deprecated"
id="getUrl"><span class="type-signature"></span>getUrl<span class="signature">(url)</span><span class="type-signature"> &rarr; {object}</span></h4>
</dt>
<dd>
<dt class="important deprecated-notice">
This method is <em>deprecated</em> and should not be used. It may be removed in the future.
</dt>
<div class="description">
<p>DEPRECATED: Please use Cache.getURL instead.
Get a cached object by the URL.
This only returns a value if you set Cache.autoResolveURL to <code>true</code> <em>before</em> 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.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The url for the object loaded to get from the cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">object</span>
-
</div>
<div class="returns-desc param-desc">
<p>The cached object.</p>
</div>
</div>
<dl class="details">
<dt class="important tag-deprecated">Deprecated:</dt>
<dd class="tag-deprecated"><ul>
<li>Please use Cache.getURL instead.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1331">line 1331</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getXML"><span class="type-signature"></span>getXML<span class="signature">(key)</span><span class="type-signature"> &rarr; {object}</span></h4>
</dt>
<dd>
<div class="description">
<p>Get a XML object by key from the cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the XML object to retrieve from the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">object</span>
-
</div>
<div class="returns-desc param-desc">
<p>The XML object.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1264">line 1264</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="isSoundDecoded"><span class="type-signature"></span>isSoundDecoded<span class="signature">(key)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Check if the given sound has finished decoding.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the sound in the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">boolean</span>
-
</div>
<div class="returns-desc param-desc">
<p>The decoded state of the Sound object.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1175">line 1175</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="isSoundReady"><span class="type-signature"></span>isSoundReady<span class="signature">(key)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>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.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key of the sound in the Cache.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">boolean</span>
-
</div>
<div class="returns-desc param-desc">
<p>True if the sound is decoded and the device is not touch locked.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1191">line 1191</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="reloadSound"><span class="type-signature"></span>reloadSound<span class="signature">(key)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Reload a Sound file from the server.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key for the sound.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-554">line 554</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="reloadSoundComplete"><span class="type-signature"></span>reloadSoundComplete<span class="signature">(key)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Fires the onSoundUnlock event when the sound has completed reloading.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key for the sound.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-576">line 576</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="removeBinary"><span class="type-signature"></span>removeBinary<span class="signature">(key)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Removes a binary file from the cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Key of the asset you want to remove.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1519">line 1519</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="removeBitmapData"><span class="type-signature"></span>removeBitmapData<span class="signature">(key)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Removes a bitmap data from the cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Key of the asset you want to remove.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1529">line 1529</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="removeBitmapFont"><span class="type-signature"></span>removeBitmapFont<span class="signature">(key)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Removes a bitmap font from the cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Key of the asset you want to remove.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1539">line 1539</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="removeCanvas"><span class="type-signature"></span>removeCanvas<span class="signature">(key)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Removes a canvas from the cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Key of the asset you want to remove.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1429">line 1429</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="removeImage"><span class="type-signature"></span>removeImage<span class="signature">(key, <span class="optional">removeFromPixi</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Removes an image from the cache and optionally from the Pixi.BaseTextureCache as well.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Key of the asset you want to remove.</p></td>
</tr>
<tr>
<td class="name"><code>removeFromPixi</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>Should this image also be removed from the Pixi BaseTextureCache?</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1439">line 1439</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="removeJSON"><span class="type-signature"></span>removeJSON<span class="signature">(key)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Removes a json object from the cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Key of the asset you want to remove.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1479">line 1479</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="removePhysics"><span class="type-signature"></span>removePhysics<span class="signature">(key)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Removes a physics data file from the cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Key of the asset you want to remove.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1499">line 1499</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="removeSound"><span class="type-signature"></span>removeSound<span class="signature">(key)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Removes a sound from the cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Key of the asset you want to remove.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1459">line 1459</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="removeText"><span class="type-signature"></span>removeText<span class="signature">(key)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Removes a text from the cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Key of the asset you want to remove.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1469">line 1469</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="removeTilemap"><span class="type-signature"></span>removeTilemap<span class="signature">(key)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Removes a tilemap from the cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Key of the asset you want to remove.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1509">line 1509</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="removeXML"><span class="type-signature"></span>removeXML<span class="signature">(key)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Removes a xml object from the cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Key of the asset you want to remove.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1489">line 1489</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="updateFrameData"><span class="type-signature"></span>updateFrameData<span class="signature">(key, frameData)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Replaces a set of frameData with a new Phaser.FrameData object.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The unique key by which you will reference this object.</p></td>
</tr>
<tr>
<td class="name"><code>frameData</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The new FrameData.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-1005">line 1005</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="updateSound"><span class="type-signature"></span>updateSound<span class="signature">(key)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Updates the sound object in the cache.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Asset key for the sound.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Cache.js.html">loader/Cache.js</a>, <a href="src_loader_Cache.js.html#sunlight-1-line-592">line 592</a>
</dt>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
Phaser Copyright © 2012-2015 Photon Storm Ltd.
</span>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha10</a>
on Thu Mar 26 2015 02:53:49 GMT+0000 (GMT Standard Time) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>
<div class="span3">
<div id="toc"></div>
</div>
<br clear="both">
</div>
</div>
<script src="scripts/sunlight.js"></script>
<script src="scripts/sunlight.javascript.js"></script>
<script src="scripts/sunlight-plugin.doclinks.js"></script>
<script src="scripts/sunlight-plugin.linenumbers.js"></script>
<script src="scripts/sunlight-plugin.menu.js"></script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/jquery.scrollTo.js"></script>
<script src="scripts/jquery.localScroll.js"></script>
<script src="scripts/bootstrap-dropdown.js"></script>
<script src="scripts/toc.js"></script>
<script> Sunlight.highlightAll({lineNumbers:true, showMenu: true, enableDoclinks :true}); </script>
<script>
$( function () {
$( "#toc" ).toc( {
anchorName : function(i, heading, prefix) {
return $(heading).attr("id") || ( prefix + i );
},
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
</script>
</body>
</html>
Reference in a new issue View git blame Copy permalink