2013-10-02 14:05:55 +00:00
<!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/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 class = "navbar-inner" >
< a class = "brand" href = "index.html" > Phaser< / a >
< ul class = "nav" >
< li class = "dropdown" >
2013-10-03 01:38:35 +00:00
< a href = "namespaces.list.html" class = "dropdown-toggle" data-toggle = "dropdown" > Namespaces< b
2013-10-02 14:05:55 +00:00
class="caret">< / b > < / a >
< ul class = "dropdown-menu " >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-0" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.html" > Phaser< / a >
2013-10-02 14:05:55 +00:00
< / 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 " >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 14:05:55 +00:00
< a href = "Phaser.Animation.html" > Animation< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.AnimationManager.html" > AnimationManager< / a >
2013-10-02 14:05:55 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.AnimationParser.html" > AnimationParser< / a >
2013-10-02 14:05:55 +00:00
< / li >
2014-04-29 14:39:02 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.ArrayList.html" > ArrayList< / a >
< / li >
2014-10-09 15:12:53 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.AudioSprite.html" > AudioSprite< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.BitmapData.html" > BitmapData< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.BitmapText.html" > BitmapText< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Button.html" > Button< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Cache.html" > Cache< / a >
2013-10-02 14:05:55 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Camera.html" > Camera< / a >
2013-10-02 14:05:55 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Canvas.html" > Canvas< / a >
2013-10-02 14:05:55 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Circle.html" > Circle< / a >
2013-10-02 14:05:55 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Color.html" > Color< / a >
2013-10-03 00:21:08 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Device.html" > Device< / a >
2013-10-02 14:05:55 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.html" > Easing< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Back.html" > Back< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Bounce.html" > Bounce< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Circular.html" > Circular< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Cubic.html" > Cubic< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Elastic.html" > Elastic< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Exponential.html" > Exponential< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Linear.html" > Linear< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Quadratic.html" > Quadratic< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Quartic.html" > Quartic< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Quintic.html" > Quintic< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Sinusoidal.html" > Sinusoidal< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-18 03:01:51 +00:00
< a href = "Phaser.Ellipse.html" > Ellipse< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Events.html" > Events< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Filter.html" > Filter< / a >
< / li >
2014-09-09 14:36:56 +00:00
< 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 >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Frame.html" > Frame< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.FrameData.html" > FrameData< / a >
2013-10-03 00:21:08 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 14:05:55 +00:00
< a href = "Phaser.Game.html" > Game< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-21 15:37:26 +00:00
< a href = "Phaser.GameObjectCreator.html" > GameObjectCreator< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.GameObjectFactory.html" > GameObjectFactory< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-05 06:29:17 +00:00
< a href = "Phaser.Gamepad.html" > Gamepad< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-05 06:29:17 +00:00
< a href = "Phaser.GamepadButton.html" > GamepadButton< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Graphics.html" > Graphics< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 14:05:55 +00:00
< a href = "Phaser.Group.html" > Group< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-08 07:24:22 +00:00
< a href = "Phaser.Image.html" > Image< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 14:05:55 +00:00
< a href = "Phaser.Input.html" > Input< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 14:05:55 +00:00
< a href = "Phaser.InputHandler.html" > InputHandler< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 14:05:55 +00:00
< a href = "Phaser.Key.html" > Key< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 14:05:55 +00:00
< a href = "Phaser.Keyboard.html" > Keyboard< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-05 06:29:17 +00:00
< a href = "Phaser.Line.html" > Line< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 14:05:55 +00:00
< a href = "Phaser.LinkedList.html" > LinkedList< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 14:05:55 +00:00
< a href = "Phaser.Loader.html" > Loader< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.LoaderParser.html" > LoaderParser< / a >
2013-10-02 14:05:55 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 14:05:55 +00:00
< a href = "Phaser.Math.html" > Math< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 14:05:55 +00:00
< a href = "Phaser.Mouse.html" > Mouse< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 14:05:55 +00:00
< a href = "Phaser.MSPointer.html" > MSPointer< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 19:18:24 +00:00
< a href = "Phaser.Net.html" > Net< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.Particle.html" > Particle< / a >
< / li >
< li class = "class-depth-1" >
2013-10-02 19:18:24 +00:00
< a href = "Phaser.Particles.html" > Particles< / a >
< / li >
2014-10-09 15:12:53 +00:00
< li class = "class-depth-2" >
< a href = "Phaser.Particles.Arcade.html" > Arcade< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2013-10-02 19:18:24 +00:00
< a href = "Phaser.Particles.Arcade.Emitter.html" > Emitter< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Physics.html" > Physics< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Physics.Arcade.html" > Arcade< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Arcade.Body.html" > Body< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Ninja.html" > Ninja< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Ninja.AABB.html" > AABB< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Ninja.Body.html" > Body< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Ninja.Circle.html" > Circle< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Ninja.Tile.html" > Tile< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.html" > P2< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.Body.html" > Body< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.BodyDebug.html" > BodyDebug< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.CollisionGroup.html" > CollisionGroup< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.ContactMaterial.html" > ContactMaterial< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.DistanceConstraint.html" > DistanceConstraint< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-11 12:09:28 +00:00
< li class = "class-depth-3" >
< a href = "Phaser.Physics.P2.FixtureList.html" > FixtureList< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.GearConstraint.html" > GearConstraint< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.InversePointProxy.html" > InversePointProxy< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.LockConstraint.html" > LockConstraint< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.Material.html" > Material< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.PointProxy.html" > PointProxy< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.PrismaticConstraint.html" > PrismaticConstraint< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.RevoluteConstraint.html" > RevoluteConstraint< / a >
< / li >
2014-09-09 14:36:56 +00:00
< li class = "class-depth-3" >
< a href = "Phaser.Physics.P2.RotationalSpring.html" > RotationalSpring< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.Spring.html" > Spring< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 14:05:55 +00:00
< a href = "Phaser.Plugin.html" > Plugin< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 14:05:55 +00:00
< a href = "Phaser.PluginManager.html" > PluginManager< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 14:05:55 +00:00
< a href = "Phaser.Point.html" > Point< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 14:05:55 +00:00
< a href = "Phaser.Pointer.html" > Pointer< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-07 06:10:15 +00:00
< a href = "Phaser.Polygon.html" > Polygon< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.QuadTree.html" > QuadTree< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 14:05:55 +00:00
< a href = "Phaser.RandomDataGenerator.html" > RandomDataGenerator< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 14:05:55 +00:00
< a href = "Phaser.Rectangle.html" > Rectangle< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.RenderTexture.html" > RenderTexture< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.RequestAnimationFrame.html" > RequestAnimationFrame< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.RetroFont.html" > RetroFont< / a >
< / li >
2014-09-09 14:36:56 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.Rope.html" > Rope< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.ScaleManager.html" > ScaleManager< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 14:05:55 +00:00
< a href = "Phaser.Signal.html" > Signal< / a >
< / li >
2014-04-11 12:09:28 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.SignalBinding.html" > SignalBinding< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-05 06:29:17 +00:00
< a href = "Phaser.SinglePad.html" > SinglePad< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.Sound.html" > Sound< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.SoundManager.html" > SoundManager< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Sprite.html" > Sprite< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-18 03:01:51 +00:00
< a href = "Phaser.SpriteBatch.html" > SpriteBatch< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 14:05:55 +00:00
< a href = "Phaser.Stage.html" > Stage< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 14:05:55 +00:00
< a href = "Phaser.State.html" > State< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 14:05:55 +00:00
< a href = "Phaser.StateManager.html" > StateManager< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Text.html" > Text< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Tile.html" > Tile< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Tilemap.html" > Tilemap< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.TilemapLayer.html" > TilemapLayer< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.TilemapParser.html" > TilemapParser< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Tileset.html" > Tileset< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.TileSprite.html" > TileSprite< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Time.html" > Time< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Timer.html" > Timer< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-05 06:29:17 +00:00
< a href = "Phaser.TimerEvent.html" > TimerEvent< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 14:05:55 +00:00
< a href = "Phaser.Touch.html" > Touch< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Tween.html" > Tween< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.TweenManager.html" > TweenManager< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Utils.html" > Utils< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Utils.Debug.html" > Debug< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 14:05:55 +00:00
< a href = "Phaser.World.html" > World< / a >
< / li >
< / ul >
< / li >
2014-09-09 14:36:56 +00:00
2013-10-02 14:05:55 +00:00
< / ul >
< / div >
< / div >
< div class = "row-fluid" >
< div class = "span8" >
< div id = "main" >
< h1 class = "page-title" > Class: Cache< / h1 >
< section >
< header >
< h2 >
2013-10-03 01:38:35 +00:00
< span class = "ancestors" > < a href = "Phaser.html" > Phaser< / a > .< / span >
2013-10-02 14:05:55 +00:00
Cache
< / h2 >
2014-10-09 15:12:53 +00:00
< div class = "class-description" > < p > Phaser.Cache< / p > < / div >
2013-10-02 14:05:55 +00:00
< / 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" >
2014-10-09 15:12:53 +00:00
< 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 >
2013-10-02 14:05:55 +00:00
< / 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:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-15" > line 15< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< / div >
< h3 class = "subsection-title" > Members< / h3 >
< dl >
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "BINARY" > < span class = "type-signature" > < static, constant> < / span > BINARY< span class = "type-signature" > :number< / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
2014-02-18 03:01:51 +00:00
< h5 > Type:< / h5 >
< ul >
< li >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< span class = "param-type" > number< / span >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< / li >
< / ul >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< dl class = "details" >
2013-10-02 14:05:55 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-186" > line 186< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "BITMAPDATA" > < span class = "type-signature" > < static, constant> < / span > BITMAPDATA< span class = "type-signature" > :number< / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
2014-02-18 03:01:51 +00:00
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > number< / span >
< / li >
< / ul >
2013-10-02 14:05:55 +00:00
< dl class = "details" >
2014-02-18 03:01:51 +00:00
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-192" > line 192< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< / dl >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< / dd >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< dt >
< h4 class = "name" id = "BITMAPFONT" > < span class = "type-signature" > < static, constant> < / span > BITMAPFONT< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > number< / span >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< / li >
< / ul >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< dl class = "details" >
2013-10-02 14:05:55 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-198" > line 198< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
2014-02-18 03:01:51 +00:00
2013-10-02 14:05:55 +00:00
2014-02-05 06:29:17 +00:00
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "CANVAS" > < span class = "type-signature" > < static, constant> < / span > CANVAS< span class = "type-signature" > :number< / span > < / h4 >
2014-02-05 06:29:17 +00:00
< / dt >
< dd >
2014-02-18 03:01:51 +00:00
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > number< / span >
2014-02-05 06:29:17 +00:00
2014-02-18 03:01:51 +00:00
< / li >
< / ul >
2014-02-05 06:29:17 +00:00
2014-02-18 03:01:51 +00:00
2014-02-05 06:29:17 +00:00
2014-02-18 03:01:51 +00:00
< dl class = "details" >
2014-02-05 06:29:17 +00:00
2014-02-18 03:01:51 +00:00
2014-02-05 06:29:17 +00:00
2014-02-18 03:01:51 +00:00
2014-02-05 06:29:17 +00:00
2014-02-18 03:01:51 +00:00
2014-02-05 06:29:17 +00:00
2014-02-18 03:01:51 +00:00
2014-02-05 06:29:17 +00:00
2014-02-18 03:01:51 +00:00
2014-02-05 06:29:17 +00:00
2014-02-18 03:01:51 +00:00
2014-02-05 06:29:17 +00:00
2014-02-18 03:01:51 +00:00
2014-02-05 06:29:17 +00:00
2014-02-18 03:01:51 +00:00
2014-02-05 06:29:17 +00:00
2014-02-18 03:01:51 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-144" > line 144< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
2014-02-05 06:29:17 +00:00
2014-02-18 03:01:51 +00:00
2014-02-05 06:29:17 +00:00
2014-02-18 03:01:51 +00:00
2014-02-05 06:29:17 +00:00
2014-02-18 03:01:51 +00:00
< / dl >
2014-02-05 06:29:17 +00:00
2014-02-18 03:01:51 +00:00
< / dd >
2014-02-05 06:29:17 +00:00
2014-02-18 03:01:51 +00:00
2014-02-05 06:29:17 +00:00
2014-02-18 03:01:51 +00:00
< dt >
< h4 class = "name" id = "IMAGE" > < span class = "type-signature" > < static, constant> < / span > IMAGE< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
< h5 > Type:< / h5 >
< ul >
< li >
2014-02-05 06:29:17 +00:00
2014-02-18 03:01:51 +00:00
< span class = "param-type" > number< / span >
2014-02-05 06:29:17 +00:00
2014-02-18 03:01:51 +00:00
< / li >
< / ul >
2014-02-05 06:29:17 +00:00
2014-02-18 03:01:51 +00:00
2014-02-05 06:29:17 +00:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-150" > line 150< / a >
2014-02-24 12:14:30 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "JSON" > < span class = "type-signature" > < static, constant> < / span > JSON< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > number< / span >
< / li >
< / ul >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-204" > line 204< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "PHYSICS" > < span class = "type-signature" > < static, constant> < / span > PHYSICS< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > number< / span >
< / li >
< / ul >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-174" > line 174< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "SOUND" > < span class = "type-signature" > < static, constant> < / span > SOUND< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > number< / span >
< / li >
< / ul >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-162" > line 162< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "TEXT" > < span class = "type-signature" > < static, constant> < / span > TEXT< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > number< / span >
< / li >
< / ul >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-168" > line 168< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "TEXTURE" > < span class = "type-signature" > < static, constant> < / span > TEXTURE< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > number< / span >
< / li >
< / ul >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-156" > line 156< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "TILEMAP" > < span class = "type-signature" > < static, constant> < / span > TILEMAP< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > number< / span >
< / li >
< / ul >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-180" > line 180< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "XML" > < span class = "type-signature" > < static, constant> < / span > XML< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > number< / span >
< / li >
< / ul >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-210" > line 210< / a >
2014-05-20 09:12:48 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "_cacheMap" > < span class = "type-signature" > < / span > _cacheMap< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > _cacheMap< / code > < / td >
< td class = "type" >
< span class = "param-type" > array< / span >
< / td >
< td class = "description last" > < p > Const to cache object look-up array.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-123" > line 123< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "game" > < span class = "type-signature" > < / span > game< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props 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 > Local reference to game.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-20" > line 20< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "onSoundUnlock" > < span class = "type-signature" > < / span > onSoundUnlock< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > onSoundUnlock< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Signal.html" > Phaser.Signal< / a > < / span >
< / td >
< td class = "description last" > < p > This event is dispatched when the sound system is unlocked via a touch event on cellular devices.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-118" > line 118< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
< / 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:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-228" > line 228< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< 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" > → {< a href = "Phaser.BitmapData.html" > Phaser.BitmapData< / a > }< / span > < / h4 >
2014-02-18 03:01:51 +00:00
< / dt >
< dd >
< div class = "description" >
< p > Add a BitmapData object in to the cache.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-10-09 15:12:53 +00:00
< th > Argument< / th >
2014-02-18 03:01:51 +00:00
< 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 >
2014-10-09 15:12:53 +00:00
< td class = "attributes" >
< / td >
2014-02-18 03:01:51 +00:00
< 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 >
2014-10-09 15:12:53 +00:00
< td class = "attributes" >
< / td >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > The BitmapData object to be addded to the cache.< / p > < / td >
< / tr >
2014-10-09 15:12:53 +00:00
< tr >
< td class = "name" > < code > frameData< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.FrameData.html" > Phaser.FrameData< / a > < / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > < p > Optional FrameData set associated with the given BitmapData.< / p > < / td >
< / tr >
2014-02-18 03:01:51 +00:00
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-241" > line 241< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The BitmapData object to be addded to the cache.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.BitmapData.html" > Phaser.BitmapData< / a > < / span >
< / dd >
< / 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" >
< 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" >
< 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:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-352" > line 352< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
< / 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:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-214" > line 214< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "addDefaultImage" > < span class = "type-signature" > < protected> < / 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 = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-395" > line 395< / a >
2014-02-05 06:29:17 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
2013-11-28 15:57:09 +00:00
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "addImage" > < span class = "type-signature" > < / span > addImage< span class = "signature" > (key, url, data)< / span > < span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< div class = "description" >
2014-07-10 19:31:11 +00:00
< p > Adds an Image file into the Cache. The file must have already been loaded, typically via Phaser.Loader.< / p >
2013-11-28 15:57:09 +00:00
< / 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 >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > The unique key by which you will reference this object.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-18 03:01:51 +00:00
< td class = "name" > < code > url< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-02-18 03:01:51 +00:00
< span class = "param-type" > string< / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-02-18 03:01:51 +00:00
< 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 >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-483" > line 483< / a >
2014-02-24 12:14:30 +00:00
< / li > < / ul > < / dd >
< / 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 >
2014-10-09 15:12:53 +00:00
< td class = "description last" > < p > Asset key for the json data.< / p > < / td >
2014-02-24 12:14:30 +00:00
< / tr >
< tr >
< td class = "name" > < code > url< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2014-10-09 15:12:53 +00:00
< td class = "description last" > < p > URL of this json data file.< / p > < / td >
2014-02-24 12:14:30 +00:00
< / tr >
< tr >
< td class = "name" > < code > data< / code > < / td >
< td class = "type" >
< span class = "param-type" > object< / span >
< / td >
2014-10-09 15:12:53 +00:00
< td class = "description last" > < p > Extra json data.< / p > < / td >
2014-02-24 12:14:30 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-453" > line 453< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
2014-02-18 03:01:51 +00:00
< / dd >
2013-11-28 15:57:09 +00:00
2014-02-18 03:01:51 +00:00
< dt >
< h4 class = "name" id = "addMissingImage" > < span class = "type-signature" > < protected> < / 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" >
2013-11-28 15:57:09 +00:00
2014-02-18 03:01:51 +00:00
2013-11-28 15:57:09 +00:00
2014-02-18 03:01:51 +00:00
2013-11-28 15:57:09 +00:00
2014-02-18 03:01:51 +00:00
2013-11-28 15:57:09 +00:00
2014-02-18 03:01:51 +00:00
2013-11-28 15:57:09 +00:00
2014-02-18 03:01:51 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-416" > line 416< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
2013-11-28 15:57:09 +00:00
< / dl >
2014-02-18 03:01:51 +00:00
2013-11-28 15:57:09 +00:00
2014-02-18 03:01:51 +00:00
2013-11-28 15:57:09 +00:00
< / dd >
2013-10-02 14:05:55 +00:00
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "addRenderTexture" > < span class = "type-signature" > < / span > addRenderTexture< span class = "signature" > (key, texture)< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-02-18 03:01:51 +00:00
< p > Add a new Phaser.RenderTexture in to the cache.< / p >
2013-10-02 14:05:55 +00:00
< / 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 >
2014-02-18 03:01:51 +00:00
< td class = "name" > < code > texture< / code > < / td >
2013-10-02 14:05:55 +00:00
< td class = "type" >
2014-10-22 20:49:44 +00:00
< span class = "param-type" > < a href = "Phaser.RenderTexture.html" > Phaser.RenderTexture< / a > < / span >
2013-10-02 14:05:55 +00:00
< / td >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > The texture to use as the base of the RenderTexture.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-260" > line 260< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< 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 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-07-10 19:31:11 +00:00
< p > Adds a Sound file into the Cache. The file must have already been loaded, typically via Phaser.Loader.< / p >
2013-10-02 14:05:55 +00:00
< / 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 >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > Asset key for the sound.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< tr >
2014-02-18 03:01:51 +00:00
< td class = "name" > < code > url< / code > < / td >
2013-10-02 14:05:55 +00:00
< td class = "type" >
2014-02-18 03:01:51 +00:00
< span class = "param-type" > string< / span >
2013-10-02 14:05:55 +00:00
< / td >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > URL of this sound file.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< tr >
2014-02-18 03:01:51 +00:00
< td class = "name" > < code > data< / code > < / td >
2013-10-02 14:05:55 +00:00
< td class = "type" >
2014-02-18 03:01:51 +00:00
< span class = "param-type" > object< / span >
2013-10-02 14:05:55 +00:00
< / td >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > Extra sound data.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
2014-02-18 03:01:51 +00:00
< tr >
< td class = "name" > < code > webAudio< / code > < / td >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< td class = "type" >
< span class = "param-type" > boolean< / span >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< / td >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > True if the file is using web audio.< / p > < / td >
< / tr >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< tr >
< td class = "name" > < code > audioTag< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< / td >
< td class = "description last" > < p > True if the file is using legacy HTML audio.< / p > < / td >
< / tr >
< / tbody >
< / table >
2013-10-02 14:05:55 +00:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-506" > line 506< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< 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 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-02-18 03:01:51 +00:00
< p > Add a new sprite sheet in to the cache.< / p >
2013-10-02 14:05:55 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-02-18 03:01:51 +00:00
< th > Argument< / th >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< th > Default< / th >
2013-10-02 14:05:55 +00:00
< 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 >
2014-02-18 03:01:51 +00:00
< td class = "attributes" >
< / td >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< td class = "default" >
< / td >
2013-10-02 14:05:55 +00:00
< 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 >
2014-02-18 03:01:51 +00:00
< td class = "attributes" >
< / td >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< td class = "default" >
< / td >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > URL of this sprite sheet file.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< tr >
< td class = "name" > < code > data< / code > < / td >
< td class = "type" >
< span class = "param-type" > object< / span >
< / td >
2014-02-18 03:01:51 +00:00
< td class = "attributes" >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< / td >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< td class = "default" >
< / td >
< td class = "description last" > < p > Extra sprite sheet data.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
2014-02-18 03:01:51 +00:00
< tr >
< td class = "name" > < code > frameWidth< / code > < / td >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< / td >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< td class = "attributes" >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< / td >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< td class = "default" >
< / td >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > Width of the sprite sheet.< / p > < / td >
< / tr >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
2013-11-28 15:57:09 +00:00
2014-02-18 03:01:51 +00:00
< tr >
< td class = "name" > < code > frameHeight< / code > < / td >
2013-11-28 15:57:09 +00:00
2014-02-18 03:01:51 +00:00
< 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" >
< 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" >
< 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" >
< optional>< br >
2013-11-28 15:57:09 +00:00
2014-02-18 03:01:51 +00:00
2013-11-28 15:57:09 +00:00
2014-02-18 03:01:51 +00:00
< / td >
2013-11-28 15:57:09 +00:00
2014-02-18 03:01:51 +00:00
< td class = "default" >
0
< / td >
2013-11-28 15:57:09 +00:00
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > If the frames have been drawn with spacing between them, specify the amount here.< / p > < / td >
< / tr >
2013-11-28 15:57:09 +00:00
2014-02-18 03:01:51 +00:00
< / tbody >
< / table >
2013-11-28 15:57:09 +00:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-275" > line 275< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "addText" > < span class = "type-signature" > < / span > addText< span class = "signature" > (key, url, data)< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-02-18 03:01:51 +00:00
< p > Add a new text data.< / p >
2013-10-02 14:05:55 +00:00
< / 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 >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > Asset key for the text data.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< tr >
2014-02-18 03:01:51 +00:00
< td class = "name" > < code > url< / code > < / td >
2013-10-02 14:05:55 +00:00
< td class = "type" >
2014-02-18 03:01:51 +00:00
< span class = "param-type" > string< / span >
2013-10-02 14:05:55 +00:00
< / td >
2014-02-18 03:01:51 +00:00
< 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 >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-437" > line 437< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< 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 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-02-18 03:01:51 +00:00
< p > Add a new texture atlas to the Cache.< / p >
2013-10-02 14:05:55 +00:00
< / 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 >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > The unique key by which you will reference this object.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< tr >
< td class = "name" > < code > url< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > URL of this texture atlas file.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< tr >
< td class = "name" > < code > data< / code > < / td >
< td class = "type" >
< span class = "param-type" > object< / span >
< / td >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > Extra texture atlas data.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< tr >
2014-02-18 03:01:51 +00:00
< td class = "name" > < code > atlasData< / code > < / td >
2013-10-02 14:05:55 +00:00
< td class = "type" >
2014-02-18 03:01:51 +00:00
< span class = "param-type" > object< / span >
2013-10-02 14:05:55 +00:00
2014-05-20 09:12:48 +00:00
< / 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:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-318" > line 318< / a >
2014-05-20 09:12:48 +00:00
< / li > < / ul > < / dd >
< / 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:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-301" > line 301< / a >
2014-05-20 09:12:48 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "addTilemap" > < span class = "type-signature" > < / span > addTilemap< 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:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-378" > line 378< / a >
2014-05-20 09:12:48 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< h4 class = "name" id = "addXML" > < span class = "type-signature" > < / span > addXML< span class = "signature" > (key, url, data)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-05-20 09:12:48 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Add a new xml object into the cache.< / p >
2014-05-20 09:12:48 +00:00
< / 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 >
2014-10-09 15:12:53 +00:00
< 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 >
2014-05-20 09:12:48 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-469" > line 469< / a >
2014-05-20 09:12:48 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< h4 class = "name" id = "checkBinaryKey" > < span class = "type-signature" > < / span > checkBinaryKey< span class = "signature" > (key)< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
2014-05-20 09:12:48 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Checks if the given key exists in the Binary Cache.< / p >
2014-05-20 09:12:48 +00:00
< / 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 >
2014-10-09 15:12:53 +00:00
< td class = "description last" > < p > Asset key of the binary file to check is in the Cache.< / p > < / td >
2014-05-20 09:12:48 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-835" > line 835< / a >
2014-05-20 09:12:48 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > True if the key exists, otherwise false.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< h4 class = "name" id = "checkBitmapDataKey" > < span class = "type-signature" > < / span > checkBitmapDataKey< span class = "signature" > (key)< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
2014-05-20 09:12:48 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Checks if the given key exists in the BitmapData Cache.< / p >
2014-05-20 09:12:48 +00:00
< / 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 >
2014-10-09 15:12:53 +00:00
< td class = "description last" > < p > Asset key of the BitmapData to check is in the Cache.< / p > < / td >
2014-05-20 09:12:48 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-848" > line 848< / a >
2014-05-20 09:12:48 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > True if the key exists, otherwise false.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< h4 class = "name" id = "checkBitmapFontKey" > < span class = "type-signature" > < / span > checkBitmapFontKey< span class = "signature" > (key)< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
2014-05-20 09:12:48 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Checks if the given key exists in the BitmapFont Cache.< / p >
2014-05-20 09:12:48 +00:00
< / 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 >
2014-10-09 15:12:53 +00:00
< td class = "description last" > < p > Asset key of the BitmapFont to check is in the Cache.< / p > < / td >
2014-05-20 09:12:48 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-861" > line 861< / a >
2014-05-20 09:12:48 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > True if the key exists, otherwise false.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< h4 class = "name" id = "checkCanvasKey" > < span class = "type-signature" > < / span > checkCanvasKey< span class = "signature" > (key)< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
2014-05-20 09:12:48 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Checks if the given key exists in the Canvas Cache.< / p >
2014-05-20 09:12:48 +00:00
< / 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 >
2014-10-09 15:12:53 +00:00
< td class = "description last" > < p > Asset key of the canvas to check is in the Cache.< / p > < / td >
2014-05-20 09:12:48 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-744" > line 744< / a >
2014-05-20 09:12:48 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > True if the key exists, otherwise false.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< h4 class = "name" id = "checkImageKey" > < span class = "type-signature" > < / span > checkImageKey< span class = "signature" > (key)< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
2014-05-20 09:12:48 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Checks if the given key exists in the Image Cache. Note that this also includes Texture Atlases, Sprite Sheets and Retro Fonts.< / p >
2014-05-20 09:12:48 +00:00
< / 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 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-757" > line 757< / a >
2014-05-20 09:12:48 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > True if the key exists, otherwise false.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< h4 class = "name" id = "checkJSONKey" > < span class = "type-signature" > < / span > checkJSONKey< span class = "signature" > (key)< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
2014-05-20 09:12:48 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Checks if the given key exists in the JSON Cache.< / p >
2014-05-20 09:12:48 +00:00
< / 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 >
2014-10-09 15:12:53 +00:00
< td class = "description last" > < p > Asset key of the JSON file to check is in the Cache.< / p > < / td >
2014-05-20 09:12:48 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-874" > line 874< / a >
2014-05-20 09:12:48 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > True if the key exists, otherwise false.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< h4 class = "name" id = "checkKey" > < span class = "type-signature" > < / span > checkKey< span class = "signature" > (type, key)< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
2014-05-20 09:12:48 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Checks if a key for the given cache object type exists.< / p >
2014-05-20 09:12:48 +00:00
< / 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 >
2014-10-09 15:12:53 +00:00
< td class = "name" > < code > type< / code > < / td >
2014-05-20 09:12:48 +00:00
< td class = "type" >
2014-10-09 15:12:53 +00:00
< span class = "param-type" > number< / span >
2014-05-20 09:12:48 +00:00
< / td >
2014-10-09 15:12:53 +00:00
< 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 >
2014-05-20 09:12:48 +00:00
< / tr >
2014-10-09 15:12:53 +00:00
< 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 >
2014-05-20 09:12:48 +00:00
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-725" > line 725< / a >
2014-05-20 09:12:48 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > True if the key exists, otherwise false.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< h4 class = "name" id = "checkPhysicsKey" > < span class = "type-signature" > < / span > checkPhysicsKey< span class = "signature" > (key)< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
2014-05-20 09:12:48 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Checks if the given key exists in the Physics Cache.< / p >
2014-05-20 09:12:48 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
2013-10-02 14:05:55 +00:00
2014-05-20 09:12:48 +00:00
< th > Type< / th >
2013-10-02 14:05:55 +00:00
2014-05-20 09:12:48 +00:00
2013-10-02 14:05:55 +00:00
2014-05-20 09:12:48 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2013-10-02 14:05:55 +00:00
2014-05-20 09:12:48 +00:00
< tbody >
2013-10-02 14:05:55 +00:00
< tr >
2014-05-20 09:12:48 +00:00
< td class = "name" > < code > key< / code > < / td >
2013-10-02 14:05:55 +00:00
< td class = "type" >
2014-05-20 09:12:48 +00:00
< span class = "param-type" > string< / span >
2013-10-02 14:05:55 +00:00
< / td >
2014-10-09 15:12:53 +00:00
< td class = "description last" > < p > Asset key of the physics data file to check is in the Cache.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-809" > line 809< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
2014-05-20 09:12:48 +00:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > True if the key exists, otherwise false.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
2013-10-02 14:05:55 +00:00
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< h4 class = "name" id = "checkSoundKey" > < span class = "type-signature" > < / span > checkSoundKey< span class = "signature" > (key)< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Checks if the given key exists in the Sound Cache.< / p >
2013-10-02 14:05:55 +00:00
< / 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 >
2014-10-09 15:12:53 +00:00
< td class = "description last" > < p > Asset key of the sound file to check is in the Cache.< / p > < / td >
2014-02-18 03:01:51 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-783" > line 783< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
< / dl >
2014-05-20 09:12:48 +00:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > True if the key exists, otherwise false.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
2014-02-18 03:01:51 +00:00
< / dd >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< dt >
2014-10-09 15:12:53 +00:00
< h4 class = "name" id = "checkTextKey" > < span class = "type-signature" > < / span > checkTextKey< span class = "signature" > (key)< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
2014-02-18 03:01:51 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Checks if the given key exists in the Text Cache.< / p >
2014-02-18 03:01:51 +00:00
< / div >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< tbody >
2013-10-02 14:05:55 +00:00
< tr >
2014-02-18 03:01:51 +00:00
< td class = "name" > < code > key< / code > < / td >
2013-10-02 14:05:55 +00:00
< td class = "type" >
2014-02-18 03:01:51 +00:00
< span class = "param-type" > string< / span >
2013-10-02 14:05:55 +00:00
< / td >
2014-10-09 15:12:53 +00:00
< td class = "description last" > < p > Asset key of the text file to check is in the Cache.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-796" > line 796< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
2014-05-20 09:12:48 +00:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > True if the key exists, otherwise false.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
2013-10-02 14:05:55 +00:00
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< h4 class = "name" id = "checkTextureKey" > < span class = "type-signature" > < / span > checkTextureKey< span class = "signature" > (key)< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Checks if the given key exists in the Texture Cache.< / p >
2013-10-02 14:05:55 +00:00
< / 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 >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > Asset key of the image to check is in the Cache.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
2014-02-18 03:01:51 +00:00
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-770" > line 770< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > True if the key exists, otherwise false.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< h4 class = "name" id = "checkTilemapKey" > < span class = "type-signature" > < / span > checkTilemapKey< span class = "signature" > (key)< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
2014-02-18 03:01:51 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Checks if the given key exists in the Tilemap Cache.< / p >
2014-02-18 03:01:51 +00:00
< / 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 >
2013-10-02 14:05:55 +00:00
< tr >
2014-02-18 03:01:51 +00:00
< td class = "name" > < code > key< / code > < / td >
2013-10-02 14:05:55 +00:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2014-10-09 15:12:53 +00:00
< td class = "description last" > < p > Asset key of the Tilemap to check is in the Cache.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-822" > line 822< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
< / dl >
2014-10-09 15:12:53 +00:00
< h5 > Returns:< / h5 >
2014-02-18 03:01:51 +00:00
2014-10-09 15:12:53 +00:00
< div class = "param-desc" >
< p > True if the key exists, otherwise false.< / p >
< / div >
2014-02-18 03:01:51 +00:00
2013-10-02 14:05:55 +00:00
2014-10-09 15:12:53 +00:00
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
2013-10-02 14:05:55 +00:00
2014-10-09 15:12:53 +00:00
< / dd >
2013-10-02 14:05:55 +00:00
< / dl >
2014-10-09 15:12:53 +00:00
2013-10-02 14:05:55 +00:00
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< h4 class = "name" id = "checkUrl" > < span class = "type-signature" > < / span > checkUrl< span class = "signature" > (url)< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Checks if the given URL has been loaded into the Cache.< / p >
2013-10-02 14:05:55 +00:00
< / 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 >
2014-10-09 15:12:53 +00:00
< td class = "name" > < code > url< / code > < / td >
2013-10-02 14:05:55 +00:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2014-10-09 15:12:53 +00:00
< td class = "description last" > < p > The url to check for in the cache.< / p > < / td >
2013-10-23 13:00:28 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-900" > line 900< / a >
2013-10-23 13:00:28 +00:00
< / li > < / ul > < / dd >
< / dl >
2014-02-18 03:01:51 +00:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2014-10-09 15:12:53 +00:00
< p > True if the url exists, otherwise false.< / p >
2014-02-18 03:01:51 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2014-10-09 15:12:53 +00:00
< span class = "param-type" > boolean< / span >
2014-02-18 03:01:51 +00:00
< / dd >
< / dl >
2013-10-23 13:00:28 +00:00
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< h4 class = "name" id = "checkXMLKey" > < span class = "type-signature" > < / span > checkXMLKey< span class = "signature" > (key)< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
2013-10-23 13:00:28 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Checks if the given key exists in the XML Cache.< / p >
2013-10-23 13:00:28 +00:00
< / 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 >
2014-10-09 15:12:53 +00:00
< td class = "description last" > < p > Asset key of the XML file to check is in the Cache.< / p > < / td >
2013-10-23 13:00:28 +00:00
< / tr >
2014-02-18 03:01:51 +00:00
< / tbody >
< / table >
2013-10-23 13:00:28 +00:00
2014-02-18 03:01:51 +00:00
< dl class = "details" >
2013-10-23 13:00:28 +00:00
2014-02-18 03:01:51 +00:00
2013-10-23 13:00:28 +00:00
2014-02-18 03:01:51 +00:00
2013-10-23 13:00:28 +00:00
2014-02-18 03:01:51 +00:00
2013-10-23 13:00:28 +00:00
2014-02-18 03:01:51 +00:00
2013-10-23 13:00:28 +00:00
2014-02-18 03:01:51 +00:00
2013-10-23 13:00:28 +00:00
2014-02-18 03:01:51 +00:00
2013-10-23 13:00:28 +00:00
2014-02-18 03:01:51 +00:00
2013-10-23 13:00:28 +00:00
2014-02-18 03:01:51 +00:00
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-887" > line 887< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
2013-10-23 13:00:28 +00:00
2014-02-18 03:01:51 +00:00
< div class = "param-desc" >
2014-10-09 15:12:53 +00:00
< p > True if the key exists, otherwise false.< / p >
2014-02-18 03:01:51 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2014-10-09 15:12:53 +00:00
< span class = "param-type" > boolean< / span >
2014-02-18 03:01:51 +00:00
< / dd >
< / dl >
2013-10-23 13:00:28 +00:00
2014-02-18 03:01:51 +00:00
< / dd >
2013-10-23 13:00:28 +00:00
2014-02-18 03:01:51 +00:00
< dt >
2014-10-09 15:12:53 +00:00
< h4 class = "name" id = "decodedSound" > < span class = "type-signature" > < / span > decodedSound< span class = "signature" > (key, data)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-02-18 03:01:51 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Add a new decoded sound.< / p >
2014-02-18 03:01:51 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
2013-10-23 13:00:28 +00:00
2014-02-18 03:01:51 +00:00
< th > Type< / th >
2013-10-23 13:00:28 +00:00
2014-02-18 03:01:51 +00:00
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< tbody >
2013-10-02 14:05:55 +00:00
< tr >
2014-02-18 03:01:51 +00:00
< td class = "name" > < code > key< / code > < / td >
2013-10-02 14:05:55 +00:00
< td class = "type" >
2014-02-18 03:01:51 +00:00
< span class = "param-type" > string< / span >
2013-10-02 14:05:55 +00:00
< / td >
2014-02-05 06:29:17 +00:00
2013-10-23 13:00:28 +00:00
2014-10-09 15:12:53 +00:00
< 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 >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-587" > line 587< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< h4 class = "name" id = "destroy" > < span class = "type-signature" > < / span > destroy< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Clears the cache. Removes every local cache object reference.< / p >
2013-10-02 14:05:55 +00:00
< / div >
2014-10-09 15:12:53 +00:00
< dl class = "details" >
2013-10-02 14:05:55 +00:00
2014-10-09 15:12:53 +00:00
2013-10-02 14:05:55 +00:00
2014-10-09 15:12:53 +00:00
2013-10-02 14:05:55 +00:00
2014-10-09 15:12:53 +00:00
2013-10-02 14:05:55 +00:00
2014-10-09 15:12:53 +00:00
2013-10-02 14:05:55 +00:00
2014-10-09 15:12:53 +00:00
2013-10-02 14:05:55 +00:00
2014-10-09 15:12:53 +00:00
2013-10-02 14:05:55 +00:00
2014-10-09 15:12:53 +00:00
2013-10-02 14:05:55 +00:00
2014-10-09 15:12:53 +00:00
2013-10-02 14:05:55 +00:00
2014-10-09 15:12:53 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-22 20:49:44 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-1492" > line 1492< / a >
2014-10-09 15:12:53 +00:00
< / li > < / ul > < / dd >
2013-10-02 14:05:55 +00:00
2014-10-09 15:12:53 +00:00
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "getBinary" > < span class = "type-signature" > < / span > getBinary< span class = "signature" > (key)< / span > < span class = "type-signature" > → {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 >
2013-10-02 14:05:55 +00:00
< / td >
2014-10-09 15:12:53 +00:00
< td class = "description last" > < p > Asset key of the binary data object to retrieve from the Cache.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-1230" > line 1230< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2014-10-09 15:12:53 +00:00
< p > The binary data object.< / p >
2013-10-02 14:05:55 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2014-02-18 03:01:51 +00:00
< span class = "param-type" > object< / span >
2013-10-02 14:05:55 +00:00
< / dd >
< / dl >
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< h4 class = "name" id = "getBitmapData" > < span class = "type-signature" > < / span > getBitmapData< span class = "signature" > (key)< / span > < span class = "type-signature" > → {< a href = "Phaser.BitmapData.html" > Phaser.BitmapData< / a > }< / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Get a BitmapData object from the cache by its key.< / p >
2013-10-02 14:05:55 +00:00
< / 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 >
2014-10-09 15:12:53 +00:00
< td class = "description last" > < p > Asset key of the BitmapData object to retrieve from the Cache.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-622" > line 622< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
2014-02-18 03:01:51 +00:00
< h5 > Returns:< / h5 >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< div class = "param-desc" >
2014-10-09 15:12:53 +00:00
< p > The requested BitmapData object if found, or null if not.< / p >
2014-02-18 03:01:51 +00:00
< / div >
2013-10-02 14:05:55 +00:00
2013-11-28 15:57:09 +00:00
2014-02-18 03:01:51 +00:00
< dl >
< dt >
Type
< / dt >
< dd >
2014-10-09 15:12:53 +00:00
< span class = "param-type" > < a href = "Phaser.BitmapData.html" > Phaser.BitmapData< / a > < / span >
2013-11-28 15:57:09 +00:00
2014-02-18 03:01:51 +00:00
< / dd >
2013-11-28 15:57:09 +00:00
< / dl >
2014-02-18 03:01:51 +00:00
2013-11-28 15:57:09 +00:00
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< h4 class = "name" id = "getBitmapFont" > < span class = "type-signature" > < / span > getBitmapFont< span class = "signature" > (key)< / span > < span class = "type-signature" > → {Phaser.BitmapFont}< / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Get a BitmapFont object from the cache by its key.< / p >
2013-11-28 15:57:09 +00:00
< / 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 >
2014-10-09 15:12:53 +00:00
< td class = "description last" > < p > Asset key of the BitmapFont object to retrieve from the Cache.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-642" > line 642< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
2013-11-28 15:57:09 +00:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2014-10-09 15:12:53 +00:00
< p > The requested BitmapFont object if found, or null if not.< / p >
2013-11-28 15:57:09 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2014-10-09 15:12:53 +00:00
< span class = "param-type" > Phaser.BitmapFont< / span >
2013-11-28 15:57:09 +00:00
< / dd >
< / dl >
2013-10-02 14:05:55 +00:00
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< h4 class = "name" id = "getCanvas" > < span class = "type-signature" > < / span > getCanvas< span class = "signature" > (key)< / span > < span class = "type-signature" > → {object}< / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Get a canvas object from the cache by its key.< / p >
2013-10-02 14:05:55 +00:00
< / 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 >
2014-10-09 15:12:53 +00:00
< td class = "description last" > < p > Asset key of the canvas to retrieve from the Cache.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-602" > line 602< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2014-10-09 15:12:53 +00:00
< p > The canvas object.< / p >
2013-10-02 14:05:55 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2014-10-09 15:12:53 +00:00
< span class = "param-type" > object< / span >
2013-10-02 14:05:55 +00:00
< / dd >
< / dl >
2014-09-09 14:36:56 +00:00
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< h4 class = "name" id = "getFrame" > < span class = "type-signature" > < / span > getFrame< span class = "signature" > (key)< / span > < span class = "type-signature" > → {< a href = "Phaser.Frame.html" > Phaser.Frame< / a > }< / span > < / h4 >
2014-09-09 14:36:56 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< 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 >
2014-09-09 14:36:56 +00:00
< / 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 >
2014-10-09 15:12:53 +00:00
< td class = "description last" > < p > Asset key of the frame data to retrieve from the Cache.< / p > < / td >
2014-09-09 14:36:56 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-1029" > line 1029< / a >
2014-09-09 14:36:56 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2014-10-09 15:12:53 +00:00
< p > The frame data.< / p >
2014-09-09 14:36:56 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2014-10-09 15:12:53 +00:00
< span class = "param-type" > < a href = "Phaser.Frame.html" > Phaser.Frame< / a > < / span >
2014-09-09 14:36:56 +00:00
< / dd >
< / dl >
2013-10-02 14:05:55 +00:00
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< h4 class = "name" id = "getFrameByIndex" > < span class = "type-signature" > < / span > getFrameByIndex< span class = "signature" > (key)< / span > < span class = "type-signature" > → {< a href = "Phaser.Frame.html" > Phaser.Frame< / a > }< / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Get a single frame out of a frameData set by key.< / p >
2013-10-02 14:05:55 +00:00
< / 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 >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > Asset key of the frame data to retrieve from the Cache.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-995" > line 995< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2014-10-09 15:12:53 +00:00
< p > The frame object.< / p >
2013-10-02 14:05:55 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2014-10-09 15:12:53 +00:00
< span class = "param-type" > < a href = "Phaser.Frame.html" > Phaser.Frame< / a > < / span >
2013-10-02 14:05:55 +00:00
< / dd >
< / dl >
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< h4 class = "name" id = "getFrameByName" > < span class = "type-signature" > < / span > getFrameByName< span class = "signature" > (key)< / span > < span class = "type-signature" > → {< a href = "Phaser.Frame.html" > Phaser.Frame< / a > }< / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Get a single frame out of a frameData set by key.< / p >
2013-10-02 14:05:55 +00:00
< / 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 >
2014-10-09 15:12:53 +00:00
< td class = "description last" > < p > Asset key of the frame data to retrieve from the Cache.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-1012" > line 1012< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2014-10-09 15:12:53 +00:00
< p > The frame object.< / p >
2013-10-02 14:05:55 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2014-10-09 15:12:53 +00:00
< span class = "param-type" > < a href = "Phaser.Frame.html" > Phaser.Frame< / a > < / span >
2013-10-02 14:05:55 +00:00
< / dd >
< / dl >
2014-02-24 12:14:30 +00:00
< / dd >
< dt >
2014-10-22 20:49:44 +00:00
< h4 class = "name" id = "getFrameCount" > < span class = "type-signature" > < / span > getFrameCount< span class = "signature" > (key)< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
2014-02-24 12:14:30 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Get the number of frames in this image.< / p >
2014-02-24 12:14:30 +00:00
< / 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 >
2014-10-09 15:12:53 +00:00
< td class = "description last" > < p > Asset key of the image you want.< / p > < / td >
2014-02-24 12:14:30 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-1152" > line 1152< / a >
2014-02-24 12:14:30 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2014-10-09 15:12:53 +00:00
< p > Then number of frames. 0 if the image is not found.< / p >
2014-02-24 12:14:30 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2014-10-22 20:49:44 +00:00
< span class = "param-type" > number< / span >
2014-02-24 12:14:30 +00:00
< / dd >
< / dl >
2013-10-02 14:05:55 +00:00
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< 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" > → {< a href = "Phaser.FrameData.html" > Phaser.FrameData< / a > }< / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Get frame data by key.< / p >
2013-10-02 14:05:55 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-02-18 03:01:51 +00:00
< th > Argument< / th >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< th > Default< / th >
2013-10-02 14:05:55 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-10-09 15:12:53 +00:00
< td class = "name" > < code > key< / code > < / td >
2013-10-02 14:05:55 +00:00
< td class = "type" >
2014-10-09 15:12:53 +00:00
< 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 >
2013-10-02 14:05:55 +00:00
< / td >
2014-02-18 03:01:51 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< td class = "default" >
Phaser.Cache.IMAGE
< / td >
2013-10-02 14:05:55 +00:00
2014-10-09 15:12:53 +00:00
< td class = "description last" > < p > The asset map to get the frameData from, for example < code > Phaser.Cache.IMAGE< / code > .< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-959" > line 959< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2014-10-09 15:12:53 +00:00
< p > The frame data.< / p >
2013-10-02 14:05:55 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2014-10-09 15:12:53 +00:00
< span class = "param-type" > < a href = "Phaser.FrameData.html" > Phaser.FrameData< / a > < / span >
2013-10-02 14:05:55 +00:00
< / dd >
< / dl >
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< h4 class = "name" id = "getImage" > < span class = "type-signature" > < / span > getImage< span class = "signature" > (key)< / span > < span class = "type-signature" > → {object}< / span > < / h4 >
2013-10-23 13:00:28 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Get image data by key.< / p >
2013-10-23 13:00:28 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-02-18 03:01:51 +00:00
< 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 >
2013-10-23 13:00:28 +00:00
2014-02-18 03:01:51 +00:00
2013-10-23 13:00:28 +00:00
2014-10-09 15:12:53 +00:00
< td class = "description last" > < p > Asset key of the image to retrieve from the Cache.< / p > < / td >
2014-02-18 03:01:51 +00:00
< / tr >
2013-10-23 13:00:28 +00:00
2014-10-09 15:12:53 +00:00
< / tbody >
< / table >
2013-10-23 13:00:28 +00:00
2014-10-09 15:12:53 +00:00
< dl class = "details" >
2013-10-23 13:00:28 +00:00
2014-10-09 15:12:53 +00:00
2013-10-23 13:00:28 +00:00
2014-10-09 15:12:53 +00:00
2013-10-23 13:00:28 +00:00
2014-10-09 15:12:53 +00:00
2013-10-23 13:00:28 +00:00
2014-10-09 15:12:53 +00:00
2014-02-18 03:01:51 +00:00
2014-10-09 15:12:53 +00:00
2013-10-23 13:00:28 +00:00
2014-10-09 15:12:53 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-918" > line 918< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The image data if found in the Cache, otherwise < code > null< / code > .< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > object< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "getJSON" > < span class = "type-signature" > < / span > getJSON< span class = "signature" > (key)< / span > < span class = "type-signature" > → {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 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-1190" > line 1190< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The JSON object.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > object< / span >
< / dd >
< / 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" > → {< a href = "Array.html" > Array< / a > }< / 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" >
< 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 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-1270" > line 1270< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The array of item keys.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Array.html" > Array< / a > < / span >
< / dd >
< / 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" > → {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" >
< 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 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-662" > line 662< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The requested physics object data if found.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > object< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "getSound" > < span class = "type-signature" > < / span > getSound< span class = "signature" > (key)< / span > < span class = "type-signature" > → {< 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 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-1083" > line 1083< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The sound object.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Sound.html" > Phaser.Sound< / a > < / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "getSoundData" > < span class = "type-signature" > < / span > getSoundData< span class = "signature" > (key)< / span > < span class = "type-signature" > → {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 >
2013-10-23 13:00:28 +00:00
2014-10-09 15:12:53 +00:00
2014-02-18 03:01:51 +00:00
2014-10-09 15:12:53 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2013-10-23 13:00:28 +00:00
2014-10-09 15:12:53 +00:00
< tbody >
2013-10-23 13:00:28 +00:00
2014-04-10 22:13:43 +00:00
< tr >
2014-10-09 15:12:53 +00:00
< td class = "name" > < code > key< / code > < / td >
2014-04-10 22:13:43 +00:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2014-10-09 15:12:53 +00:00
< td class = "description last" > < p > Asset key of the sound to retrieve from the Cache.< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
2013-10-23 13:00:28 +00:00
< / tbody >
2014-02-05 06:29:17 +00:00
< / table >
2013-10-23 13:00:28 +00:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-1103" > line 1103< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2014-10-09 15:12:53 +00:00
< p > The sound data.< / p >
2013-10-02 14:05:55 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2014-02-18 03:01:51 +00:00
< span class = "param-type" > object< / span >
2013-10-02 14:05:55 +00:00
< / dd >
< / dl >
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< h4 class = "name" id = "getText" > < span class = "type-signature" > < / span > getText< span class = "signature" > (key)< / span > < span class = "type-signature" > → {object}< / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Get text data by key.< / p >
2013-10-02 14:05:55 +00:00
< / 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 >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > key< / code > < / td >
2013-10-02 14:05:55 +00:00
< td class = "type" >
2014-02-05 06:29:17 +00:00
< span class = "param-type" > string< / span >
2013-10-02 14:05:55 +00:00
< / td >
2014-10-09 15:12:53 +00:00
< td class = "description last" > < p > Asset key of the text data to retrieve from the Cache.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-1170" > line 1170< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2014-10-09 15:12:53 +00:00
< p > The text data.< / p >
2013-10-02 14:05:55 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2014-10-09 15:12:53 +00:00
< span class = "param-type" > object< / span >
2013-10-02 14:05:55 +00:00
< / dd >
< / dl >
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< h4 class = "name" id = "getTexture" > < span class = "type-signature" > < / span > getTexture< span class = "signature" > (key)< / span > < span class = "type-signature" > → {< a href = "Phaser.RenderTexture.html" > Phaser.RenderTexture< / a > }< / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Get a RenderTexture by key.< / p >
2013-10-02 14:05:55 +00:00
< / div >
2013-10-23 13:00:28 +00:00
< 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 >
2014-10-09 15:12:53 +00:00
< td class = "description last" > < p > Asset key of the RenderTexture to retrieve from the Cache.< / p > < / td >
2013-10-23 13:00:28 +00:00
< / tr >
< / tbody >
< / table >
2013-10-02 14:05:55 +00:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-1063" > line 1063< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2014-10-09 15:12:53 +00:00
< p > The RenderTexture object.< / p >
2013-10-02 14:05:55 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2014-10-09 15:12:53 +00:00
< span class = "param-type" > < a href = "Phaser.RenderTexture.html" > Phaser.RenderTexture< / a > < / span >
2013-10-02 14:05:55 +00:00
< / dd >
< / dl >
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< h4 class = "name" id = "getTextureFrame" > < span class = "type-signature" > < / span > getTextureFrame< span class = "signature" > (key)< / span > < span class = "type-signature" > → {< a href = "Phaser.Frame.html" > Phaser.Frame< / a > }< / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< 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 >
2014-02-05 06:29:17 +00:00
< / div >
2014-02-18 03:01:51 +00:00
< 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 >
2014-10-09 15:12:53 +00:00
< td class = "description last" > < p > Asset key of the frame to retrieve from the Cache.< / p > < / td >
2014-02-18 03:01:51 +00:00
< / tr >
< / tbody >
< / table >
2014-02-05 06:29:17 +00:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-1046" > line 1046< / a >
2014-02-05 06:29:17 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2014-10-09 15:12:53 +00:00
< p > The frame data.< / p >
2014-02-05 06:29:17 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2014-10-09 15:12:53 +00:00
< span class = "param-type" > < a href = "Phaser.Frame.html" > Phaser.Frame< / a > < / span >
2014-02-05 06:29:17 +00:00
< / dd >
< / dl >
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< h4 class = "name" id = "getTilemapData" > < span class = "type-signature" > < / span > getTilemapData< span class = "signature" > (key)< / span > < span class = "type-signature" > → {Object}< / span > < / h4 >
2014-02-05 06:29:17 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Get tilemap data by key.< / p >
2013-10-02 14:05:55 +00:00
< / 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 >
2014-02-18 03:01:51 +00:00
< td class = "name" > < code > key< / code > < / td >
2013-10-02 14:05:55 +00:00
< td class = "type" >
2014-02-18 03:01:51 +00:00
< span class = "param-type" > string< / span >
2013-10-02 14:05:55 +00:00
< / td >
2014-10-09 15:12:53 +00:00
< td class = "description last" > < p > Asset key of the tilemap data to retrieve from the Cache.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-939" > line 939< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2014-10-09 15:12:53 +00:00
< p > The raw tilemap data in CSV or JSON format.< / p >
2013-10-02 14:05:55 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2014-10-09 15:12:53 +00:00
< span class = "param-type" > Object< / span >
2013-10-02 14:05:55 +00:00
< / dd >
< / dl >
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< h4 class = "name" id = "getUrl" > < span class = "type-signature" > < / span > getUrl< span class = "signature" > (url)< / span > < span class = "type-signature" > → {object}< / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Get a cached object by the URL.< / p >
2013-10-02 14:05:55 +00:00
< / div >
2014-02-05 06:29:17 +00:00
< 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 >
2014-10-09 15:12:53 +00:00
< td class = "name" > < code > url< / code > < / td >
2014-02-05 06:29:17 +00:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2014-10-09 15:12:53 +00:00
< td class = "description last" > < p > The url for the object loaded to get from the cache.< / p > < / td >
2014-02-05 06:29:17 +00:00
< / tr >
< / tbody >
< / table >
2013-10-02 14:05:55 +00:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-1250" > line 1250< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2014-10-09 15:12:53 +00:00
< p > The cached object.< / p >
2013-10-02 14:05:55 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2014-10-09 15:12:53 +00:00
< span class = "param-type" > object< / span >
2013-10-02 14:05:55 +00:00
< / dd >
< / dl >
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< h4 class = "name" id = "getXML" > < span class = "type-signature" > < / span > getXML< span class = "signature" > (key)< / span > < span class = "type-signature" > → {object}< / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Get a XML object by key from the cache.< / p >
2013-10-02 14:05:55 +00:00
< / 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 >
2014-10-09 15:12:53 +00:00
< td class = "description last" > < p > Asset key of the XML object to retrieve from the Cache.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-1210" > line 1210< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2014-10-09 15:12:53 +00:00
< p > The XML object.< / p >
2013-10-02 14:05:55 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2014-10-09 15:12:53 +00:00
< span class = "param-type" > object< / span >
2013-10-02 14:05:55 +00:00
< / dd >
< / dl >
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "isSoundDecoded" > < span class = "type-signature" > < / span > isSoundDecoded< span class = "signature" > (key)< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-02-18 03:01:51 +00:00
< p > Check if the given sound has finished decoding.< / p >
2013-10-02 14:05:55 +00:00
< / div >
2014-02-18 03:01:51 +00:00
< 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 >
2013-10-02 14:05:55 +00:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-1123" > line 1123< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2014-02-18 03:01:51 +00:00
< p > The decoded state of the Sound object.< / p >
2013-10-02 14:05:55 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2014-02-18 03:01:51 +00:00
< span class = "param-type" > boolean< / span >
2013-10-02 14:05:55 +00:00
< / dd >
< / dl >
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "isSoundReady" > < span class = "type-signature" > < / span > isSoundReady< span class = "signature" > (key)< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-02-18 03:01:51 +00:00
< 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 >
2013-10-02 14:05:55 +00:00
< / 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 >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > Asset key of the sound in the Cache.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-1139" > line 1139< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2014-02-18 03:01:51 +00:00
< p > True if the sound is decoded and the device is not touch locked.< / p >
2013-10-02 14:05:55 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2014-02-18 03:01:51 +00:00
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
2013-10-02 14:05:55 +00:00
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "reloadSound" > < span class = "type-signature" > < / span > reloadSound< span class = "signature" > (key)< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-07-10 19:31:11 +00:00
< p > Reload a Sound file from the server.< / p >
2013-10-02 14:05:55 +00:00
< / 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 >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > Asset key for the sound.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-534" > line 534< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "reloadSoundComplete" > < span class = "type-signature" > < / span > reloadSoundComplete< span class = "signature" > (key)< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-02-18 03:01:51 +00:00
< p > Fires the onSoundUnlock event when the sound has completed reloading.< / p >
2013-10-02 14:05:55 +00:00
< / 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 >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > Asset key for the sound.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-556" > line 556< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "removeBinary" > < span class = "type-signature" > < / span > removeBinary< span class = "signature" > (key)< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-02-18 03:01:51 +00:00
< p > Removes a binary file from the cache.< / p >
2013-10-02 14:05:55 +00:00
< / 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 >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > Key of the asset you want to remove.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-1441" > line 1441< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "removeBitmapData" > < span class = "type-signature" > < / span > removeBitmapData< span class = "signature" > (key)< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-02-18 03:01:51 +00:00
< p > Removes a bitmap data from the cache.< / p >
2013-10-02 14:05:55 +00:00
< / 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 >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > Key of the asset you want to remove.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-1451" > line 1451< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "removeBitmapFont" > < span class = "type-signature" > < / span > removeBitmapFont< span class = "signature" > (key)< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-02-18 03:01:51 +00:00
< p > Removes a bitmap font from the cache.< / p >
2013-10-02 14:05:55 +00:00
< / 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 >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > Key of the asset you want to remove.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-1461" > line 1461< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "removeCanvas" > < span class = "type-signature" > < / span > removeCanvas< span class = "signature" > (key)< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-02-18 03:01:51 +00:00
< p > Removes a canvas from the cache.< / p >
2013-10-02 14:05:55 +00:00
< / 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 >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > Key of the asset you want to remove.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-1351" > line 1351< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-10-09 15:12:53 +00:00
< 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 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-10-09 15:12:53 +00:00
< p > Removes an image from the cache and optionally from the Pixi.BaseTextureCache as well.< / p >
2013-10-02 14:05:55 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-10-09 15:12:53 +00:00
< th > Argument< / th >
2013-10-02 14:05:55 +00:00
2014-10-09 15:12:53 +00:00
< th > Default< / th >
2013-10-02 14:05:55 +00:00
< 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 >
2014-10-09 15:12:53 +00:00
< td class = "attributes" >
< / td >
2013-10-02 14:05:55 +00:00
2014-10-09 15:12:53 +00:00
< td class = "default" >
< / td >
2013-10-02 14:05:55 +00:00
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > Key of the asset you want to remove.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
2014-10-09 15:12:53 +00:00
< tr >
< td class = "name" > < code > removeFromPixi< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< 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 >
2013-10-02 14:05:55 +00:00
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-1361" > line 1361< / a >
2014-02-24 12:14:30 +00:00
< / li > < / ul > < / dd >
< / 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:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-1401" > line 1401< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "removePhysics" > < span class = "type-signature" > < / span > removePhysics< span class = "signature" > (key)< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-02-18 03:01:51 +00:00
< p > Removes a physics data file from the cache.< / p >
2013-10-02 14:05:55 +00:00
< / 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 >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > Key of the asset you want to remove.< / p > < / td >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-1421" > line 1421< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "removeSound" > < span class = "type-signature" > < / span > removeSound< span class = "signature" > (key)< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-02-18 03:01:51 +00:00
< p > Removes a sound from the cache.< / p >
2013-10-02 14:05:55 +00:00
< / 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:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-1381" > line 1381< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "removeText" > < span class = "type-signature" > < / span > removeText< span class = "signature" > (key)< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-02-18 03:01:51 +00:00
< p > Removes a text from the cache.< / p >
2013-10-02 14:05:55 +00:00
< / 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:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-1391" > line 1391< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "removeTilemap" > < span class = "type-signature" > < / span > removeTilemap< span class = "signature" > (key)< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-02-18 03:01:51 +00:00
< p > Removes a tilemap from the cache.< / p >
2013-10-02 14:05:55 +00:00
< / 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:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-1431" > line 1431< / a >
< / li > < / ul > < / dd >
< / 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:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-1411" > line 1411< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "updateFrameData" > < span class = "type-signature" > < / span > updateFrameData< span class = "signature" > (key, frameData)< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 14:05:55 +00:00
< / dt >
< dd >
< div class = "description" >
2014-02-18 03:01:51 +00:00
< p > Replaces a set of frameData with a new Phaser.FrameData object.< / p >
2013-10-02 14:05:55 +00:00
< / 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 >
2014-02-18 03:01:51 +00:00
< 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 >
2013-10-02 14:05:55 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-979" > line 979< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / 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" >
2014-02-05 06:29:17 +00:00
< p > Updates the sound object in the cache.< / p >
2013-10-02 14:05:55 +00:00
< / 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:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-10-09 15:12:53 +00:00
< a href = "Cache.js.html" > loader/Cache.js< / a > , < a href = "Cache.js.html#sunlight-1-line-572" > line 572< / a >
2013-10-02 14:05:55 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< / dl >
< / article >
< / section >
< / div >
< div class = "clearfix" > < / div >
< footer >
< span class = "copyright" >
2014-02-05 06:29:17 +00:00
Phaser Copyright © 2012-2014 Photon Storm Ltd.
2013-10-02 14:05:55 +00:00
< / span >
< br / >
< span class = "jsdoc-message" >
2014-04-11 12:09:28 +00:00
Documentation generated by < a href = "https://github.com/jsdoc3/jsdoc" > JSDoc 3.3.0-dev< / a >
2014-10-22 20:49:44 +00:00
on Wed Oct 22 2014 21:45:47 GMT+0100 (BST) using the < a href = "https://github.com/terryweiss/docstrap" > DocStrap template< / a > .
2013-10-02 14:05:55 +00:00
< / 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( {
2014-04-10 22:13:43 +00:00
anchorName : function(i, heading, prefix) {
2014-03-14 06:36:05 +00:00
return $(heading).attr("id") || ( prefix + i );
},
2013-10-02 14:05:55 +00:00
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 >
