Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-27 07:01:20 +00:00
Code Issues Projects Releases Packages Wiki Activity
phaser/docs/Phaser.Loader.html
photonstorm 9401755ab9 Phaser 2.4.1 docs.
2015-07-24 13:30:46 +01:00

10991 lines
No EOL
202 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Phaser Class: Loader</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/default.css">
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
<div style="position: absolute; width: 143px; height: 31px; right: 10px; top: 10px; z-index: 1050"><a href="http://phaser.io"><img src="img/phaser.png" border="0" /></a></div>
<div class="navbar-inner">
<a class="brand" href="index.html">Phaser API</a>
<ul class="nav">
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-0">
<a href="Phaser.html">Phaser</a>
</li>
<li class="class-depth-0">
<a href="PIXI.html">PIXI</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1">
<a href="Phaser.Animation.html">Animation</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AnimationManager.html">AnimationManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AnimationParser.html">AnimationParser</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ArraySet.html">ArraySet</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ArrayUtils.html">ArrayUtils</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Button.html">Button</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Cache.html">Cache</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Camera.html">Camera</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Canvas.html">Canvas</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Circle.html">Circle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Color.html">Color</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Angle.html">Angle</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Animation.html">Animation</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.AutoCull.html">AutoCull</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Bounds.html">Bounds</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.BringToTop.html">BringToTop</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Core.html">Core</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Crop.html">Crop</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Delta.html">Delta</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Destroy.html">Destroy</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.FixedToCamera.html">FixedToCamera</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Health.html">Health</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.InCamera.html">InCamera</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.InputEnabled.html">InputEnabled</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.InWorld.html">InWorld</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.LifeSpan.html">LifeSpan</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.LoadTexture.html">LoadTexture</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Overlap.html">Overlap</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.PhysicsBody.html">PhysicsBody</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Reset.html">Reset</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.ScaleMinMax.html">ScaleMinMax</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Smoothed.html">Smoothed</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Create.html">Create</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Creature.html">Creature</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Device.html">Device</a>
</li>
<li class="class-depth-1">
<a href="Phaser.DeviceButton.html">DeviceButton</a>
</li>
<li class="class-depth-1">
<a href="Phaser.DOM.html">DOM</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Easing.html">Easing</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Back.html">Back</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Bounce.html">Bounce</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Circular.html">Circular</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Cubic.html">Cubic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Elastic.html">Elastic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Exponential.html">Exponential</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Linear.html">Linear</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quadratic.html">Quadratic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quartic.html">Quartic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quintic.html">Quintic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Ellipse.html">Ellipse</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Events.html">Events</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Filter.html">Filter</a>
</li>
<li class="class-depth-1">
<a href="Phaser.FlexGrid.html">FlexGrid</a>
</li>
<li class="class-depth-1">
<a href="Phaser.FlexLayer.html">FlexLayer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Frame.html">Frame</a>
</li>
<li class="class-depth-1">
<a href="Phaser.FrameData.html">FrameData</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Game.html">Game</a>
</li>
<li class="class-depth-1">
<a href="Phaser.GameObjectCreator.html">GameObjectCreator</a>
</li>
<li class="class-depth-1">
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Gamepad.html">Gamepad</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Graphics.html">Graphics</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Group.html">Group</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Image.html">Image</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ImageCollection.html">ImageCollection</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Input.html">Input</a>
</li>
<li class="class-depth-1">
<a href="Phaser.InputHandler.html">InputHandler</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Key.html">Key</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Keyboard.html">Keyboard</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Line.html">Line</a>
</li>
<li class="class-depth-1">
<a href="Phaser.LinkedList.html">LinkedList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Loader.html">Loader</a>
</li>
<li class="class-depth-1">
<a href="Phaser.LoaderParser.html">LoaderParser</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Math.html">Math</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Matrix.html">Matrix</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Mouse.html">Mouse</a>
</li>
<li class="class-depth-1">
<a href="Phaser.MSPointer.html">MSPointer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Net.html">Net</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Particle.html">Particle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Physics.html">Physics</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Physics.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Arcade.Body.html">Body</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Arcade.html#TilemapCollision">TilemapCollision</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Physics.Ninja.html">Ninja</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.AABB.html">AABB</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Body.html">Body</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Circle.html">Circle</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Tile.html">Tile</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Physics.P2.html">P2</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Body.html">Body</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.BodyDebug.html">BodyDebug</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.DistanceConstraint.html">DistanceConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.FixtureList.html">FixtureList</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.GearConstraint.html">GearConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.InversePointProxy.html">InversePointProxy</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.LockConstraint.html">LockConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Material.html">Material</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PointProxy.html">PointProxy</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PrismaticConstraint.html">PrismaticConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RevoluteConstraint.html">RevoluteConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RotationalSpring.html">RotationalSpring</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Spring.html">Spring</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Plugin.html">Plugin</a>
</li>
<li class="class-depth-1">
<a href="Phaser.PluginManager.html">PluginManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Point.html">Point</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Pointer.html">Pointer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Polygon.html">Polygon</a>
</li>
<li class="class-depth-1">
<a href="Phaser.QuadTree.html">QuadTree</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Rectangle.html">Rectangle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RenderTexture.html">RenderTexture</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RetroFont.html">RetroFont</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Rope.html">Rope</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RoundedRectangle.html">RoundedRectangle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ScaleManager.html">ScaleManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Signal.html">Signal</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SignalBinding.html">SignalBinding</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SinglePad.html">SinglePad</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Sound.html">Sound</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SoundManager.html">SoundManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Sprite.html">Sprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SpriteBatch.html">SpriteBatch</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Stage.html">Stage</a>
</li>
<li class="class-depth-1">
<a href="Phaser.State.html">State</a>
</li>
<li class="class-depth-1">
<a href="Phaser.StateManager.html">StateManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Text.html">Text</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tile.html">Tile</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tilemap.html">Tilemap</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TilemapParser.html">TilemapParser</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tileset.html">Tileset</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Time.html">Time</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Timer.html">Timer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TimerEvent.html">TimerEvent</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Touch.html">Touch</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tween.html">Tween</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TweenData.html">TweenData</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TweenManager.html">TweenManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Utils.html">Utils</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Utils.Debug.html">Debug</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Video.html">Video</a>
</li>
<li class="class-depth-1">
<a href="Phaser.World.html">World</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AbstractFilter.html">AbstractFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BaseTexture.html">BaseTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasBuffer.html">CanvasBuffer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasGraphics.html">CanvasGraphics</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasMaskManager.html">CanvasMaskManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasRenderer.html">CanvasRenderer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasTinter.html">CanvasTinter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ComplexPrimitiveShader.html">ComplexPrimitiveShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DisplayObject.html">DisplayObject</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DisplayObjectContainer.html">DisplayObjectContainer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Event.html">Event</a>
</li>
<li class="class-depth-1">
<a href="PIXI.EventTarget.html">EventTarget</a>
</li>
<li class="class-depth-1">
<a href="PIXI.FilterTexture.html">FilterTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Graphics.html">Graphics</a>
</li>
<li class="class-depth-1">
<a href="PIXI.GraphicsData.html">GraphicsData</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PIXI.html">PIXI</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PixiFastShader.html">PixiFastShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PixiShader.html">PixiShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PolyK.html">PolyK</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PrimitiveShader.html">PrimitiveShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.RenderTexture.html">RenderTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Rope.html">Rope</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Sprite.html">Sprite</a>
</li>
<li class="class-depth-1">
<a href="PIXI.SpriteBatch.html">SpriteBatch</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Stage.html">Stage</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Strip.html">Strip</a>
</li>
<li class="class-depth-1">
<a href="PIXI.StripShader.html">StripShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Texture.html">Texture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.TilingSprite.html">TilingSprite</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLBlendModeManager.html">WebGLBlendModeManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLFastSpriteBatch.html">WebGLFastSpriteBatch</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLFilterManager.html">WebGLFilterManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLRenderer.html">WebGLRenderer</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-0">
<a href="global.html#AUTO">AUTO</a>
</li>
<li class="class-depth-0">
<a href="global.html#BITMAPDATA">BITMAPDATA</a>
</li>
<li class="class-depth-0">
<a href="global.html#BITMAPTEXT">BITMAPTEXT</a>
</li>
<li class="class-depth-0">
<a href="global.html#blendModes">blendModes</a>
</li>
<li class="class-depth-0">
<a href="global.html#BUTTON">BUTTON</a>
</li>
<li class="class-depth-0">
<a href="global.html#CANVAS">CANVAS</a>
</li>
<li class="class-depth-0">
<a href="global.html#CANVAS_FILTER">CANVAS_FILTER</a>
</li>
<li class="class-depth-0">
<a href="global.html#CIRCLE">CIRCLE</a>
</li>
<li class="class-depth-0">
<a href="global.html#CREATURE">CREATURE</a>
</li>
<li class="class-depth-0">
<a href="global.html#DOWN">DOWN</a>
</li>
<li class="class-depth-0">
<a href="global.html#ELLIPSE">ELLIPSE</a>
</li>
<li class="class-depth-0">
<a href="global.html#EMITTER">EMITTER</a>
</li>
<li class="class-depth-0">
<a href="global.html#GAMES">GAMES</a>
</li>
<li class="class-depth-0">
<a href="global.html#GRAPHICS">GRAPHICS</a>
</li>
<li class="class-depth-0">
<a href="global.html#GROUP">GROUP</a>
</li>
<li class="class-depth-0">
<a href="global.html#HEADLESS">HEADLESS</a>
</li>
<li class="class-depth-0">
<a href="global.html#IMAGE">IMAGE</a>
</li>
<li class="class-depth-0">
<a href="global.html#LEFT">LEFT</a>
</li>
<li class="class-depth-0">
<a href="global.html#LINE">LINE</a>
</li>
<li class="class-depth-0">
<a href="global.html#MATRIX">MATRIX</a>
</li>
<li class="class-depth-0">
<a href="global.html#NONE">NONE</a>
</li>
<li class="class-depth-0">
<a href="global.html#POINT">POINT</a>
</li>
<li class="class-depth-0">
<a href="global.html#POINTER">POINTER</a>
</li>
<li class="class-depth-0">
<a href="global.html#POLYGON">POLYGON</a>
</li>
<li class="class-depth-0">
<a href="global.html#RECTANGLE">RECTANGLE</a>
</li>
<li class="class-depth-0">
<a href="global.html#RENDERTEXTURE">RENDERTEXTURE</a>
</li>
<li class="class-depth-0">
<a href="global.html#RETROFONT">RETROFONT</a>
</li>
<li class="class-depth-0">
<a href="global.html#RIGHT">RIGHT</a>
</li>
<li class="class-depth-0">
<a href="global.html#ROPE">ROPE</a>
</li>
<li class="class-depth-0">
<a href="global.html#ROUNDEDRECTANGLE">ROUNDEDRECTANGLE</a>
</li>
<li class="class-depth-0">
<a href="global.html#scaleModes">scaleModes</a>
</li>
<li class="class-depth-0">
<a href="global.html#SPRITE">SPRITE</a>
</li>
<li class="class-depth-0">
<a href="global.html#SPRITEBATCH">SPRITEBATCH</a>
</li>
<li class="class-depth-0">
<a href="global.html#TEXT">TEXT</a>
</li>
<li class="class-depth-0">
<a href="global.html#TILEMAP">TILEMAP</a>
</li>
<li class="class-depth-0">
<a href="global.html#TILEMAPLAYER">TILEMAPLAYER</a>
</li>
<li class="class-depth-0">
<a href="global.html#TILESPRITE">TILESPRITE</a>
</li>
<li class="class-depth-0">
<a href="global.html#UP">UP</a>
</li>
<li class="class-depth-0">
<a href="global.html#VERSION">VERSION</a>
</li>
<li class="class-depth-0">
<a href="global.html#VIDEO">VIDEO</a>
</li>
<li class="class-depth-0">
<a href="global.html#WEBGL">WEBGL</a>
</li>
<li class="class-depth-0">
<a href="global.html#WEBGL_FILTER">WEBGL_FILTER</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Core<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.Game.html">Game</a></li>
<li class="class-depth-1"><a href="Phaser.Group.html">Group</a></li>
<li class="class-depth-1"><a href="Phaser.World.html">World</a></li>
<li class="class-depth-1"><a href="Phaser.Loader.html">Loader</a></li>
<li class="class-depth-1"><a href="Phaser.Cache.html">Cache</a></li>
<li class="class-depth-1"><a href="Phaser.Time.html">Time</a></li>
<li class="class-depth-1"><a href="Phaser.Camera.html">Camera</a></li>
<li class="class-depth-1"><a href="Phaser.StateManager.html">State Manager</a></li>
<li class="class-depth-1"><a href="Phaser.TweenManager.html">Tween Manager</a></li>
<li class="class-depth-1"><a href="Phaser.SoundManager.html">Sound Manager</a></li>
<li class="class-depth-1"><a href="Phaser.Input.html">Input Manager</a></li>
<li class="class-depth-1"><a href="Phaser.ScaleManager.html">Scale Manager</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Game Objects<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.GameObjectFactory.html">Factory (game.add)</a></li>
<li class="class-depth-1"><a href="Phaser.GameObjectCreator.html">Creator (game.make)</a></li>
<li class="class-depth-1"><a href="Phaser.Sprite.html">Sprite</a></li>
<li class="class-depth-1"><a href="Phaser.Image.html">Image</a></li>
<li class="class-depth-1"><a href="Phaser.Sound.html">Sound</a></li>
<li class="class-depth-1"><a href="Phaser.Video.html">Video</a></li>
<li class="class-depth-1"><a href="Phaser.Particles.Arcade.Emitter.html">Particle Emitter</a></li>
<li class="class-depth-1"><a href="Phaser.Particle.html">Particle</a></li>
<li class="class-depth-1"><a href="Phaser.Text.html">Text</a></li>
<li class="class-depth-1"><a href="Phaser.Tween.html">Tween</a></li>
<li class="class-depth-1"><a href="Phaser.BitmapText.html">BitmapText</a></li>
<li class="class-depth-1"><a href="Phaser.Tilemap.html">Tilemap</a></li>
<li class="class-depth-1"><a href="Phaser.BitmapData.html">BitmapData</a></li>
<li class="class-depth-1"><a href="Phaser.RetroFont.html">RetroFont</a></li>
<li class="class-depth-1"><a href="Phaser.Button.html">Button</a></li>
<li class="class-depth-1"><a href="Phaser.Animation.html">Animation</a></li>
<li class="class-depth-1"><a href="Phaser.Graphics.html">Graphics</a></li>
<li class="class-depth-1"><a href="Phaser.RenderTexture.html">RenderTexture</a></li>
<li class="class-depth-1"><a href="Phaser.TileSprite.html">TileSprite</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Geometry<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.Circle.html">Circle</a></li>
<li class="class-depth-1"><a href="Phaser.Ellipse.html">Ellipse</a></li>
<li class="class-depth-1"><a href="Phaser.Line.html">Line</a></li>
<li class="class-depth-1"><a href="Phaser.Matrix.html">Matrix</a></li>
<li class="class-depth-1"><a href="Phaser.Point.html">Point</a></li>
<li class="class-depth-1"><a href="Phaser.Polygon.html">Polygon</a></li>
<li class="class-depth-1"><a href="Phaser.Rectangle.html">Rectangle</a></li>
<li class="class-depth-1"><a href="Phaser.RoundedRectangle.html">Rounded Rectangle</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Physics<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.Physics.Arcade.html">Arcade Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.Arcade.Body.html">Body</a></li>
<li class="class-depth-1"><a href="Phaser.Physics.P2.html">P2 Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.Body.html">Body</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.Spring.html">Spring</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a></li>
<li class="class-depth-1"><a href="Phaser.Physics.Ninja.html">Ninja Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.Body.html">Body</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Input<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.InputHandler.html">Input Handler</a></li>
<li class="class-depth-1"><a href="Phaser.Pointer.html">Pointer</a></li>
<li class="class-depth-1"><a href="Phaser.DeviceButton.html">Device Button</a></li>
<li class="class-depth-1"><a href="Phaser.Mouse.html">Mouse</a></li>
<li class="class-depth-1"><a href="Phaser.Keyboard.html">Keyboard</a></li>
<li class="class-depth-1"><a href="Phaser.Key.html">Key</a></li>
<li class="class-depth-1"><a href="Phaser.Gamepad.html">Gamepad</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Community<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="http://phaser.io">Phaser Web Site</a></li>
<li class="class-depth-1"><a href="https://github.com/photonstorm/phaser">Phaser Github</a></li>
<li class="class-depth-1"><a href="http://phaser.io/examples">Phaser Examples</a></li>
<li class="class-depth-1"><a href="https://github.com/photonstorm/phaser-plugins">Phaser Plugins</a></li>
<li class="class-depth-1"><a href="http://www.html5gamedevs.com/forum/14-phaser/">Forum</a></li>
<li class="class-depth-1"><a href="http://stackoverflow.com/questions/tagged/phaser-framework">Stack Overflow</a></li>
<li class="class-depth-1"><a href="http://phaser.io/learn">Tutorials</a></li>
<li class="class-depth-1"><a href="https://confirmsubscription.com/h/r/369DE48E3E86AF1E">Newsletter</a></li>
<li class="class-depth-1"><a href="http://phaser.io/community/twitter">Twitter</a></li>
<li class="class-depth-1"><a href="http://phaser.io/community/irc">IRC</a></li>
<li class="class-depth-1"><a href="https://www.codeandweb.com/texturepacker/phaser">Texture Packer</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span8">
<div id="main">
<!--<h1 class="page-title">Class: Loader</h1>-->
<section>
<header>
<h2>
<span class="ancestors"><a href="Phaser.html">Phaser</a>.</span>
Loader
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name "
id="Loader"><span class="type-signature"></span>new Loader<span class="signature">(game)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The Loader handles loading all external content such as Images, Sounds, Texture Atlases and data files.</p>
<p>The loader uses a combination of tag loading (eg. Image elements) and XHR and provides progress and completion callbacks.</p>
<p>Parallel loading (see <a href="Phaser.Loader.html#enableParallel">enableParallel</a>) is supported and enabled by default.
Load-before behavior of parallel resources is controlled by synchronization points as discussed in withSyncPoint.</p>
<p>Texture Atlases can be created with tools such as <a href="https://www.codeandweb.com/texturepacker/phaser">Texture Packer</a> and
<a href="http://renderhjs.net/shoebox/">Shoebox</a></p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>game</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span>
</td>
<td class="description last"><p>A reference to the currently running game.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-22">line 22</a>
</dt>
</dl>
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name "
id="PHYSICS_LIME_CORONA_JSON"><span class="type-signature">&lt;static, constant> </span>PHYSICS_LIME_CORONA_JSON<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-299">line 299</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="PHYSICS_PHASER_JSON"><span class="type-signature">&lt;static, constant> </span>PHYSICS_PHASER_JSON<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-305">line 305</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="TEXTURE_ATLAS_JSON_ARRAY"><span class="type-signature">&lt;static, constant> </span>TEXTURE_ATLAS_JSON_ARRAY<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-281">line 281</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="TEXTURE_ATLAS_JSON_HASH"><span class="type-signature">&lt;static, constant> </span>TEXTURE_ATLAS_JSON_HASH<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-287">line 287</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="TEXTURE_ATLAS_XML_STARLING"><span class="type-signature">&lt;static, constant> </span>TEXTURE_ATLAS_XML_STARLING<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-293">line 293</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="_withSyncPointDepth"><span class="type-signature"></span>_withSyncPointDepth<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>A counter: if more than zero, files will be automatically added as a synchronization point.</p>
</div>
<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>_withSyncPointDepth;</code></td>
<td class="type">
<span class="param-type">integer</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-204">line 204</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="baseURL"><span class="type-signature"></span>baseURL<span class="type-signature"> :string</span></h4>
</dt>
<dd>
<div class="description">
<p>If you want to append a URL before the path of any asset you can set this here.
Useful if allowing the asset base url to be configured outside of the game code.
The string <em>must</em> end with a &quot;/&quot;.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-83">line 83</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="cache"><span class="type-signature">&lt;internal> </span>cache<span class="type-signature"> :<a href="Phaser.Cache.html">Phaser.Cache</a></span></h4>
</dt>
<dd>
<div class="description">
<p>Local reference to the Phaser.Cache.</p>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-36">line 36</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="crossOrigin"><span class="type-signature"></span>crossOrigin<span class="type-signature"> :boolean|string</span></h4>
</dt>
<dd>
<div class="description">
<p>The crossOrigin value applied to loaded images. Very often this needs to be set to 'anonymous'.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
|
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-74">line 74</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="enableParallel"><span class="type-signature"></span>enableParallel<span class="type-signature"> :integer</span></h4>
</dt>
<dd>
<div class="description">
<p>If true (the default) then parallel downloading will be enabled.</p>
<p>To disable all parallel downloads this must be set to false prior to any resource being loaded.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-188">line 188</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="game"><span class="type-signature">&lt;internal> </span>game<span class="type-signature"> :<a href="Phaser.Game.html">Phaser.Game</a></span></h4>
</dt>
<dd>
<div class="description">
<p>Local reference to game.</p>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-29">line 29</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="hasLoaded"><span class="type-signature"></span>hasLoaded<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>True if all assets in the queue have finished loading.</p>
</div>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-57">line 57</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="isLoading"><span class="type-signature"></span>isLoading<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>True if the Loader is in the process of loading the queue.</p>
</div>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-50">line 50</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="maxParallelDownloads"><span class="type-signature">&lt;internal> </span>maxParallelDownloads<span class="type-signature"> :integer</span></h4>
</dt>
<dd>
<div class="description">
<p>The number of concurrent / parallel resources to try and fetch at once.</p>
<p>Many current browsers limit 6 requests per domain; this is slightly conservative.</p>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-198">line 198</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="onFileComplete"><span class="type-signature"></span>onFileComplete<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4>
</dt>
<dd>
<div class="description">
<p>This event is dispatched when a file has either loaded or failed to load.</p>
<p>Any function bound to this will receive the following parameters:</p>
<p>progress, file key, success?, total loaded files, total files</p>
<p>Where progress is a number between 1 and 100 (inclusive) representing the percentage of the load.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-152">line 152</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="onFileError"><span class="type-signature"></span>onFileError<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4>
</dt>
<dd>
<div class="description">
<p>This event is dispatched when a file (or pack) errors as a result of the load request.</p>
<p>For files it will be triggered before <code>onFileComplete</code>. For packs it will be triggered before <code>onPackComplete</code>.</p>
<p>Params: <code>(file key, file)</code></p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-163">line 163</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="onFileStart"><span class="type-signature"></span>onFileStart<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4>
</dt>
<dd>
<div class="description">
<p>This event is dispatched immediately before a file starts loading.
It's possible the file may fail (eg. download error, invalid format) after this event is sent.</p>
<p>Params: <code>(progress, file key, file url)</code></p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-139">line 139</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="onLoadComplete"><span class="type-signature"></span>onLoadComplete<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4>
</dt>
<dd>
<div class="description">
<p>This event is dispatched when the final file in the load queue has either loaded or failed.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-118">line 118</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="onLoadStart"><span class="type-signature"></span>onLoadStart<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4>
</dt>
<dd>
<div class="description">
<p>This event is dispatched when the loading process starts: before the first file has been requested,
but after all the initial packs have been loaded.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-111">line 111</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="onPackComplete"><span class="type-signature"></span>onPackComplete<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4>
</dt>
<dd>
<div class="description">
<p>This event is dispatched when an asset pack has either loaded or failed to load.</p>
<p>This is called when the asset pack manifest file has loaded and successfully added its contents to the loader queue.</p>
<p>Params: <code>(pack key, success?, total packs loaded, total packs)</code></p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-129">line 129</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="path"><span class="type-signature"></span>path<span class="type-signature"> :string</span></h4>
</dt>
<dd>
<div class="description">
<p>The value of <code>path</code>, if set, is placed before any <em>relative</em> file path given. For example:</p>
<p><code>load.path = &quot;images/sprites/&quot;;
load.image(&quot;ball&quot;, &quot;ball.png&quot;);
load.image(&quot;tree&quot;, &quot;level1/oaktree.png&quot;);
load.image(&quot;boom&quot;, &quot;http://server.com/explode.png&quot;);</code></p>
<p>Would load the <code>ball</code> file from <code>images/sprites/ball.png</code> and the tree from
<code>images/sprites/level1/oaktree.png</code> but the file <code>boom</code> would load from the URL
given as it's an absolute URL.</p>
<p>Please note that the path is added before the filename but <em>after</em> the baseURL (if set.)</p>
<p>The string <em>must</em> end with a &quot;/&quot;.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-103">line 103</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="preloadSprite"><span class="type-signature">&lt;internal> </span>preloadSprite<span class="type-signature"> :object</span></h4>
</dt>
<dd>
<div class="description">
<p>You can optionally link a progress sprite with <a href="Phaser.Loader.html#setPreloadSprite">setPreloadSprite</a>.</p>
<p>This property is an object containing: sprite, rect, direction, width and height</p>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-67">line 67</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="progress"><span class="type-signature"></span>progress<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The rounded load progress percentage value (from 0 to 100). See <a href="Phaser.Loader.html#progressFloat">Phaser.Loader#progressFloat</a>.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
<span class="param-type">integer</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-2926">line 2926</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="progressFloat"><span class="type-signature"></span>progressFloat<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The non-rounded load progress value (from 0.0 to 100.0).</p>
<p>A general indicator of the progress.
It is possible for the progress to decrease, after <code>onLoadStart</code>, if more files are dynamically added.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-2908">line 2908</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="resetLocked"><span class="type-signature"></span>resetLocked<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>If true all calls to Loader.reset will be ignored. Useful if you need to create a load queue before swapping to a preloader state.</p>
</div>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-43">line 43</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name toc-deprecated"
id="useXDomainRequest"><span class="type-signature"></span>useXDomainRequest<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<dt class="important deprecated-notice">
This method is <em>deprecated</em> and should not be used. It may be removed in the future.
</dt>
<div class="description">
<p>If true and if the browser supports XDomainRequest, it will be used in preference for XHR.</p>
<p>This is only relevant for IE 9 and should <em>only</em> be enabled for IE 9 clients when required by the server/CDN.</p>
</div>
<dl class="details">
<dt class="important tag-deprecated">Deprecated:</dt>
<dd class="tag-deprecated"><ul>
<li>This is only relevant for IE 9.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-173">line 173</a>
</dt>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name "
id="addSyncPoint"><span class="type-signature"></span>addSyncPoint<span class="signature">(type, key)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Add a synchronization point to a specific file/asset in the load queue.</p>
<p>This has no effect on already loaded assets.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The type of resource to turn into a sync point (image, audio, xml, etc).</p></td>
</tr>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Key of the file you want to turn into a sync point.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-1572">line 1572</a>
</dt>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li>withSyncPoint</li>
</ul>
</dd>
</dl>
</dd>
<dt>
<h4 class="name "
id="addToFileList"><span class="type-signature">&lt;internal> </span>addToFileList<span class="signature">(type, key, <span class="optional">url</span>, <span class="optional">properties</span>, <span class="optional">overwrite</span>, <span class="optional">extension</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Internal function that adds a new entry to the file list. Do not call directly.</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">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The type of resource to add to the list (image, audio, xml, etc).</p></td>
</tr>
<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 Cache ID key of this resource.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>The URL the asset will be loaded from.</p></td>
</tr>
<tr>
<td class="name"><code>properties</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
(none)
</td>
<td class="description last"><p>Any additional properties needed to load the file. These are added directly to the added file object and overwrite any defaults.</p></td>
</tr>
<tr>
<td class="name"><code>overwrite</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>If true then this will overwrite a file asset of the same type/key. Otherwise it will will only add a new asset. If overwrite is true, and the asset is already being loaded (or has been loaded), then it is appended instead.</p></td>
</tr>
<tr>
<td class="name"><code>extension</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>If no URL is given the Loader will sometimes auto-generate the URL based on the key, using this as the extension.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This instance of the Phaser Loader.</p>
</div>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-486">line 486</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="atlas"><span class="type-signature"></span>atlas<span class="signature">(key, <span class="optional">textureURL</span>, <span class="optional">atlasURL</span>, <span class="optional">atlasData</span>, <span class="optional">format</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Adds a Texture Atlas file to the current load queue.</p>
<p>To create the Texture Atlas you can use tools such as:</p>
<p><a href="https://www.codeandweb.com/texturepacker/phaser">Texture Packer</a>
<a href="http://renderhjs.net/shoebox/">Shoebox</a></p>
<p>If using Texture Packer we recommend you enable &quot;Trim sprite names&quot;.
If your atlas software has an option to &quot;rotate&quot; the resulting frames, you must disable it.</p>
<p>You can choose to either load the data externally, by providing a URL to a json file.
Or you can pass in a JSON object or String via the <code>atlasData</code> parameter.
If you pass a String the data is automatically run through <code>JSON.parse</code> and then immediately added to the Phaser.Cache.</p>
<p>If URLs are provided the files are <strong>not</strong> loaded immediately after calling this method, but are added to the load queue.</p>
<p>The key must be a unique String. It is used to add the file to the Phaser.Cache upon successful load.</p>
<p>Retrieve the file via <code>Cache.getImage(key)</code>. JSON files are automatically parsed upon load.
If you need to control when the JSON is parsed then use <code>Loader.text</code> instead and parse the JSON file as needed.</p>
<p>The URLs can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the textureURL isn't specified then the Loader will take the key and create a filename from that.
For example if the key is &quot;player&quot; and textureURL is null then the Loader will set the URL to be &quot;player.png&quot;.
The same is true for the atlasURL. If atlasURL isn't specified and no atlasData has been provided then the Loader will
set the atlasURL to be the key. For example if the key is &quot;player&quot; the atlasURL will be set to &quot;player.json&quot;.</p>
<p>If you do not desire this action then provide URLs and / or a data object.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</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="description last"><p>Unique asset key of the texture atlas file.</p></td>
</tr>
<tr>
<td class="name"><code>textureURL</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>URL of the texture atlas image file. If undefined or <code>null</code> the url will be set to <code>&lt;key&gt;.png</code>, i.e. if <code>key</code> was &quot;alien&quot; then the URL will be &quot;alien.png&quot;.</p></td>
</tr>
<tr>
<td class="name"><code>atlasURL</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>URL of the texture atlas data file. If undefined or <code>null</code> and no atlasData is given, the url will be set to <code>&lt;key&gt;.json</code>, i.e. if <code>key</code> was &quot;alien&quot; then the URL will be &quot;alien.json&quot;.</p></td>
</tr>
<tr>
<td class="name"><code>atlasData</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>A JSON or XML data object. You don't need this if the data is being loaded from a URL.</p></td>
</tr>
<tr>
<td class="name"><code>format</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The format of the data. Can be Phaser.Loader.TEXTURE_ATLAS_JSON_ARRAY (the default), Phaser.Loader.TEXTURE_ATLAS_JSON_HASH or Phaser.Loader.TEXTURE_ATLAS_XML_STARLING.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-1441">line 1441</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="atlasJSONArray"><span class="type-signature"></span>atlasJSONArray<span class="signature">(key, <span class="optional">textureURL</span>, <span class="optional">atlasURL</span>, <span class="optional">atlasData</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Adds a Texture Atlas file to the current load queue.</p>
<p>Unlike <code>Loader.atlasJSONHash</code> this call expects the atlas data to be in a JSON Array format.</p>
<p>To create the Texture Atlas you can use tools such as:</p>
<p><a href="https://www.codeandweb.com/texturepacker/phaser">Texture Packer</a>
<a href="http://renderhjs.net/shoebox/">Shoebox</a></p>
<p>If using Texture Packer we recommend you enable &quot;Trim sprite names&quot;.
If your atlas software has an option to &quot;rotate&quot; the resulting frames, you must disable it.</p>
<p>You can choose to either load the data externally, by providing a URL to a json file.
Or you can pass in a JSON object or String via the <code>atlasData</code> parameter.
If you pass a String the data is automatically run through <code>JSON.parse</code> and then immediately added to the Phaser.Cache.</p>
<p>If URLs are provided the files are <strong>not</strong> loaded immediately after calling this method, but are added to the load queue.</p>
<p>The key must be a unique String. It is used to add the file to the Phaser.Cache upon successful load.</p>
<p>Retrieve the file via <code>Cache.getImage(key)</code>. JSON files are automatically parsed upon load.
If you need to control when the JSON is parsed then use <code>Loader.text</code> instead and parse the JSON file as needed.</p>
<p>The URLs can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the textureURL isn't specified then the Loader will take the key and create a filename from that.
For example if the key is &quot;player&quot; and textureURL is null then the Loader will set the URL to be &quot;player.png&quot;.
The same is true for the atlasURL. If atlasURL isn't specified and no atlasData has been provided then the Loader will
set the atlasURL to be the key. For example if the key is &quot;player&quot; the atlasURL will be set to &quot;player.json&quot;.</p>
<p>If you do not desire this action then provide URLs and / or a data object.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</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="description last"><p>Unique asset key of the texture atlas file.</p></td>
</tr>
<tr>
<td class="name"><code>textureURL</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>URL of the texture atlas image file. If undefined or <code>null</code> the url will be set to <code>&lt;key&gt;.png</code>, i.e. if <code>key</code> was &quot;alien&quot; then the URL will be &quot;alien.png&quot;.</p></td>
</tr>
<tr>
<td class="name"><code>atlasURL</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>URL of the texture atlas data file. If undefined or <code>null</code> and no atlasData is given, the url will be set to <code>&lt;key&gt;.json</code>, i.e. if <code>key</code> was &quot;alien&quot; then the URL will be &quot;alien.json&quot;.</p></td>
</tr>
<tr>
<td class="name"><code>atlasData</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>A JSON data object. You don't need this if the data is being loaded from a URL.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-1295">line 1295</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="atlasJSONHash"><span class="type-signature"></span>atlasJSONHash<span class="signature">(key, <span class="optional">textureURL</span>, <span class="optional">atlasURL</span>, <span class="optional">atlasData</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Adds a Texture Atlas file to the current load queue.</p>
<p>Unlike <code>Loader.atlas</code> this call expects the atlas data to be in a JSON Hash format.</p>
<p>To create the Texture Atlas you can use tools such as:</p>
<p><a href="https://www.codeandweb.com/texturepacker/phaser">Texture Packer</a>
<a href="http://renderhjs.net/shoebox/">Shoebox</a></p>
<p>If using Texture Packer we recommend you enable &quot;Trim sprite names&quot;.
If your atlas software has an option to &quot;rotate&quot; the resulting frames, you must disable it.</p>
<p>You can choose to either load the data externally, by providing a URL to a json file.
Or you can pass in a JSON object or String via the <code>atlasData</code> parameter.
If you pass a String the data is automatically run through <code>JSON.parse</code> and then immediately added to the Phaser.Cache.</p>
<p>If URLs are provided the files are <strong>not</strong> loaded immediately after calling this method, but are added to the load queue.</p>
<p>The key must be a unique String. It is used to add the file to the Phaser.Cache upon successful load.</p>
<p>Retrieve the file via <code>Cache.getImage(key)</code>. JSON files are automatically parsed upon load.
If you need to control when the JSON is parsed then use <code>Loader.text</code> instead and parse the JSON file as needed.</p>
<p>The URLs can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the textureURL isn't specified then the Loader will take the key and create a filename from that.
For example if the key is &quot;player&quot; and textureURL is null then the Loader will set the URL to be &quot;player.png&quot;.
The same is true for the atlasURL. If atlasURL isn't specified and no atlasData has been provided then the Loader will
set the atlasURL to be the key. For example if the key is &quot;player&quot; the atlasURL will be set to &quot;player.json&quot;.</p>
<p>If you do not desire this action then provide URLs and / or a data object.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</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="description last"><p>Unique asset key of the texture atlas file.</p></td>
</tr>
<tr>
<td class="name"><code>textureURL</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>URL of the texture atlas image file. If undefined or <code>null</code> the url will be set to <code>&lt;key&gt;.png</code>, i.e. if <code>key</code> was &quot;alien&quot; then the URL will be &quot;alien.png&quot;.</p></td>
</tr>
<tr>
<td class="name"><code>atlasURL</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>URL of the texture atlas data file. If undefined or <code>null</code> and no atlasData is given, the url will be set to <code>&lt;key&gt;.json</code>, i.e. if <code>key</code> was &quot;alien&quot; then the URL will be &quot;alien.json&quot;.</p></td>
</tr>
<tr>
<td class="name"><code>atlasData</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>A JSON data object. You don't need this if the data is being loaded from a URL.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-1341">line 1341</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="atlasXML"><span class="type-signature"></span>atlasXML<span class="signature">(key, <span class="optional">textureURL</span>, <span class="optional">atlasURL</span>, <span class="optional">atlasData</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Adds a Texture Atlas file to the current load queue.</p>
<p>This call expects the atlas data to be in the Starling XML data format.</p>
<p>To create the Texture Atlas you can use tools such as:</p>
<p><a href="https://www.codeandweb.com/texturepacker/phaser">Texture Packer</a>
<a href="http://renderhjs.net/shoebox/">Shoebox</a></p>
<p>If using Texture Packer we recommend you enable &quot;Trim sprite names&quot;.
If your atlas software has an option to &quot;rotate&quot; the resulting frames, you must disable it.</p>
<p>You can choose to either load the data externally, by providing a URL to an xml file.
Or you can pass in an XML object or String via the <code>atlasData</code> parameter.
If you pass a String the data is automatically run through <code>Loader.parseXML</code> and then immediately added to the Phaser.Cache.</p>
<p>If URLs are provided the files are <strong>not</strong> loaded immediately after calling this method, but are added to the load queue.</p>
<p>The key must be a unique String. It is used to add the file to the Phaser.Cache upon successful load.</p>
<p>Retrieve the file via <code>Cache.getImage(key)</code>. XML files are automatically parsed upon load.
If you need to control when the XML is parsed then use <code>Loader.text</code> instead and parse the XML file as needed.</p>
<p>The URLs can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the textureURL isn't specified then the Loader will take the key and create a filename from that.
For example if the key is &quot;player&quot; and textureURL is null then the Loader will set the URL to be &quot;player.png&quot;.
The same is true for the atlasURL. If atlasURL isn't specified and no atlasData has been provided then the Loader will
set the atlasURL to be the key. For example if the key is &quot;player&quot; the atlasURL will be set to &quot;player.xml&quot;.</p>
<p>If you do not desire this action then provide URLs and / or a data object.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</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="description last"><p>Unique asset key of the texture atlas file.</p></td>
</tr>
<tr>
<td class="name"><code>textureURL</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>URL of the texture atlas image file. If undefined or <code>null</code> the url will be set to <code>&lt;key&gt;.png</code>, i.e. if <code>key</code> was &quot;alien&quot; then the URL will be &quot;alien.png&quot;.</p></td>
</tr>
<tr>
<td class="name"><code>atlasURL</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>URL of the texture atlas data file. If undefined or <code>null</code> and no atlasData is given, the url will be set to <code>&lt;key&gt;.json</code>, i.e. if <code>key</code> was &quot;alien&quot; then the URL will be &quot;alien.xml&quot;.</p></td>
</tr>
<tr>
<td class="name"><code>atlasData</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>An XML data object. You don't need this if the data is being loaded from a URL.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-1387">line 1387</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="audio"><span class="type-signature"></span>audio<span class="signature">(key, urls, <span class="optional">autoDecode</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Adds an audio file to the current load queue.</p>
<p>The file is <strong>not</strong> loaded immediately after calling this method. The file is added to the queue ready to be loaded when the loader starts.</p>
<p>The key must be a unique String. It is used to add the file to the Phaser.Cache upon successful load.</p>
<p>Retrieve the file via <code>Cache.getSound(key)</code>.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>Mobile warning: There are some mobile devices (certain iPad 2 and iPad Mini revisions) that cannot play 48000 Hz audio.
When they try to play the audio becomes extremely distorted and buzzes, eventually crashing the sound system.
The solution is to use a lower encoding rate such as 44100 Hz.</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>Unique asset key of the audio file.</p></td>
</tr>
<tr>
<td class="name"><code>urls</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">Array.&lt;string></span>
|
<span class="param-type">Array.&lt;object></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Either a single string or an array of URIs or pairs of <code>{uri: .., type: ..}</code>.
If an array is specified then the first URI (or URI + mime pair) that is device-compatible will be selected.
For example: <code>&quot;jump.mp3&quot;</code>, <code>['jump.mp3', 'jump.ogg', 'jump.m4a']</code>, or <code>[{uri: &quot;data:&lt;opus_resource&gt;&quot;, type: 'opus'}, 'fallback.mp3']</code>.
BLOB and DATA URIs can be used but only support automatic detection when used in the pair form; otherwise the format must be manually checked before adding the resource.</p></td>
</tr>
<tr>
<td class="name"><code>autoDecode</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>When using Web Audio the audio files can either be decoded at load time or run-time.
Audio files can't be played until they are decoded and, if specified, this enables immediate decoding. Decoding is a non-blocking async process, however it consumes huge amounts of CPU time on mobiles especially.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-917">line 917</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="audiosprite"><span class="type-signature"></span>audiosprite<span class="signature">(key, urls, <span class="optional">jsonURL</span>, <span class="optional">jsonData</span>, <span class="optional">autoDecode</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Adds an audio sprite file to the current load queue.</p>
<p>The file is <strong>not</strong> loaded immediately after calling this method. The file is added to the queue ready to be loaded when the loader starts.</p>
<p>The key must be a unique String. It is used to add the file to the Phaser.Cache upon successful load.</p>
<p>Audio Sprites are a combination of audio files and a JSON configuration.</p>
<p>The JSON follows the format of that created by https://github.com/tonistiigi/audiosprite</p>
<p>Retrieve the file via <code>Cache.getSoundData(key)</code>.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to 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>Unique asset key of the audio file.</p></td>
</tr>
<tr>
<td class="name"><code>urls</code></td>
<td class="type">
<span class="param-type">Array</span>
|
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>An array containing the URLs of the audio files, i.e.: [ 'audiosprite.mp3', 'audiosprite.ogg', 'audiosprite.m4a' ] or a single string containing just one URL.</p></td>
</tr>
<tr>
<td class="name"><code>jsonURL</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>The URL of the audiosprite configuration JSON object. If you wish to pass the data directly set this parameter to null.</p></td>
</tr>
<tr>
<td class="name"><code>jsonData</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>A JSON object or string containing the audiosprite configuration data. This is ignored if jsonURL is not null.</p></td>
</tr>
<tr>
<td class="name"><code>autoDecode</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>When using Web Audio the audio files can either be decoded at load time or run-time.
Audio files can't be played until they are decoded and, if specified, this enables immediate decoding. Decoding is a non-blocking async process, however it consumes huge amounts of CPU time on mobiles especially.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-960">line 960</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="binary"><span class="type-signature"></span>binary<span class="signature">(key, <span class="optional">url</span>, <span class="optional">callback</span>, <span class="optional">callbackContext</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Adds a binary file to the current load queue.</p>
<p>The file is <strong>not</strong> loaded immediately after calling this method. The file is added to the queue ready to be loaded when the loader starts.</p>
<p>The key must be a unique String. It is used to add the file to the Phaser.Cache upon successful load.</p>
<p>Retrieve the file via <code>Cache.getBinary(key)</code>.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is &quot;alien&quot;
and no URL is given then the Loader will set the URL to be &quot;alien.bin&quot;. It will always add <code>.bin</code> as the extension.
If you do not desire this action then provide a URL.</p>
<p>It will be loaded via xhr with a responseType of &quot;arraybuffer&quot;. You can specify an optional callback to process the file after load.
When the callback is called it will be passed 2 parameters: the key of the file and the file data.</p>
<p>WARNING: If a callback is specified the data will be set to whatever it returns. Always return the data object, even if you didn't modify 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>Unique asset key of the binary file.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>URL of the binary file. If undefined or <code>null</code> the url will be set to <code>&lt;key&gt;.bin</code>, i.e. if <code>key</code> was &quot;alien&quot; then the URL will be &quot;alien.bin&quot;.</p></td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
(none)
</td>
<td class="description last"><p>Optional callback that will be passed the file after loading, so you can perform additional processing on it.</p></td>
</tr>
<tr>
<td class="name"><code>callbackContext</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>The context under which the callback will be applied. If not specified it will use the callback itself as the context.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-837">line 837</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="bitmapFont"><span class="type-signature"></span>bitmapFont<span class="signature">(key, textureURL, atlasURL, atlasData, <span class="optional">xSpacing</span>, <span class="optional">ySpacing</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Adds Bitmap Font files to the current load queue.</p>
<p>To create the Bitmap Font files you can use:</p>
<p>BMFont (Windows, free): http://www.angelcode.com/products/bmfont/
Glyph Designer (OS X, commercial): http://www.71squared.com/en/glyphdesigner
Littera (Web-based, free): http://kvazars.com/littera/</p>
<p>You can choose to either load the data externally, by providing a URL to an xml file.
Or you can pass in an XML object or String via the <code>xmlData</code> parameter.
If you pass a String the data is automatically run through <code>Loader.parseXML</code> and then immediately added to the Phaser.Cache.</p>
<p>If URLs are provided the files are <strong>not</strong> loaded immediately after calling this method, but are added to the load queue.</p>
<p>The key must be a unique String. It is used to add the file to the Phaser.Cache upon successful load.</p>
<p>Retrieve the file via <code>Cache.getBitmapFont(key)</code>. XML files are automatically parsed upon load.
If you need to control when the XML is parsed then use <code>Loader.text</code> instead and parse the XML file as needed.</p>
<p>The URLs can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the textureURL isn't specified then the Loader will take the key and create a filename from that.
For example if the key is &quot;megaFont&quot; and textureURL is null then the Loader will set the URL to be &quot;megaFont.png&quot;.
The same is true for the xmlURL. If xmlURL isn't specified and no xmlData has been provided then the Loader will
set the xmlURL to be the key. For example if the key is &quot;megaFont&quot; the xmlURL will be set to &quot;megaFont.xml&quot;.</p>
<p>If you do not desire this action then provide URLs and / or a data object.</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>Unique asset key of the bitmap font.</p></td>
</tr>
<tr>
<td class="name"><code>textureURL</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 the Bitmap Font texture file. If undefined or <code>null</code> the url will be set to <code>&lt;key&gt;.png</code>, i.e. if <code>key</code> was &quot;megaFont&quot; then the URL will be &quot;megaFont.png&quot;.</p></td>
</tr>
<tr>
<td class="name"><code>atlasURL</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 the Bitmap Font atlas file (xml/json).</p></td>
</tr>
<tr>
<td class="name"><code>atlasData</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>An optional Bitmap Font atlas in string form (stringified xml/json).</p></td>
</tr>
<tr>
<td class="name"><code>xSpacing</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>If you'd like to add additional horizontal spacing between the characters then set the pixel value here.</p></td>
</tr>
<tr>
<td class="name"><code>ySpacing</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>If you'd like to add additional vertical spacing between the lines then set the pixel value here.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-1212">line 1212</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="checkKeyExists"><span class="type-signature"></span>checkKeyExists<span class="signature">(type, key)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Check whether a file/asset with a specific key is queued to be loaded.</p>
<p>To access a loaded asset use Phaser.Cache, eg. <a href="Phaser.Cache.html#checkImageKey">Phaser.Cache#checkImageKey</a></p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The type asset you want to check.</p></td>
</tr>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Key of the asset you want to check.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">boolean</span>
-
</div>
<div class="returns-desc param-desc">
<p>Return true if exists, otherwise return false.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-361">line 361</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getAsset"><span class="type-signature"></span>getAsset<span class="signature">(type, key)</span><span class="type-signature"> &rarr; {any}</span></h4>
</dt>
<dd>
<div class="description">
<p>Find a file/asset with a specific key.</p>
<p>Only assets in the download file queue will be found.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The type asset you want to check.</p></td>
</tr>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Key of the asset you want to check.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">any</span>
-
</div>
<div class="returns-desc param-desc">
<p>Returns an object if found that has 2 properties: <code>index</code> and <code>file</code>; otherwise a non-true value is returned.
The index may change and should only be used immediately following this call.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-412">line 412</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getAssetIndex"><span class="type-signature"></span>getAssetIndex<span class="signature">(type, key)</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<div class="description">
<p>Get the queue-index of the file/asset with a specific key.</p>
<p>Only assets in the download file queue will be found.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The type asset you want to check.</p></td>
</tr>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Key of the asset you want to check.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">number</span>
-
</div>
<div class="returns-desc param-desc">
<p>The index of this key in the filelist, or -1 if not found.
The index may change and should only be used immediately following this call</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-377">line 377</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="image"><span class="type-signature"></span>image<span class="signature">(key, <span class="optional">url</span>, <span class="optional">overwrite</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Adds an Image to the current load queue.</p>
<p>The file is <strong>not</strong> loaded immediately after calling this method. The file is added to the queue ready to be loaded when the loader starts.</p>
<p>Phaser can load all common image types: png, jpg, gif and any other format the browser can natively handle.</p>
<p>The key must be a unique String. It is used to add the file to the Phaser.Cache upon successful load.</p>
<p>Retrieve the image via <code>Cache.getImage(key)</code></p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is &quot;alien&quot;
and no URL is given then the Loader will set the URL to be &quot;alien.png&quot;. It will always add <code>.png</code> as the extension.
If you do not desire this action then provide a URL.</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>Unique asset key of this image file.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>URL of an image file. If undefined or <code>null</code> the url will be set to <code>&lt;key&gt;.png</code>, i.e. if <code>key</code> was &quot;alien&quot; then the URL will be &quot;alien.png&quot;.</p></td>
</tr>
<tr>
<td class="name"><code>overwrite</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>If an unloaded file with a matching key already exists in the queue, this entry will overwrite it.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-664">line 664</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="json"><span class="type-signature"></span>json<span class="signature">(key, <span class="optional">url</span>, <span class="optional">overwrite</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Adds a JSON file to the current load queue.</p>
<p>The file is <strong>not</strong> loaded immediately after calling this method. The file is added to the queue ready to be loaded when the loader starts.</p>
<p>The key must be a unique String. It is used to add the file to the Phaser.Cache upon successful load.</p>
<p>Retrieve the file via <code>Cache.getJSON(key)</code>. JSON files are automatically parsed upon load.
If you need to control when the JSON is parsed then use <code>Loader.text</code> instead and parse the text file as needed.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is &quot;alien&quot;
and no URL is given then the Loader will set the URL to be &quot;alien.json&quot;. It will always add <code>.json</code> as the extension.
If you do not desire this action then provide a URL.</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>Unique asset key of the json file.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>URL of the JSON file. If undefined or <code>null</code> the url will be set to <code>&lt;key&gt;.json</code>, i.e. if <code>key</code> was &quot;alien&quot; then the URL will be &quot;alien.json&quot;.</p></td>
</tr>
<tr>
<td class="name"><code>overwrite</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>If an unloaded file with a matching key already exists in the queue, this entry will overwrite it.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-720">line 720</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="pack"><span class="type-signature"></span>pack<span class="signature">(key, <span class="optional">url</span>, <span class="optional">data</span>, <span class="optional">callbackContext</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Add a JSON resource pack ('packfile') to the Loader.</p>
<p>A packfile is a JSON file that contains a list of assets to the be loaded.
Please see the example 'loader/asset pack' in the Phaser Examples repository.</p>
<p>Packs are always put before the first non-pack file that is not loaded / loading.</p>
<p>This means that all packs added before any loading has started are added to the front
of the file queue, in the order added.</p>
<p>The key must be a unique String. It is used to add the file to the Phaser.Cache upon successful load.</p>
<p>The URL of the packfile can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to 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>Unique asset key of this resource pack.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>URL of the Asset Pack JSON file. If you wish to pass a json object instead set this to null and pass the object as the data parameter.</p></td>
</tr>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>The Asset Pack JSON data. Use this to pass in a json data object rather than loading it from a URL. TODO</p></td>
</tr>
<tr>
<td class="name"><code>callbackContext</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
(loader)
</td>
<td class="description last"><p>Some Loader operations, like Binary and Script require a context for their callbacks. Pass the context here.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-584">line 584</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="physics"><span class="type-signature"></span>physics<span class="signature">(key, <span class="optional">url</span>, <span class="optional">data</span>, <span class="optional">format</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Adds a physics data file to the current load queue.</p>
<p>The data must be in <code>Lime + Corona</code> JSON format. <a href="https://www.codeandweb.com">Physics Editor</a> by code'n'web exports in this format natively.</p>
<p>You can choose to either load the data externally, by providing a URL to a json file.
Or you can pass in a JSON object or String via the <code>data</code> parameter.
If you pass a String the data is automatically run through <code>JSON.parse</code> and then immediately added to the Phaser.Cache.</p>
<p>If a URL is provided the file is <strong>not</strong> loaded immediately after calling this method, but is added to the load queue.</p>
<p>The key must be a unique String. It is used to add the file to the Phaser.Cache upon successful load.</p>
<p>Retrieve the file via <code>Cache.getJSON(key)</code>. JSON files are automatically parsed upon load.
If you need to control when the JSON is parsed then use <code>Loader.text</code> instead and parse the text file as needed.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified and no data is given then the Loader will take the key and create a filename from that.
For example if the key is &quot;alien&quot; and no URL or data is given then the Loader will set the URL to be &quot;alien.json&quot;.
It will always use <code>.json</code> as the extension.</p>
<p>If you do not desire this action then provide a URL or data object.</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>Unique asset key of the physics json data.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>URL of the physics data file. If undefined or <code>null</code> and no data is given the url will be set to <code>&lt;key&gt;.json</code>, i.e. if <code>key</code> was &quot;alien&quot; then the URL will be &quot;alien.json&quot;.</p></td>
</tr>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">object</span>
|
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>An optional JSON data object. If given then the url is ignored and this JSON object is used for physics data instead.</p></td>
</tr>
<tr>
<td class="name"><code>format</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
Phaser.Physics.LIME_CORONA_JSON
</td>
<td class="description last"><p>The format of the physics data.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-1151">line 1151</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="removeAll"><span class="type-signature">&lt;internal> </span>removeAll<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Remove all file loading requests - this is <em>insufficient</em> to stop current loading. Use <code>reset</code> instead.</p>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-1619">line 1619</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="removeFile"><span class="type-signature">&lt;internal> </span>removeFile<span class="signature">(type, key)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Remove a file/asset from the loading queue.</p>
<p>A file that is loaded or has started loading cannot be removed.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The type of resource to add to the list (image, audio, xml, etc).</p></td>
</tr>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Key of the file you want to remove.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-1595">line 1595</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="replaceInFileList"><span class="type-signature">&lt;internal> </span>replaceInFileList<span class="signature">(type, key, url, properties)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Internal function that replaces an existing entry in the file list with a new one. Do not call directly.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The type of resource to add to the list (image, audio, xml, etc).</p></td>
</tr>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The unique Cache ID key of this resource.</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>The URL the asset will be loaded from.</p></td>
</tr>
<tr>
<td class="name"><code>properties</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>Any additional properties needed to load the file.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-568">line 568</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="reset"><span class="type-signature">&lt;internal> </span>reset<span class="signature">(<span class="optional">hard</span>, <span class="optional">clearEvents</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Reset the loader and clear any queued assets. If <code>Loader.resetLocked</code> is true this operation will abort.</p>
<p>This will abort any loading and clear any queued assets.</p>
<p>Optionally you can clear any associated events.</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>hard</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>If true then the preload sprite and other artifacts may also be cleared.</p></td>
</tr>
<tr>
<td class="name"><code>clearEvents</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>If true then the all Loader signals will have removeAll called on them.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-436">line 436</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="resize"><span class="type-signature">&lt;internal> </span>resize<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Called automatically by ScaleManager when the game resizes in RESIZE scalemode.</p>
<p>This can be used to adjust the preloading sprite size, eg.</p>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-344">line 344</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="script"><span class="type-signature"></span>script<span class="signature">(key, <span class="optional">url</span>, <span class="optional">callback</span>, <span class="optional">callbackContext</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Adds a JavaScript file to the current load queue.</p>
<p>The file is <strong>not</strong> loaded immediately after calling this method. The file is added to the queue ready to be loaded when the loader starts.</p>
<p>The key must be a unique String.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is &quot;alien&quot;
and no URL is given then the Loader will set the URL to be &quot;alien.js&quot;. It will always add <code>.js</code> as the extension.
If you do not desire this action then provide a URL.</p>
<p>Upon successful load the JavaScript is automatically turned into a script tag and executed, so be careful what you load!</p>
<p>A callback, which will be invoked as the script tag has been created, can also be specified.
The callback must return relevant <code>data</code>.</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>Unique asset key of the script file.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>URL of the JavaScript file. If undefined or <code>null</code> the url will be set to <code>&lt;key&gt;.js</code>, i.e. if <code>key</code> was &quot;alien&quot; then the URL will be &quot;alien.js&quot;.</p></td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
(none)
</td>
<td class="description last"><p>Optional callback that will be called after the script tag has loaded, so you can perform additional processing.</p></td>
</tr>
<tr>
<td class="name"><code>callbackContext</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
(loader)
</td>
<td class="description last"><p>The context under which the callback will be applied. If not specified it will use the Phaser Loader as the context.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-802">line 802</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="setPreloadSprite"><span class="type-signature"></span>setPreloadSprite<span class="signature">(sprite, <span class="optional">direction</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Set a Sprite to be a &quot;preload&quot; sprite by passing it to this method.</p>
<p>A &quot;preload&quot; sprite will have its width or height crop adjusted based on the percentage of the loader in real-time.
This allows you to easily make loading bars for games.</p>
<p>The sprite will automatically be made visible when calling this.</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>sprite</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span>
|
<span class="param-type"><a href="Phaser.Image.html">Phaser.Image</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The sprite or image that will be cropped during the load.</p></td>
</tr>
<tr>
<td class="name"><code>direction</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>A value of zero means the sprite will be cropped horizontally, a value of 1 means its will be cropped vertically.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-309">line 309</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="shader"><span class="type-signature"></span>shader<span class="signature">(key, <span class="optional">url</span>, <span class="optional">overwrite</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Adds a fragment shader file to the current load queue.</p>
<p>The file is <strong>not</strong> loaded immediately after calling this method. The file is added to the queue ready to be loaded when the loader starts.</p>
<p>The key must be a unique String. It is used to add the file to the Phaser.Cache upon successful load.</p>
<p>Retrieve the file via <code>Cache.getShader(key)</code>.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is &quot;blur&quot;
and no URL is given then the Loader will set the URL to be &quot;blur.frag&quot;. It will always add <code>.frag</code> as the extension.
If you do not desire this action then provide a URL.</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>Unique asset key of the fragment file.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>URL of the fragment file. If undefined or <code>null</code> the url will be set to <code>&lt;key&gt;.frag</code>, i.e. if <code>key</code> was &quot;blur&quot; then the URL will be &quot;blur.frag&quot;.</p></td>
</tr>
<tr>
<td class="name"><code>overwrite</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>If an unloaded file with a matching key already exists in the queue, this entry will overwrite it.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-748">line 748</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="spritesheet"><span class="type-signature"></span>spritesheet<span class="signature">(key, url, frameWidth, frameHeight, <span class="optional">frameMax</span>, <span class="optional">margin</span>, <span class="optional">spacing</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Adds a Sprite Sheet to the current load queue.</p>
<p>The file is <strong>not</strong> loaded immediately after calling this method. The file is added to the queue ready to be loaded when the loader starts.</p>
<p>To clarify the terminology that Phaser uses: A Sprite Sheet is an image containing frames, usually of an animation, that are all equal
dimensions and often in sequence. For example if the frame size is 32x32 then every frame in the sprite sheet will be that size.
Sometimes (outside of Phaser) the term &quot;sprite sheet&quot; is used to refer to a texture atlas.
A Texture Atlas works by packing together images as best it can, using whatever frame sizes it likes, often with cropping and trimming
the frames in the process. Software such as Texture Packer, Flash CC or Shoebox all generate texture atlases, not sprite sheets.
If you've got an atlas then use <code>Loader.atlas</code> instead.</p>
<p>The key must be a unique String. It is used to add the image to the Phaser.Cache upon successful load.</p>
<p>Retrieve the file via <code>Cache.getImage(key)</code>. Sprite sheets, being image based, live in the same Cache as all other Images.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is &quot;alien&quot;
and no URL is given then the Loader will set the URL to be &quot;alien.png&quot;. It will always add <code>.png</code> as the extension.
If you do not desire this action then provide a URL.</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>Unique asset key of the sheet file.</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 the sprite sheet file. If undefined or <code>null</code> the url will be set to <code>&lt;key&gt;.png</code>, i.e. if <code>key</code> was &quot;alien&quot; then the URL will be &quot;alien.png&quot;.</p></td>
</tr>
<tr>
<td class="name"><code>frameWidth</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Width in pixels of a single frame in the sprite sheet.</p></td>
</tr>
<tr>
<td class="name"><code>frameHeight</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Height in pixels of a single frame in the sprite sheet.</p></td>
</tr>
<tr>
<td class="name"><code>frameMax</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
-1
</td>
<td class="description last"><p>How many frames in this sprite sheet. If not specified it will divide the whole image into frames.</p></td>
</tr>
<tr>
<td class="name"><code>margin</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>If the frames have been drawn with a margin, specify the amount here.</p></td>
</tr>
<tr>
<td class="name"><code>spacing</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>If the frames have been drawn with spacing between them, specify the amount here.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-875">line 875</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="start"><span class="type-signature"></span>start<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Start loading the assets. Normally you don't need to call this yourself as the StateManager will do so.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-1632">line 1632</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="text"><span class="type-signature"></span>text<span class="signature">(key, <span class="optional">url</span>, <span class="optional">overwrite</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Adds a Text file to the current load queue.</p>
<p>The file is <strong>not</strong> loaded immediately after calling this method. The file is added to the queue ready to be loaded when the loader starts.</p>
<p>The key must be a unique String. It is used to add the file to the Phaser.Cache upon successful load.</p>
<p>Retrieve the file via <code>Cache.getText(key)</code></p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is &quot;alien&quot;
and no URL is given then the Loader will set the URL to be &quot;alien.txt&quot;. It will always add <code>.txt</code> as the extension.
If you do not desire this action then provide a URL.</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>Unique asset key of the text file.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>URL of the text file. If undefined or <code>null</code> the url will be set to <code>&lt;key&gt;.txt</code>, i.e. if <code>key</code> was &quot;alien&quot; then the URL will be &quot;alien.txt&quot;.</p></td>
</tr>
<tr>
<td class="name"><code>overwrite</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>If an unloaded file with a matching key already exists in the queue, this entry will overwrite it.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-693">line 693</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="tilemap"><span class="type-signature"></span>tilemap<span class="signature">(key, <span class="optional">url</span>, <span class="optional">data</span>, <span class="optional">format</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Adds a Tile Map data file to the current load queue.</p>
<p>You can choose to either load the data externally, by providing a URL to a json file.
Or you can pass in a JSON object or String via the <code>data</code> parameter.
If you pass a String the data is automatically run through <code>JSON.parse</code> and then immediately added to the Phaser.Cache.</p>
<p>If a URL is provided the file is <strong>not</strong> loaded immediately after calling this method, but is added to the load queue.</p>
<p>The key must be a unique String. It is used to add the file to the Phaser.Cache upon successful load.</p>
<p>Retrieve the file via <code>Cache.getTilemapData(key)</code>. JSON files are automatically parsed upon load.
If you need to control when the JSON is parsed then use <code>Loader.text</code> instead and parse the text file as needed.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified and no data is given then the Loader will take the key and create a filename from that.
For example if the key is &quot;level1&quot; and no URL or data is given then the Loader will set the URL to be &quot;level1.json&quot;.
If you set the format to be Tilemap.CSV it will set the URL to be &quot;level1.csv&quot; instead.</p>
<p>If you do not desire this action then provide a URL or data object.</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>Unique asset key of the tilemap data.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>URL of the tile map file. If undefined or <code>null</code> and no data is given the url will be set to <code>&lt;key&gt;.json</code>, i.e. if <code>key</code> was &quot;level1&quot; then the URL will be &quot;level1.json&quot;.</p></td>
</tr>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">object</span>
|
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>An optional JSON data object. If given then the url is ignored and this JSON object is used for map data instead.</p></td>
</tr>
<tr>
<td class="name"><code>format</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
Phaser.Tilemap.CSV
</td>
<td class="description last"><p>The format of the map data. Either Phaser.Tilemap.CSV or Phaser.Tilemap.TILED_JSON.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-1074">line 1074</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="totalLoadedFiles"><span class="type-signature">&lt;internal> </span>totalLoadedFiles<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns the number of files that have already been loaded, even if they errored.</p>
</div>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">number</span>
-
</div>
<div class="returns-desc param-desc">
<p>The number of files that have already been loaded (even if they errored)</p>
</div>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-2854">line 2854</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="totalLoadedPacks"><span class="type-signature">&lt;internal> </span>totalLoadedPacks<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns the number of asset packs that have already been loaded, even if they errored.</p>
</div>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">number</span>
-
</div>
<div class="returns-desc param-desc">
<p>The number of asset packs that have already been loaded (even if they errored)</p>
</div>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-2880">line 2880</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="totalQueuedFiles"><span class="type-signature">&lt;internal> </span>totalQueuedFiles<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns the number of files still waiting to be processed in the load queue. This value decreases as each file in the queue is loaded.</p>
</div>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">number</span>
-
</div>
<div class="returns-desc param-desc">
<p>The number of files that still remain in the load queue.</p>
</div>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-2867">line 2867</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="totalQueuedPacks"><span class="type-signature">&lt;internal> </span>totalQueuedPacks<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns the number of asset packs still waiting to be processed in the load queue. This value decreases as each pack in the queue is loaded.</p>
</div>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">number</span>
-
</div>
<div class="returns-desc param-desc">
<p>The number of asset packs that still remain in the load queue.</p>
</div>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-2893">line 2893</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="transformUrl"><span class="type-signature">&lt;internal> </span>transformUrl<span class="signature">(url, file)</span><span class="type-signature"> &rarr; {string}</span></h4>
</dt>
<dd>
<div class="description">
<p>Transforms the asset URL.
The default implementation prepends the baseURL if the url doesn't being with http or //</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The url to transform.</p></td>
</tr>
<tr>
<td class="name"><code>file</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The file object being transformed.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">string</span>
-
</div>
<div class="returns-desc param-desc">
<p>The transformed url. In rare cases where the url isn't specified it will return false instead.</p>
</div>
</div>
<dl class="details">
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-1960">line 1960</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="video"><span class="type-signature"></span>video<span class="signature">(key, urls, <span class="optional">loadEvent</span>, <span class="optional">asBlob</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Adds a video file to the current load queue.</p>
<p>The file is <strong>not</strong> loaded immediately after calling this method. The file is added to the queue ready to be loaded when the loader starts.</p>
<p>The key must be a unique String. It is used to add the file to the Phaser.Cache upon successful load.</p>
<p>Retrieve the file via <code>Cache.getVideo(key)</code>.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>You don't need to preload a video in order to play it in your game. See <code>Video.createVideoFromURL</code> for details.</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>Unique asset key of the video file.</p></td>
</tr>
<tr>
<td class="name"><code>urls</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">Array.&lt;string></span>
|
<span class="param-type">Array.&lt;object></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>Either a single string or an array of URIs or pairs of <code>{uri: .., type: ..}</code>.
If an array is specified then the first URI (or URI + mime pair) that is device-compatible will be selected.
For example: <code>&quot;boom.mp4&quot;</code>, <code>['boom.mp4', 'boom.ogg', 'boom.webm']</code>, or <code>[{uri: &quot;data:&lt;opus_resource&gt;&quot;, type: 'opus'}, 'fallback.mp4']</code>.
BLOB and DATA URIs can be used but only support automatic detection when used in the pair form; otherwise the format must be manually checked before adding the resource.</p></td>
</tr>
<tr>
<td class="name"><code>loadEvent</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
'canplaythrough'
</td>
<td class="description last"><p>This sets the Video source event to listen for before the load is considered complete.
'canplaythrough' implies the video has downloaded enough, and bandwidth is high enough that it can be played to completion.
'canplay' implies the video has downloaded enough to start playing, but not necessarily to finish.
'loadeddata' just makes sure that the video meta data and first frame have downloaded. Phaser uses this value automatically if the
browser is detected as being Firefox and no <code>loadEvent</code> is given, otherwise it defaults to <code>canplaythrough</code>.</p></td>
</tr>
<tr>
<td class="name"><code>asBlob</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>Video files can either be loaded via the creation of a video element which has its src property set.
Or they can be loaded via xhr, stored as binary data in memory and then converted to a Blob. This isn't supported in IE9 or Android 2.
If you need to have the same video playing at different times across multiple Sprites then you need to load it as a Blob.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-1020">line 1020</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="withSyncPoints"><span class="type-signature"></span>withSyncPoints<span class="signature">(callback, <span class="optional">callbackContext</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Add a synchronization point to the assets/files added within the supplied callback.</p>
<p>A synchronization point denotes that an asset <em>must</em> be completely loaded before
subsequent assets can be loaded. An asset marked as a sync-point does not need to wait
for previous assets to load (unless they are sync-points). Resources, such as packs, may still
be downloaded around sync-points, as long as they do not finalize loading.</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>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The callback is invoked and is supplied with a single argument: the loader.</p></td>
</tr>
<tr>
<td class="name"><code>callbackContext</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
(loader)
</td>
<td class="description last"><p>Context for the callback.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-1546">line 1546</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="xml"><span class="type-signature"></span>xml<span class="signature">(key, <span class="optional">url</span>, <span class="optional">overwrite</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Loader.html">Phaser.Loader</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Adds an XML file to the current load queue.</p>
<p>The file is <strong>not</strong> loaded immediately after calling this method. The file is added to the queue ready to be loaded when the loader starts.</p>
<p>The key must be a unique String. It is used to add the file to the Phaser.Cache upon successful load.</p>
<p>Retrieve the file via <code>Cache.getXML(key)</code>.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is &quot;alien&quot;
and no URL is given then the Loader will set the URL to be &quot;alien.xml&quot;. It will always add <code>.xml</code> as the extension.
If you do not desire this action then provide a URL.</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>Unique asset key of 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="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>URL of the XML file. If undefined or <code>null</code> the url will be set to <code>&lt;key&gt;.xml</code>, i.e. if <code>key</code> was &quot;alien&quot; then the URL will be &quot;alien.xml&quot;.</p></td>
</tr>
<tr>
<td class="name"><code>overwrite</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>If an unloaded file with a matching key already exists in the queue, this entry will overwrite it.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Loader.html">Phaser.Loader</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This Loader instance.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_loader_Loader.js.html">loader/Loader.js</a>, <a href="src_loader_Loader.js.html#sunlight-1-line-775">line 775</a>
</dt>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
Phaser Copyright © 2012-2015 Photon Storm Ltd.
</span>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha10</a>
on Fri Jul 24 2015 13:29:50 GMT+0100 (GMT Daylight Time) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>
<div class="span3">
<div id="toc"></div>
</div>
<br clear="both">
</div>
</div>
<script src="scripts/sunlight.js"></script>
<script src="scripts/sunlight.javascript.js"></script>
<script src="scripts/sunlight-plugin.doclinks.js"></script>
<script src="scripts/sunlight-plugin.linenumbers.js"></script>
<script src="scripts/sunlight-plugin.menu.js"></script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/jquery.scrollTo.js"></script>
<script src="scripts/jquery.localScroll.js"></script>
<script src="scripts/bootstrap-dropdown.js"></script>
<script src="scripts/toc.js"></script>
<script> Sunlight.highlightAll({lineNumbers:true, showMenu: true, enableDoclinks :true}); </script>
<script>
$( function () {
$( "#toc" ).toc( {
anchorName : function(i, heading, prefix) {
return $(heading).attr("id") || ( prefix + i );
},
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
</script>
</body>
</html>
Reference in a new issue View git blame Copy permalink