2013-11-28 15:57:09 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > Phaser Class: Tilemap< / title >
<!-- [if lt IE 9]>
< script src = "//html5shiv.googlecode.com/svn/trunk/html5.js" > < / script >
<![endif]-->
< link type = "text/css" rel = "stylesheet" href = "styles/sunlight.default.css" >
< link type = "text/css" rel = "stylesheet" href = "styles/site.cerulean.css" >
< / head >
< body >
< div class = "container-fluid" >
< div class = "navbar navbar-fixed-top navbar-inverse" >
< div class = "navbar-inner" >
< a class = "brand" href = "index.html" > Phaser< / a >
< ul class = "nav" >
< li class = "dropdown" >
< a href = "namespaces.list.html" class = "dropdown-toggle" data-toggle = "dropdown" > Namespaces< b
class="caret">< / b > < / a >
< ul class = "dropdown-menu " >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-0" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.html" > Phaser< / 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 " >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Animation.html" > Animation< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.AnimationManager.html" > AnimationManager< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.AnimationParser.html" > AnimationParser< / a >
< / li >
2014-04-29 14:39:02 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.ArrayList.html" > ArrayList< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.BitmapData.html" > BitmapData< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.BitmapText.html" > BitmapText< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Button.html" > Button< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Cache.html" > Cache< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Camera.html" > Camera< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Canvas.html" > Canvas< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Circle.html" > Circle< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Color.html" > Color< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Device.html" > Device< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Easing.html" > Easing< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Easing.Back.html" > Back< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Easing.Bounce.html" > Bounce< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Easing.Circular.html" > Circular< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Easing.Cubic.html" > Cubic< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Easing.Elastic.html" > Elastic< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Easing.Exponential.html" > Exponential< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Easing.Linear.html" > Linear< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Easing.Quadratic.html" > Quadratic< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Easing.Quartic.html" > Quartic< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Easing.Quintic.html" > Quintic< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Easing.Sinusoidal.html" > Sinusoidal< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-18 03:01:51 +00:00
< a href = "Phaser.Ellipse.html" > Ellipse< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Events.html" > Events< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Filter.html" > Filter< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Frame.html" > Frame< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.FrameData.html" > FrameData< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Game.html" > Game< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-21 15:37:26 +00:00
< a href = "Phaser.GameObjectCreator.html" > GameObjectCreator< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.GameObjectFactory.html" > GameObjectFactory< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-05 06:29:17 +00:00
< a href = "Phaser.Gamepad.html" > Gamepad< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-05 06:29:17 +00:00
< a href = "Phaser.GamepadButton.html" > GamepadButton< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Graphics.html" > Graphics< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Group.html" > Group< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-08 07:24:22 +00:00
< a href = "Phaser.Image.html" > Image< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Input.html" > Input< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.InputHandler.html" > InputHandler< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Key.html" > Key< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Keyboard.html" > Keyboard< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-05 06:29:17 +00:00
< a href = "Phaser.Line.html" > Line< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.LinkedList.html" > LinkedList< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Loader.html" > Loader< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.LoaderParser.html" > LoaderParser< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Math.html" > Math< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Mouse.html" > Mouse< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.MSPointer.html" > MSPointer< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Net.html" > Net< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.Particle.html" > Particle< / a >
< / li >
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Particles.html" > Particles< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Particles.Arcade.Emitter.html" > Emitter< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Physics.html" > Physics< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Physics.Arcade.html" > Arcade< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Arcade.Body.html" > Body< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Ninja.html" > Ninja< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Ninja.AABB.html" > AABB< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Ninja.Body.html" > Body< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Ninja.Circle.html" > Circle< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Ninja.Tile.html" > Tile< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.html" > P2< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.Body.html" > Body< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.BodyDebug.html" > BodyDebug< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.CollisionGroup.html" > CollisionGroup< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.ContactMaterial.html" > ContactMaterial< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.DistanceConstraint.html" > DistanceConstraint< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-11 12:09:28 +00:00
< li class = "class-depth-3" >
< a href = "Phaser.Physics.P2.FixtureList.html" > FixtureList< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.GearConstraint.html" > GearConstraint< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.InversePointProxy.html" > InversePointProxy< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.LockConstraint.html" > LockConstraint< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.Material.html" > Material< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.PointProxy.html" > PointProxy< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.PrismaticConstraint.html" > PrismaticConstraint< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.RevoluteConstraint.html" > RevoluteConstraint< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.Spring.html" > Spring< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Plugin.html" > Plugin< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.PluginManager.html" > PluginManager< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Point.html" > Point< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Pointer.html" > Pointer< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Polygon.html" > Polygon< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.QuadTree.html" > QuadTree< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.RandomDataGenerator.html" > RandomDataGenerator< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Rectangle.html" > Rectangle< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.RenderTexture.html" > RenderTexture< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.RequestAnimationFrame.html" > RequestAnimationFrame< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.RetroFont.html" > RetroFont< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.ScaleManager.html" > ScaleManager< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Signal.html" > Signal< / a >
< / li >
2014-04-11 12:09:28 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.SignalBinding.html" > SignalBinding< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-05 06:29:17 +00:00
< a href = "Phaser.SinglePad.html" > SinglePad< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Sound.html" > Sound< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.SoundManager.html" > SoundManager< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Sprite.html" > Sprite< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-18 03:01:51 +00:00
< a href = "Phaser.SpriteBatch.html" > SpriteBatch< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Stage.html" > Stage< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.State.html" > State< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.StateManager.html" > StateManager< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Text.html" > Text< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Tile.html" > Tile< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Tilemap.html" > Tilemap< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.TilemapLayer.html" > TilemapLayer< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.TilemapParser.html" > TilemapParser< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Tileset.html" > Tileset< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.TileSprite.html" > TileSprite< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Time.html" > Time< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Timer.html" > Timer< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-05 06:29:17 +00:00
< a href = "Phaser.TimerEvent.html" > TimerEvent< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Touch.html" > Touch< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Tween.html" > Tween< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.TweenManager.html" > TweenManager< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Utils.html" > Utils< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Utils.Debug.html" > Debug< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.World.html" > World< / a >
< / li >
< / ul >
< / li >
2014-05-20 09:12:48 +00:00
2013-11-28 15:57:09 +00:00
< / ul >
< / div >
< / div >
< div class = "row-fluid" >
< div class = "span8" >
< div id = "main" >
< h1 class = "page-title" > Class: Tilemap< / h1 >
< section >
< header >
< h2 >
< span class = "ancestors" > < a href = "Phaser.html" > Phaser< / a > .< / span >
Tilemap
< / h2 >
< div class = "class-description" > < p > Phaser.Tilemap< / p > < / div >
< / header >
< article >
< div class = "container-overview" >
< dt >
2014-03-14 06:36:05 +00:00
< h4 class = "name" id = "Tilemap" > < span class = "type-signature" > < / span > new Tilemap< span class = "signature" > (game, < span class = "optional" > key< / span > , < span class = "optional" > tileWidth< / span > , < span class = "optional" > tileHeight< / span > , < span class = "optional" > width< / span > , < span class = "optional" > height< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< div class = "description" >
2014-03-14 06:36:05 +00:00
< p > Creates a new Phaser.Tilemap object. The map can either be populated with data from a Tiled JSON file or from a CSV file.
To do this pass the Cache key as the first parameter. When using Tiled data you need only provide the key.
When using CSV data you must provide the key and the tileWidth and tileHeight parameters.
If creating a blank tilemap to be populated later, you can either specify no parameters at all and then use < code > Tilemap.create< / code > or pass the map and tile dimensions here.
Note that all Tilemaps use a base tile size to calculate dimensions from, but that a TilemapLayer may have its own unique tile size that overrides it.
A Tile map is rendered to the display using a TilemapLayer. It is not added to the display list directly itself.
2013-11-28 15:57:09 +00:00
A map may have multiple layers. You can perform operations on the map data such as copying, pasting, filling and shuffling the tiles around.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
2014-03-14 06:36:05 +00:00
< th > Default< / th >
2013-11-28 15:57:09 +00:00
< 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 = "attributes" >
< / td >
2014-03-14 06:36:05 +00:00
< td class = "default" >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > Game reference to the currently running game.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > key< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2014-03-14 06:36:05 +00:00
< td class = "default" >
< / td >
< td class = "description last" > < p > The key of the tilemap data as stored in the Cache. If you're creating a blank map either leave this parameter out or pass < code > null< / code > .< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > tileWidth< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
32
< / td >
< td class = "description last" > < p > The pixel width of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > tileHeight< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
32
< / td >
< td class = "description last" > < p > The pixel height of a single map tile. If using CSV data you must specify this. Not required if using Tiled map data.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > width< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
10
< / td >
< td class = "description last" > < p > The width of the map in tiles. If this map is created from Tiled or CSV data you don't need to specify this.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > height< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
10
< / td >
2013-11-28 15:57:09 +00:00
2014-03-14 06:36:05 +00:00
< td class = "description last" > < p > The height of the map in tiles. If this map is created from Tiled or CSV data you don't need to specify this.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-25" > line 25< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< / div >
< h3 class = "subsection-title" > Members< / h3 >
< dl >
< dt >
< h4 class = "name" id = "CSV" > < span class = "type-signature" > < static, constant> < / span > CSV< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > number< / span >
< / li >
< / ul >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-04-29 14:39:02 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-163" > line 163< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
2014-05-20 09:12:48 +00:00
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "EAST" > < span class = "type-signature" > < static, constant> < / span > EAST< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > number< / span >
< / li >
< / ul >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-181" > line 181< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "NORTH" > < span class = "type-signature" > < static, constant> < / span > NORTH< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > number< / span >
< / li >
< / ul >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-175" > line 175< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "SOUTH" > < span class = "type-signature" > < static, constant> < / span > SOUTH< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > number< / span >
< / li >
< / ul >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-187" > line 187< / a >
< / li > < / ul > < / dd >
2013-11-28 15:57:09 +00:00
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "TILED_JSON" > < span class = "type-signature" > < static, constant> < / span > TILED_JSON< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > number< / span >
< / li >
< / ul >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-04-29 14:39:02 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-169" > line 169< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
2014-05-20 09:12:48 +00:00
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "WEST" > < span class = "type-signature" > < static, constant> < / span > WEST< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > number< / span >
< / li >
< / ul >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-193" > line 193< / a >
< / li > < / ul > < / dd >
2014-02-18 03:01:51 +00:00
< / dl >
< / dd >
< dt >
2014-03-14 06:36:05 +00:00
< h4 class = "name" id = "collideIndexes" > < span class = "type-signature" > < / span > collideIndexes< span class = "type-signature" > < / span > < / h4 >
2014-02-18 03:01:51 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-03-14 06:36:05 +00:00
< td class = "name" > < code > collideIndexes< / code > < / td >
2014-02-18 03:01:51 +00:00
< td class = "type" >
< span class = "param-type" > array< / span >
< / td >
2014-03-14 06:36:05 +00:00
< td class = "description last" > < p > An array of tile indexes that collide.< / p > < / td >
2014-02-18 03:01:51 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-04-29 14:39:02 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-117" > line 117< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-03-14 06:36:05 +00:00
< h4 class = "name" id = "collision" > < span class = "type-signature" > < / span > collision< span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-03-14 06:36:05 +00:00
< td class = "name" > < code > collision< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-03-14 06:36:05 +00:00
< span class = "param-type" > array< / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-03-14 06:36:05 +00:00
< td class = "description last" > < p > An array of collision data (polylines, etc).< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-04-29 14:39:02 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-122" > line 122< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-03-14 06:36:05 +00:00
< h4 class = "name" id = "currentLayer" > < span class = "type-signature" > < / span > currentLayer< span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-03-14 06:36:05 +00:00
< td class = "name" > < code > currentLayer< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-03-14 06:36:05 +00:00
< span class = "param-type" > number< / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-03-14 06:36:05 +00:00
< td class = "description last" > < p > The current layer.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-04-29 14:39:02 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-132" > line 132< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-03-14 06:36:05 +00:00
< h4 class = "name" id = "debugMap" > < span class = "type-signature" > < / span > debugMap< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > debugMap< / code > < / td >
< td class = "type" >
< span class = "param-type" > array< / span >
< / td >
< td class = "description last" > < p > Map data used for debug values only.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-04-29 14:39:02 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-137" > line 137< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "format" > < span class = "type-signature" > < / span > format< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > format< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / 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 >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-72" > line 72< / a >
2014-03-14 06:36:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "game" > < span class = "type-signature" > < / span > game< span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > game< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-02-05 06:29:17 +00:00
< span class = "param-type" > < a href = "Phaser.Game.html" > Phaser.Game< / a > < / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > A reference to the currently running Game.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-30" > line 30< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-08 07:24:22 +00:00
< h4 class = "name" id = "height" > < span class = "type-signature" > < / span > height< span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > height< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-02-08 07:24:22 +00:00
< span class = "param-type" > number< / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The height of the map (in tiles).< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-52" > line 52< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-08 07:24:22 +00:00
< h4 class = "name" id = "heightInPixels" > < span class = "type-signature" > < / span > heightInPixels< span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > heightInPixels< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-02-08 07:24:22 +00:00
< span class = "param-type" > number< / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The height of the map in pixels based on height * tileHeight.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-04-29 14:39:02 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-92" > line 92< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
2014-02-05 06:29:17 +00:00
2013-11-28 15:57:09 +00:00
< dt >
2014-02-08 07:24:22 +00:00
< h4 class = "name" id = "images" > < span class = "type-signature" > < / span > images< span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< dl class = "details" >
2014-02-05 06:29:17 +00:00
< 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 >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > images< / code > < / td >
2014-02-05 06:29:17 +00:00
< td class = "type" >
< span class = "param-type" > array< / span >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > An array of Tiled Image Layers.< / p > < / td >
2014-02-05 06:29:17 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
2013-11-28 15:57:09 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-04-29 14:39:02 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-127" > line 127< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-08 07:24:22 +00:00
< h4 class = "name" id = "key" > < span class = "type-signature" > < / span > key< span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
2014-02-05 06:29:17 +00:00
< dl class = "details" >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
2013-11-28 15:57:09 +00:00
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > key< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-02-08 07:24:22 +00:00
< span class = "param-type" > string< / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The key of this map data in the Phaser.Cache.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
2014-02-05 06:29:17 +00:00
< / tbody >
< / table >
< / dl >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-35" > line 35< / a >
2014-02-05 06:29:17 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< dt >
2014-05-20 09:12:48 +00:00
< h4 class = "name" id = "layer" > < span class = "type-signature" > < / span > layer< span class = "type-signature" > < / span > < / h4 >
2014-02-05 06:29:17 +00:00
< / dt >
< dd >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< 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 >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< tbody >
2013-11-28 15:57:09 +00:00
< tr >
2014-05-20 09:12:48 +00:00
< td class = "name" > < code > layer< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-05-20 09:12:48 +00:00
< span class = "param-type" > number< / span >
|
< span class = "param-type" > string< / span >
|
< span class = "param-type" > < a href = "Phaser.TilemapLayer.html" > Phaser.TilemapLayer< / a > < / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-02-05 06:29:17 +00:00
2014-05-20 09:12:48 +00:00
< td class = "description last" > < p > The current layer object.< / p > < / td >
2014-02-05 06:29:17 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-07-10 19:31:11 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-1774" > line 1774< / a >
2014-02-05 06:29:17 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-05-20 09:12:48 +00:00
< h4 class = "name" id = "layers" > < span class = "type-signature" > < / span > layers< span class = "type-signature" > < / span > < / h4 >
2014-02-05 06:29:17 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-05-20 09:12:48 +00:00
< td class = "name" > < code > layers< / code > < / td >
2014-02-05 06:29:17 +00:00
< td class = "type" >
< span class = "param-type" > array< / span >
< / td >
2014-05-20 09:12:48 +00:00
< td class = "description last" > < p > An array of Tilemap layer data.< / p > < / td >
2014-02-05 06:29:17 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-05-20 09:12:48 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-97" > line 97< / a >
2014-02-05 06:29:17 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
2014-02-08 07:24:22 +00:00
2014-02-05 06:29:17 +00:00
< dt >
2014-05-20 09:12:48 +00:00
< h4 class = "name" id = "objects" > < span class = "type-signature" > < / span > objects< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > objects< / code > < / td >
< td class = "type" >
< span class = "param-type" > array< / span >
< / td >
< td class = "description last" > < p > An array of Tiled Object Layers.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-112" > line 112< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "orientation" > < span class = "type-signature" > < / span > orientation< span class = "type-signature" > < / span > < / h4 >
2014-02-05 06:29:17 +00:00
< / dt >
< dd >
2014-02-08 07:24:22 +00:00
< dl class = "details" >
2014-02-05 06:29:17 +00:00
2014-02-08 07:24:22 +00:00
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
2014-02-05 06:29:17 +00:00
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > orientation< / code > < / td >
2014-02-05 06:29:17 +00:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The orientation of the map data (as specified in Tiled), usually 'orthogonal'.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-67" > line 67< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
2014-02-05 06:29:17 +00:00
2014-02-08 07:24:22 +00:00
< dt >
< h4 class = "name" id = "properties" > < span class = "type-signature" > < / span > properties< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
2014-02-05 06:29:17 +00:00
2014-02-08 07:24:22 +00:00
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
2014-02-05 06:29:17 +00:00
2014-02-08 07:24:22 +00:00
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
2014-02-05 06:29:17 +00:00
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > properties< / code > < / td >
2014-02-05 06:29:17 +00:00
< td class = "type" >
2014-02-08 07:24:22 +00:00
< span class = "param-type" > object< / span >
2014-02-05 06:29:17 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > Map specific properties as specified in Tiled.< / p > < / td >
2014-02-05 06:29:17 +00:00
< / tr >
< / tbody >
< / table >
2014-02-08 07:24:22 +00:00
< / dl >
2014-02-05 06:29:17 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-04-29 14:39:02 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-82" > line 82< / a >
2014-02-05 06:29:17 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-08 07:24:22 +00:00
< h4 class = "name" id = "tileHeight" > < span class = "type-signature" > < / span > tileHeight< span class = "type-signature" > < / span > < / h4 >
2014-02-05 06:29:17 +00:00
< / dt >
< dd >
2014-02-08 07:24:22 +00:00
< dl class = "details" >
2014-02-05 06:29:17 +00:00
2014-02-08 07:24:22 +00:00
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
2014-02-05 06:29:17 +00:00
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > tileHeight< / code > < / td >
2014-02-05 06:29:17 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The base height of the tiles in the map (in pixels).< / p > < / td >
2014-02-05 06:29:17 +00:00
< / tr >
2014-02-08 07:24:22 +00:00
< / tbody >
< / table >
< / dl >
2014-02-05 06:29:17 +00:00
2014-02-08 07:24:22 +00:00
2014-02-05 06:29:17 +00:00
2014-02-08 07:24:22 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-62" > line 62< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "tiles" > < span class = "type-signature" > < / span > tiles< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > tiles< / code > < / td >
< td class = "type" >
< span class = "param-type" > array< / span >
< / td >
< td class = "description last" > < p > The super array of Tiles.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-04-29 14:39:02 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-107" > line 107< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "tilesets" > < span class = "type-signature" > < / span > tilesets< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > tilesets< / code > < / td >
< td class = "type" >
< span class = "param-type" > array< / span >
< / td >
< td class = "description last" > < p > An array of Tilesets.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-04-29 14:39:02 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-102" > line 102< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "tileWidth" > < span class = "type-signature" > < / span > tileWidth< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > tileWidth< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The base width of the tiles in the map (in pixels).< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-57" > line 57< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "version" > < span class = "type-signature" > < / span > version< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > version< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The version of the map data (as specified in Tiled, usually 1).< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-04-29 14:39:02 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-77" > line 77< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "width" > < span class = "type-signature" > < / span > width< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > width< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The width of the map (in tiles).< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-14 06:36:05 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-47" > line 47< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "widthInPixels" > < span class = "type-signature" > < / span > widthInPixels< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > widthInPixels< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The width of the map in pixels based on width * tileWidth.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-04-29 14:39:02 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-87" > line 87< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< / dl >
< h3 class = "subsection-title" > Methods< / h3 >
< dl >
< dt >
2014-03-24 12:41:45 +00:00
< h4 class = "name" id = "addTilesetImage" > < span class = "type-signature" > < / span > addTilesetImage< span class = "signature" > (tileset, < span class = "optional" > key< / span > , < span class = "optional" > tileWidth< / span > , < span class = "optional" > tileHeight< / span > , < span class = "optional" > tileMargin< / span > , < span class = "optional" > tileSpacing< / span > , < span class = "optional" > gid< / span > )< / span > < span class = "type-signature" > → {< a href = "Phaser.Tileset.html" > Phaser.Tileset< / a > }< / span > < / h4 >
2014-02-08 07:24:22 +00:00
< / dt >
< dd >
< div class = "description" >
< p > Adds an image to the map to be used as a tileset. A single map may use multiple tilesets.
Note that the tileset name can be found in the JSON file exported from Tiled, or in the Tiled editor.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
2014-03-14 06:36:05 +00:00
< th > Default< / th >
2014-02-08 07:24:22 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > tileset< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
2014-03-14 06:36:05 +00:00
< td class = "default" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The name of the tileset as specified in the map data.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > key< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2014-03-14 06:36:05 +00:00
< td class = "default" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The key of the Phaser.Cache image used for this tileset. If not specified it will look for an image with a key matching the tileset parameter.< / p > < / td >
< / tr >
2014-03-14 06:36:05 +00:00
< tr >
< td class = "name" > < code > tileWidth< / code > < / td >
2014-02-08 07:24:22 +00:00
2014-03-14 06:36:05 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
2014-02-08 07:24:22 +00:00
2014-03-14 06:36:05 +00:00
< / td >
2014-02-08 07:24:22 +00:00
2014-03-14 06:36:05 +00:00
< td class = "attributes" >
< optional>< br >
2014-02-08 07:24:22 +00:00
2014-03-14 06:36:05 +00:00
2014-02-08 07:24:22 +00:00
2014-03-14 06:36:05 +00:00
< / td >
2014-02-08 07:24:22 +00:00
2014-03-14 06:36:05 +00:00
< td class = "default" >
2014-03-24 12:41:45 +00:00
32
2014-03-14 06:36:05 +00:00
< / td >
2014-02-08 07:24:22 +00:00
2014-03-24 12:41:45 +00:00
< td class = "description last" > < p > The width of the tiles in the Tileset Image. If not given it will default to the map.tileWidth value, if that isn't set then 32.< / p > < / td >
2014-03-14 06:36:05 +00:00
< / tr >
2014-02-08 07:24:22 +00:00
2014-03-14 06:36:05 +00:00
2014-02-08 07:24:22 +00:00
2014-03-14 06:36:05 +00:00
< tr >
< td class = "name" > < code > tileHeight< / code > < / td >
2014-02-08 07:24:22 +00:00
2014-03-14 06:36:05 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
2014-02-08 07:24:22 +00:00
2014-03-14 06:36:05 +00:00
< / td >
2014-02-08 07:24:22 +00:00
2014-03-14 06:36:05 +00:00
< td class = "attributes" >
< optional>< br >
2014-02-08 07:24:22 +00:00
2014-03-14 06:36:05 +00:00
2014-02-08 07:24:22 +00:00
2014-03-14 06:36:05 +00:00
< / td >
2014-02-08 07:24:22 +00:00
2014-03-14 06:36:05 +00:00
< td class = "default" >
2014-03-24 12:41:45 +00:00
32
2014-03-14 06:36:05 +00:00
< / td >
2014-02-08 07:24:22 +00:00
2014-03-24 12:41:45 +00:00
< td class = "description last" > < p > The height of the tiles in the Tileset Image. If not given it will default to the map.tileHeight value, if that isn't set then 32.< / p > < / td >
2014-03-14 06:36:05 +00:00
< / tr >
2014-02-08 07:24:22 +00:00
< tr >
2014-03-14 06:36:05 +00:00
< td class = "name" > < code > tileMargin< / code > < / td >
2014-02-08 07:24:22 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-03-14 06:36:05 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2014-02-08 07:24:22 +00:00
2014-03-14 06:36:05 +00:00
< td class = "default" >
0
< / td >
2014-02-08 07:24:22 +00:00
2014-03-14 06:36:05 +00:00
< td class = "description last" > < p > The width of the tiles in the Tileset Image. If not given it will default to the map.tileWidth value.< / p > < / td >
2014-02-08 07:24:22 +00:00
< / tr >
2014-03-14 06:36:05 +00:00
< tr >
< td class = "name" > < code > tileSpacing< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
0
< / td >
< td class = "description last" > < p > The height of the tiles in the Tileset Image. If not given it will default to the map.tileHeight value.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > gid< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
0
< / td >
< td class = "description last" > < p > If adding multiple tilesets to a blank/dynamic map, specify the starting GID the set will use here.< / p > < / td >
< / tr >
< / tbody >
< / table >
2014-02-08 07:24:22 +00:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-05-20 09:12:48 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-240" > line 240< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
< / dl >
2014-03-24 12:41:45 +00:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > Returns the Tileset object that was created or updated, or null if it failed.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Tileset.html" > Phaser.Tileset< / a > < / span >
< / dd >
< / dl >
2014-02-18 03:01:51 +00:00
< / dd >
< dt >
2014-03-14 06:36:05 +00:00
< h4 class = "name" id = "calculateFaces" > < span class = "type-signature" > < protected> < / span > calculateFaces< span class = "signature" > (layer)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-02-18 03:01:51 +00:00
< / dt >
< dd >
< div class = "description" >
2014-03-14 06:36:05 +00:00
< p > Internal function.< / p >
2014-02-18 03:01:51 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > layer< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-03-14 06:36:05 +00:00
< td class = "description last" > < p > The index of the TilemapLayer to operate on.< / p > < / td >
2014-02-18 03:01:51 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-07-10 19:31:11 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-908" > line 908< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "copy" > < span class = "type-signature" > < / span > copy< span class = "signature" > (x, y, width, height, < span class = "optional" > layer< / span > )< / span > < span class = "type-signature" > → {array}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Copies all of the tiles in the given rectangular block into the tilemap data buffer.< / 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 > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > X position of the top left of the area to copy (given in tiles, not pixels)< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > Y position of the top left of the area to copy (given in tiles, not pixels)< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > width< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The width of the area to copy (given in tiles, not pixels)< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > height< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The height of the area to copy (given in tiles, not pixels)< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > layer< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
|
< span class = "param-type" > string< / span >
|
< span class = "param-type" > < a href = "Phaser.TilemapLayer.html" > Phaser.TilemapLayer< / a > < / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > < p > The layer to copy the tiles from.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-07-10 19:31:11 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-1371" > line 1371< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > An array of the tiles that were copied.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > array< / span >
< / dd >
< / dl >
< / dd >
< dt >
2014-03-24 12:41:45 +00:00
< h4 class = "name" id = "create" > < span class = "type-signature" > < / span > create< span class = "signature" > (name, width, height, tileWidth, tileHeight, < span class = "optional" > group< / span > )< / span > < span class = "type-signature" > → {< a href = "Phaser.TilemapLayer.html" > Phaser.TilemapLayer< / a > }< / span > < / h4 >
2014-02-08 07:24:22 +00:00
< / dt >
< dd >
< div class = "description" >
2014-03-24 12:41:45 +00:00
< p > Creates an empty map of the given dimensions and one blank layer. If layers already exist they are erased.< / p >
2014-02-08 07:24:22 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-03-24 12:41:45 +00:00
< th > Argument< / th >
2014-02-08 07:24:22 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2014-03-24 12:41:45 +00:00
< td class = "attributes" >
2014-02-08 07:24:22 +00:00
2014-03-24 12:41:45 +00:00
< / td >
2014-02-08 07:24:22 +00:00
2014-03-24 12:41:45 +00:00
< td class = "description last" > < p > The name of the default layer of the map.< / p > < / td >
2014-02-08 07:24:22 +00:00
< / tr >
< tr >
< td class = "name" > < code > width< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-03-24 12:41:45 +00:00
< td class = "attributes" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The width of the map in tiles.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > height< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-03-24 12:41:45 +00:00
< td class = "attributes" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The height of the map in tiles.< / p > < / td >
< / tr >
2014-02-18 03:01:51 +00:00
< tr >
2014-03-14 06:36:05 +00:00
< td class = "name" > < code > tileWidth< / code > < / td >
2014-02-18 03:01:51 +00:00
< td class = "type" >
2014-03-14 06:36:05 +00:00
< span class = "param-type" > number< / span >
2014-02-18 03:01:51 +00:00
< / td >
2014-03-24 12:41:45 +00:00
< td class = "attributes" >
< / td >
2014-02-18 03:01:51 +00:00
2014-03-14 06:36:05 +00:00
< td class = "description last" > < p > The width of the tiles the map uses for calculations.< / p > < / td >
2014-02-18 03:01:51 +00:00
< / tr >
< tr >
2014-03-14 06:36:05 +00:00
< td class = "name" > < code > tileHeight< / code > < / td >
2014-02-18 03:01:51 +00:00
< td class = "type" >
2014-03-14 06:36:05 +00:00
< span class = "param-type" > number< / span >
2014-02-18 03:01:51 +00:00
< / td >
2014-03-24 12:41:45 +00:00
< td class = "attributes" >
< / td >
2014-02-18 03:01:51 +00:00
2014-03-14 06:36:05 +00:00
< td class = "description last" > < p > The height of the tiles the map uses for calculations.< / p > < / td >
2014-02-18 03:01:51 +00:00
< / tr >
2014-03-24 12:41:45 +00:00
< tr >
< td class = "name" > < code > group< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Group.html" > Phaser.Group< / a > < / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > < p > Optional Group to add the layer to. If not specified it will be added to the World group.< / p > < / td >
< / tr >
2014-02-18 03:01:51 +00:00
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-05-20 09:12:48 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-197" > line 197< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
< / dl >
2014-03-24 12:41:45 +00:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The TilemapLayer object. This is an extension of Phaser.Image and can be moved around the display list accordingly.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.TilemapLayer.html" > Phaser.TilemapLayer< / a > < / span >
< / dd >
< / dl >
2014-02-18 03:01:51 +00:00
< / dd >
< dt >
2014-07-10 19:31:11 +00:00
< h4 class = "name" id = "createBlankLayer" > < span class = "type-signature" > < / span > createBlankLayer< span class = "signature" > (name, width, height, tileWidth, tileHeight, < span class = "optional" > group< / span > )< / span > < span class = "type-signature" > → {< a href = "Phaser.TilemapLayer.html" > Phaser.TilemapLayer< / a > }< / span > < / h4 >
2014-02-08 07:24:22 +00:00
< / dt >
< dd >
< div class = "description" >
2014-07-10 19:31:11 +00:00
< p > Creates a new and empty layer on this Tilemap. By default TilemapLayers are fixed to the camera.< / p >
2014-02-08 07:24:22 +00:00
< / 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 > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
2014-07-10 19:31:11 +00:00
< td class = "description last" > < p > The name of this layer. Must be unique within the map.< / p > < / td >
2014-02-08 07:24:22 +00:00
< / tr >
< tr >
2014-07-10 19:31:11 +00:00
< td class = "name" > < code > width< / code > < / td >
2014-02-08 07:24:22 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
2014-07-10 19:31:11 +00:00
< td class = "description last" > < p > The width of the layer in tiles.< / p > < / td >
2014-02-08 07:24:22 +00:00
< / tr >
< tr >
2014-07-10 19:31:11 +00:00
< td class = "name" > < code > height< / code > < / td >
2014-02-08 07:24:22 +00:00
< td class = "type" >
2014-07-10 19:31:11 +00:00
< span class = "param-type" > number< / span >
2014-02-08 07:24:22 +00:00
< / td >
< td class = "attributes" >
< / td >
2014-07-10 19:31:11 +00:00
< td class = "description last" > < p > The height of the layer in tiles.< / p > < / td >
2014-02-08 07:24:22 +00:00
< / tr >
< tr >
2014-07-10 19:31:11 +00:00
< td class = "name" > < code > tileWidth< / code > < / td >
2014-02-08 07:24:22 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
2014-07-10 19:31:11 +00:00
< td class = "description last" > < p > The width of the tiles the layer uses for calculations.< / p > < / td >
2014-02-08 07:24:22 +00:00
< / tr >
< tr >
2014-07-10 19:31:11 +00:00
< td class = "name" > < code > tileHeight< / code > < / td >
2014-02-08 07:24:22 +00:00
< td class = "type" >
2014-07-10 19:31:11 +00:00
< span class = "param-type" > number< / span >
2014-02-08 07:24:22 +00:00
< / td >
< td class = "attributes" >
< / td >
2014-07-10 19:31:11 +00:00
< td class = "description last" > < p > The height of the tiles the layer uses for calculations.< / p > < / td >
2014-02-08 07:24:22 +00:00
< / tr >
< tr >
2014-07-10 19:31:11 +00:00
< td class = "name" > < code > group< / code > < / td >
2014-02-08 07:24:22 +00:00
< td class = "type" >
2014-07-10 19:31:11 +00:00
< span class = "param-type" > < a href = "Phaser.Group.html" > Phaser.Group< / a > < / span >
2014-02-08 07:24:22 +00:00
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2014-07-10 19:31:11 +00:00
< td class = "description last" > < p > Optional Group to add the layer to. If not specified it will be added to the World group.< / p > < / td >
2014-02-08 07:24:22 +00:00
< / tr >
2014-07-10 19:31:11 +00:00
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-459" > line 459< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The TilemapLayer object. This is an extension of Phaser.Image and can be moved around the display list accordingly.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.TilemapLayer.html" > Phaser.TilemapLayer< / a > < / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "createFromObjects" > < span class = "type-signature" > < / span > createFromObjects< span class = "signature" > (name, gid, key, < span class = "optional" > frame< / span > , < span class = "optional" > exists< / span > , < span class = "optional" > autoCull< / span > , < span class = "optional" > group< / span > , < span class = "optional" > CustomClass< / span > , < span class = "optional" > adjustY< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Creates a Sprite for every object matching the given gid in the map data. You can optionally specify the group that the Sprite will be created in. If none is
given it will be created in the World. All properties from the map data objectgroup are copied across to the Sprite, so you can use this as an easy way to
configure Sprite properties from within the map editor. For example giving an object a property of alpha: 0.5 in the map editor will duplicate that when the
Sprite is created. You could also give it a value like: body.velocity.x: 100 to set it moving automatically.< / 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 >
2014-02-08 07:24:22 +00:00
< tr >
2014-07-10 19:31:11 +00:00
< td class = "name" > < code > name< / code > < / td >
2014-02-08 07:24:22 +00:00
< td class = "type" >
2014-07-10 19:31:11 +00:00
< span class = "param-type" > string< / span >
2014-02-08 07:24:22 +00:00
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
2014-03-14 06:36:05 +00:00
< / td >
2014-07-10 19:31:11 +00:00
< td class = "description last" > < p > The name of the Object Group to create Sprites from.< / p > < / td >
2014-03-14 06:36:05 +00:00
< / tr >
< tr >
2014-07-10 19:31:11 +00:00
< td class = "name" > < code > gid< / code > < / td >
2014-03-14 06:36:05 +00:00
< td class = "type" >
2014-07-10 19:31:11 +00:00
< span class = "param-type" > number< / span >
2014-03-14 06:36:05 +00:00
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
2014-02-08 07:24:22 +00:00
< / td >
2014-07-10 19:31:11 +00:00
< td class = "description last" > < p > The layer array index value, or if a string is given the layer name within the map data.< / p > < / td >
2014-02-08 07:24:22 +00:00
< / tr >
2014-03-24 12:41:45 +00:00
< tr >
2014-07-10 19:31:11 +00:00
< td class = "name" > < code > key< / code > < / td >
2014-03-24 12:41:45 +00:00
< td class = "type" >
2014-07-10 19:31:11 +00:00
< span class = "param-type" > string< / span >
2014-03-24 12:41:45 +00:00
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
2014-07-10 19:31:11 +00:00
< td class = "description last" > < p > The Game.cache key of the image that this Sprite will use.< / p > < / td >
2014-03-24 12:41:45 +00:00
< / tr >
2014-02-08 07:24:22 +00:00
2014-07-10 19:31:11 +00:00
< tr >
< td class = "name" > < code > frame< / code > < / td >
2014-02-08 07:24:22 +00:00
2014-07-10 19:31:11 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
|
2014-02-08 07:24:22 +00:00
2014-07-10 19:31:11 +00:00
< span class = "param-type" > string< / span >
2014-02-08 07:24:22 +00:00
2014-07-10 19:31:11 +00:00
< / td >
2014-02-08 07:24:22 +00:00
2014-07-10 19:31:11 +00:00
< td class = "attributes" >
< optional>< br >
2014-02-08 07:24:22 +00:00
2014-07-10 19:31:11 +00:00
2014-02-08 07:24:22 +00:00
2014-07-10 19:31:11 +00:00
< / td >
2014-02-08 07:24:22 +00:00
2014-07-10 19:31:11 +00:00
< td class = "default" >
< / td >
2014-02-08 07:24:22 +00:00
2014-07-10 19:31:11 +00:00
< td class = "description last" > < p > If the Sprite image contains multiple frames you can specify which one to use here.< / p > < / td >
< / tr >
2014-02-08 07:24:22 +00:00
2014-07-10 19:31:11 +00:00
2014-02-08 07:24:22 +00:00
2014-07-10 19:31:11 +00:00
< tr >
< td class = "name" > < code > exists< / code > < / td >
2014-02-08 07:24:22 +00:00
2014-07-10 19:31:11 +00:00
< td class = "type" >
< span class = "param-type" > boolean< / span >
2014-02-08 07:24:22 +00:00
2014-07-10 19:31:11 +00:00
< / td >
2014-02-08 07:24:22 +00:00
2014-07-10 19:31:11 +00:00
< td class = "attributes" >
< optional>< br >
2014-02-08 07:24:22 +00:00
2014-07-10 19:31:11 +00:00
2014-02-08 07:24:22 +00:00
2014-07-10 19:31:11 +00:00
< / td >
2014-02-08 07:24:22 +00:00
2014-07-10 19:31:11 +00:00
< td class = "default" >
true
< / td >
2014-02-08 07:24:22 +00:00
2014-07-10 19:31:11 +00:00
< td class = "description last" > < p > The default exists state of the Sprite.< / p > < / td >
< / tr >
2014-02-08 07:24:22 +00:00
< tr >
2014-07-10 19:31:11 +00:00
< td class = "name" > < code > autoCull< / code > < / td >
2014-02-08 07:24:22 +00:00
< td class = "type" >
2014-07-10 19:31:11 +00:00
< span class = "param-type" > boolean< / span >
2014-02-08 07:24:22 +00:00
< / td >
< td class = "attributes" >
2014-07-10 19:31:11 +00:00
< optional>< br >
2014-02-08 07:24:22 +00:00
< / td >
2014-07-10 19:31:11 +00:00
< td class = "default" >
false
< / td >
2014-02-08 07:24:22 +00:00
2014-07-10 19:31:11 +00:00
< td class = "description last" > < p > The default autoCull state of the Sprite. Sprites that are autoCulled are culled from the camera if out of its range.< / p > < / td >
2014-02-08 07:24:22 +00:00
< / tr >
< tr >
2014-07-10 19:31:11 +00:00
< td class = "name" > < code > group< / code > < / td >
2014-02-08 07:24:22 +00:00
< td class = "type" >
2014-07-10 19:31:11 +00:00
< span class = "param-type" > < a href = "Phaser.Group.html" > Phaser.Group< / a > < / span >
2014-02-08 07:24:22 +00:00
< / td >
< td class = "attributes" >
< optional>< br >
2014-07-10 19:31:11 +00:00
< / td >
< td class = "default" >
Phaser.World
2014-02-08 07:24:22 +00:00
< / td >
2014-07-10 19:31:11 +00:00
< td class = "description last" > < p > Group to add the Sprite to. If not specified it will be added to the World group.< / p > < / td >
2014-02-08 07:24:22 +00:00
< / tr >
< tr >
2014-07-10 19:31:11 +00:00
< td class = "name" > < code > CustomClass< / code > < / td >
2014-02-08 07:24:22 +00:00
< td class = "type" >
2014-07-10 19:31:11 +00:00
< span class = "param-type" > object< / span >
2014-02-08 07:24:22 +00:00
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2014-07-10 19:31:11 +00:00
< td class = "default" >
Phaser.Sprite
< / td >
2014-02-08 07:24:22 +00:00
2014-07-10 19:31:11 +00:00
< td class = "description last" > < p > If you wish to create your own class, rather than Phaser.Sprite, pass the class here. Your class must extend Phaser.Sprite and have the same constructor parameters.< / p > < / td >
2014-02-08 07:24:22 +00:00
< / tr >
< tr >
2014-07-10 19:31:11 +00:00
< td class = "name" > < code > adjustY< / code > < / td >
2014-02-08 07:24:22 +00:00
< td class = "type" >
2014-07-10 19:31:11 +00:00
< span class = "param-type" > boolean< / span >
2014-02-08 07:24:22 +00:00
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2014-07-10 19:31:11 +00:00
< td class = "default" >
true
< / td >
2014-02-08 07:24:22 +00:00
2014-07-10 19:31:11 +00:00
< td class = "description last" > < p > By default the Tiled map editor uses a bottom-left coordinate system. Phaser uses top-left. So most objects will appear too low down. This parameter moves them up by their height.< / p > < / td >
2014-02-08 07:24:22 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-07-10 19:31:11 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-361" > line 361< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
2014-03-24 12:41:45 +00:00
< / dd >
< dt >
2014-07-10 19:31:11 +00:00
< h4 class = "name" id = "createLayer" > < span class = "type-signature" > < / span > createLayer< span class = "signature" > (layer, < span class = "optional" > width< / span > , < span class = "optional" > height< / span > , < span class = "optional" > group< / span > )< / span > < span class = "type-signature" > → {< a href = "Phaser.TilemapLayer.html" > Phaser.TilemapLayer< / a > }< / span > < / h4 >
2014-03-24 12:41:45 +00:00
< / dt >
< dd >
< div class = "description" >
2014-07-10 19:31:11 +00:00
< p > Creates a new TilemapLayer object. By default TilemapLayers are fixed to the camera.
The < code > layer< / code > parameter is important. If you've created your map in Tiled then you can get this by looking in Tiled and looking at the Layer name.
Or you can open the JSON file it exports and look at the layers[].name value. Either way it must match.
If you wish to create a blank layer to put your own tiles on then see Tilemap.createBlankLayer.< / p >
2014-03-24 12:41:45 +00:00
< / 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 >
2014-07-10 19:31:11 +00:00
< td class = "name" > < code > layer< / code > < / td >
2014-03-24 12:41:45 +00:00
< td class = "type" >
2014-07-10 19:31:11 +00:00
< span class = "param-type" > number< / span >
|
2014-03-24 12:41:45 +00:00
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
2014-07-10 19:31:11 +00:00
< td class = "description last" > < p > The layer array index value, or if a string is given the layer name, within the map data that this TilemapLayer represents.< / p > < / td >
2014-03-24 12:41:45 +00:00
< / tr >
< tr >
< td class = "name" > < code > width< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
2014-07-10 19:31:11 +00:00
< optional>< br >
2014-03-24 12:41:45 +00:00
< / td >
2014-07-10 19:31:11 +00:00
< td class = "description last" > < p > The rendered width of the layer, should never be wider than Game.width. If not given it will be set to Game.width.< / p > < / td >
2014-03-24 12:41:45 +00:00
< / tr >
< tr >
2014-07-10 19:31:11 +00:00
< td class = "name" > < code > height< / code > < / td >
2014-03-24 12:41:45 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
2014-07-10 19:31:11 +00:00
< optional>< br >
2014-03-24 12:41:45 +00:00
< / td >
2014-07-10 19:31:11 +00:00
< td class = "description last" > < p > The rendered height of the layer, should never be wider than Game.height. If not given it will be set to Game.height.< / p > < / td >
2014-03-24 12:41:45 +00:00
< / tr >
< tr >
< td class = "name" > < code > group< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Group.html" > Phaser.Group< / a > < / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2014-07-10 19:31:11 +00:00
< td class = "description last" > < p > Optional Group to add the object to. If not specified it will be added to the World group.< / p > < / td >
2014-03-24 12:41:45 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-07-10 19:31:11 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-421" > line 421< / a >
2014-03-24 12:41:45 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2014-07-10 19:31:11 +00:00
< p > The TilemapLayer object. This is an extension of Phaser.Sprite and can be moved around the display list accordingly.< / p >
2014-03-24 12:41:45 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.TilemapLayer.html" > Phaser.TilemapLayer< / a > < / span >
< / dd >
< / dl >
2014-02-08 07:24:22 +00:00
< / dd >
< dt >
< h4 class = "name" id = "destroy" > < span class = "type-signature" > < / span > destroy< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
2014-04-29 14:39:02 +00:00
< p > Removes all layer data from this tile map and nulls the game reference.
Note: You are responsible for destroying any TilemapLayer objects you generated yourself, as Tilemap doesn't keep a reference to them.< / p >
2014-02-08 07:24:22 +00:00
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-07-10 19:31:11 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-1756" > line 1756< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "dump" > < span class = "type-signature" > < / span > dump< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Dumps the tilemap data out to the console.< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-07-10 19:31:11 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-1715" > line 1715< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "fill" > < span class = "type-signature" > < / span > fill< span class = "signature" > (index, x, y, width, height, < span class = "optional" > layer< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Fills the given area with the specified tile.< / 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 > index< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The index of the tile that the area will be filled with.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > X position of the top left of the area to operate one, given in tiles, not pixels.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > Y position of the top left of the area to operate one, given in tiles, not pixels.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > width< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The width in tiles of the area to operate on.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > height< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The height in tiles of the area to operate on.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > layer< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
|
< span class = "param-type" > string< / span >
|
< span class = "param-type" > < a href = "Phaser.TilemapLayer.html" > Phaser.TilemapLayer< / a > < / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > < p > The layer to operate on.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-07-10 19:31:11 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-1672" > line 1672< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "forEach" > < span class = "type-signature" > < / span > forEach< span class = "signature" > (callback, context, x, y, width, height, < span class = "optional" > layer< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > For each tile in the given area defined by x/y and width/height run the given callback.< / 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 > callback< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The callback. Each tile in the given area will be passed to this callback as the first and only parameter.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > context< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The context under which the callback should be run.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > X position of the top left of the area to operate one, given in tiles, not pixels.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > Y position of the top left of the area to operate one, given in tiles, not pixels.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > width< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The width in tiles of the area to operate on.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > height< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The height in tiles of the area to operate on.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > layer< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
|
< span class = "param-type" > string< / span >
|
< span class = "param-type" > < a href = "Phaser.TilemapLayer.html" > Phaser.TilemapLayer< / a > < / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > < p > The layer to operate on.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-07-10 19:31:11 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-1521" > line 1521< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "getImageIndex" > < span class = "type-signature" > < / span > getImageIndex< span class = "signature" > (name)< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Gets the image index based on its name.< / 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 > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < p > The name of the image to get.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-05-20 09:12:48 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-591" > line 591< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The index of the image in this tilemap, or null if not found.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "getIndex" > < span class = "type-signature" > < protected> < / span > getIndex< span class = "signature" > (location, name)< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Gets the layer index based on the layers name.< / 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 > location< / code > < / td >
< td class = "type" >
< span class = "param-type" > array< / span >
< / td >
< td class = "description last" > < p > The local array to search.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < p > The name of the array element to get.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-05-20 09:12:48 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-542" > line 542< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The index of the element in the array, or null if not found.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "getLayer" > < span class = "type-signature" > < protected> < / span > getLayer< span class = "signature" > (layer)< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Gets the TilemapLayer index as used in the setCollision calls.< / 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 > layer< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
|
< span class = "param-type" > string< / span >
|
< span class = "param-type" > < a href = "Phaser.TilemapLayer.html" > Phaser.TilemapLayer< / a > < / span >
< / td >
< td class = "description last" > < p > The layer to operate on. If not given will default to this.currentLayer.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-05-20 09:12:48 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-855" > line 855< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The TilemapLayer index.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "getLayerIndex" > < span class = "type-signature" > < / span > getLayerIndex< span class = "signature" > (name)< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Gets the layer index based on its name.< / 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 > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < p > The name of the layer to get.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-05-20 09:12:48 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-565" > line 565< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The index of the layer in this tilemap, or null if not found.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "getObjectIndex" > < span class = "type-signature" > < / span > getObjectIndex< span class = "signature" > (name)< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Gets the object index based on its name.< / 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 > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < p > The name of the object to get.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-05-20 09:12:48 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-604" > line 604< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The index of the object in this tilemap, or null if not found.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
< / dd >
< / dl >
< / dd >
< dt >
2014-05-20 09:12:48 +00:00
< h4 class = "name" id = "getTile" > < span class = "type-signature" > < / span > getTile< span class = "signature" > (x, y, < span class = "optional" > layer< / span > , < span class = "optional" > nonNull< / span > )< / span > < span class = "type-signature" > → {< a href = "Phaser.Tile.html" > Phaser.Tile< / a > }< / span > < / h4 >
2014-02-08 07:24:22 +00:00
< / dt >
< dd >
< div class = "description" >
< p > Gets a tile from the Tilemap Layer. The coordinates are given in tile values.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
2014-05-20 09:12:48 +00:00
< th > Default< / th >
2014-02-08 07:24:22 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
2014-05-20 09:12:48 +00:00
< td class = "default" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > X position to get the tile from (given in tile units, not pixels)< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
2014-05-20 09:12:48 +00:00
< td class = "default" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > Y position to get the tile from (given in tile units, not pixels)< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > layer< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
|
< span class = "param-type" > string< / span >
|
< span class = "param-type" > < a href = "Phaser.TilemapLayer.html" > Phaser.TilemapLayer< / a > < / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2014-05-20 09:12:48 +00:00
< td class = "default" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The layer to get the tile from.< / p > < / td >
< / tr >
2014-05-20 09:12:48 +00:00
< tr >
< td class = "name" > < code > nonNull< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
false
< / td >
< td class = "description last" > < p > If true getTile won't return null for empty tiles, but a Tile object with an index of -1.< / p > < / td >
< / tr >
2014-02-08 07:24:22 +00:00
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-07-10 19:31:11 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-1305" > line 1305< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2014-05-20 09:12:48 +00:00
< p > The tile at the given coordinates or null if no tile was found or the coordinates were invalid.< / p >
2014-02-08 07:24:22 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Tile.html" > Phaser.Tile< / a > < / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "getTileAbove" > < span class = "type-signature" > < / span > getTileAbove< span class = "signature" > (layer, x, y)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Gets the tile above the tile coordinates given.
Mostly used as an internal function by calculateFaces.< / 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 > layer< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The local layer index to get the tile from. Can be determined by Tilemap.getLayer().< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The x coordinate to get the tile from. In tiles, not pixels.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The y coordinate to get the tile from. In tiles, not pixels.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-07-10 19:31:11 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-977" > line 977< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "getTileBelow" > < span class = "type-signature" > < / span > getTileBelow< span class = "signature" > (layer, x, y)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Gets the tile below the tile coordinates given.
Mostly used as an internal function by calculateFaces.< / 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 > layer< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The local layer index to get the tile from. Can be determined by Tilemap.getLayer().< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The x coordinate to get the tile from. In tiles, not pixels.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The y coordinate to get the tile from. In tiles, not pixels.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-07-10 19:31:11 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-997" > line 997< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "getTileLeft" > < span class = "type-signature" > < / span > getTileLeft< span class = "signature" > (layer, x, y)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Gets the tile to the left of the tile coordinates given.
Mostly used as an internal function by calculateFaces.< / 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 > layer< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The local layer index to get the tile from. Can be determined by Tilemap.getLayer().< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The x coordinate to get the tile from. In tiles, not pixels.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The y coordinate to get the tile from. In tiles, not pixels.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-07-10 19:31:11 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-1017" > line 1017< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "getTileRight" > < span class = "type-signature" > < / span > getTileRight< span class = "signature" > (layer, x, y)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Gets the tile to the right of the tile coordinates given.
Mostly used as an internal function by calculateFaces.< / 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 > layer< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The local layer index to get the tile from. Can be determined by Tilemap.getLayer().< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The x coordinate to get the tile from. In tiles, not pixels.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The y coordinate to get the tile from. In tiles, not pixels.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-07-10 19:31:11 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-1037" > line 1037< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
2014-03-14 06:36:05 +00:00
< dt >
< h4 class = "name" id = "getTilesetIndex" > < span class = "type-signature" > < / span > getTilesetIndex< span class = "signature" > (name)< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Gets the tileset index based on its name.< / 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 > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < p > The name of the tileset to get.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-05-20 09:12:48 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-578" > line 578< / a >
2014-03-14 06:36:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The index of the tileset in this tilemap, or null if not found.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "getTileWorldXY" > < span class = "type-signature" > < / span > getTileWorldXY< span class = "signature" > (x, y, < span class = "optional" > tileWidth< / span > , < span class = "optional" > tileHeight< / span > , < span class = "optional" > layer< / span > )< / span > < span class = "type-signature" > → {< a href = "Phaser.Tile.html" > Phaser.Tile< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Gets a tile from the Tilemap layer. The coordinates are given in pixel values.< / 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 > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > X position to get the tile from (given in pixels)< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > Y position to get the tile from (given in pixels)< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > tileWidth< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > < p > The width of the tiles. If not given the map default is used.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > tileHeight< / code > < / td >
2014-02-08 07:24:22 +00:00
2014-03-14 06:36:05 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
2014-02-08 07:24:22 +00:00
2014-03-14 06:36:05 +00:00
< / td >
2014-02-08 07:24:22 +00:00
2014-03-14 06:36:05 +00:00
< td class = "attributes" >
< optional>< br >
2014-02-08 07:24:22 +00:00
2014-03-14 06:36:05 +00:00
2014-02-08 07:24:22 +00:00
2014-03-14 06:36:05 +00:00
< / td >
< td class = "description last" > < p > The height of the tiles. If not given the map default is used.< / p > < / td >
< / tr >
2014-02-08 07:24:22 +00:00
< tr >
2014-03-14 06:36:05 +00:00
< td class = "name" > < code > layer< / code > < / td >
2014-02-08 07:24:22 +00:00
< td class = "type" >
2014-03-14 06:36:05 +00:00
< span class = "param-type" > number< / span >
|
2014-02-08 07:24:22 +00:00
< span class = "param-type" > string< / span >
2014-03-14 06:36:05 +00:00
|
< span class = "param-type" > < a href = "Phaser.TilemapLayer.html" > Phaser.TilemapLayer< / a > < / span >
2014-02-08 07:24:22 +00:00
< / td >
2014-03-14 06:36:05 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2014-02-08 07:24:22 +00:00
2014-03-14 06:36:05 +00:00
< td class = "description last" > < p > The layer to get the tile from.< / p > < / td >
2014-02-08 07:24:22 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-07-10 19:31:11 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-1346" > line 1346< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2014-03-14 06:36:05 +00:00
< p > The tile at the given coordinates.< / p >
2014-02-08 07:24:22 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2014-03-14 06:36:05 +00:00
< span class = "param-type" > < a href = "Phaser.Tile.html" > Phaser.Tile< / a > < / span >
2014-02-08 07:24:22 +00:00
< / dd >
< / dl >
< / dd >
< dt >
2014-03-14 06:36:05 +00:00
< h4 class = "name" id = "hasTile" > < span class = "type-signature" > < / span > hasTile< span class = "signature" > (x, y, layer)< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
2014-02-08 07:24:22 +00:00
< / dt >
< dd >
< div class = "description" >
2014-03-14 06:36:05 +00:00
< p > Checks if there is a tile at the given location.< / p >
2014-02-08 07:24:22 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-03-14 06:36:05 +00:00
< td class = "description last" > < p > X position to check if a tile exists at (given in tile units, not pixels)< / p > < / td >
2014-02-08 07:24:22 +00:00
< / tr >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-03-14 06:36:05 +00:00
< td class = "description last" > < p > Y position to check if a tile exists at (given in tile units, not pixels)< / p > < / td >
2014-02-08 07:24:22 +00:00
< / tr >
< tr >
< td class = "name" > < code > layer< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
|
< span class = "param-type" > string< / span >
|
< span class = "param-type" > < a href = "Phaser.TilemapLayer.html" > Phaser.TilemapLayer< / a > < / span >
< / td >
2014-03-14 06:36:05 +00:00
< td class = "description last" > < p > The layer to set as current.< / p > < / td >
2014-02-08 07:24:22 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-07-10 19:31:11 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-1074" > line 1074< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2014-03-14 06:36:05 +00:00
< p > True if there is a tile at the given location, otherwise false.< / p >
2014-02-08 07:24:22 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2014-03-14 06:36:05 +00:00
< span class = "param-type" > boolean< / span >
2014-02-08 07:24:22 +00:00
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "paste" > < span class = "type-signature" > < / span > paste< span class = "signature" > (x, y, tileblock, < span class = "optional" > layer< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Pastes a previously copied block of tile data into the given x/y coordinates. Data should have been prepared with Tilemap.copy.< / 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 > x< / code > < / td >
< td class = "type" >
2014-02-05 06:29:17 +00:00
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > X position of the top left of the area to paste to (given in tiles, not pixels)< / p > < / td >
2014-02-05 06:29:17 +00:00
< / tr >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > y< / code > < / td >
2014-02-05 06:29:17 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
2013-11-28 15:57:09 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > Y position of the top left of the area to paste to (given in tiles, not pixels)< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > tileblock< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-02-08 07:24:22 +00:00
< span class = "param-type" > array< / span >
2013-11-28 15:57:09 +00:00
< / td >
< td class = "attributes" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The block of tiles to paste.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
< td class = "name" > < code > layer< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
2014-02-05 06:29:17 +00:00
|
< span class = "param-type" > string< / span >
|
< span class = "param-type" > < a href = "Phaser.TilemapLayer.html" > Phaser.TilemapLayer< / a > < / span >
2013-11-28 15:57:09 +00:00
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The layer to paste the tiles into.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-07-10 19:31:11 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-1433" > line 1433< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-03-24 12:41:45 +00:00
< h4 class = "name" id = "putTile" > < span class = "type-signature" > < / span > putTile< span class = "signature" > (tile, x, y, < span class = "optional" > layer< / span > )< / span > < span class = "type-signature" > → {< a href = "Phaser.Tile.html" > Phaser.Tile< / a > }< / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< div class = "description" >
2014-04-10 22:13:43 +00:00
< p > Puts a tile of the given index value at the coordinate specified.
If you pass < code > null< / code > as the tile it will pass your call over to Tilemap.removeTile instead.< / p >
2013-11-28 15:57:09 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-02-08 07:24:22 +00:00
< th > Argument< / th >
2013-11-28 15:57:09 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > tile< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-02-08 07:24:22 +00:00
< span class = "param-type" > < a href = "Phaser.Tile.html" > Phaser.Tile< / a > < / span >
|
< span class = "param-type" > number< / span >
2014-04-10 22:13:43 +00:00
|
< span class = "param-type" > null< / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "attributes" >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< / td >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
2014-04-10 22:13:43 +00:00
< td class = "description last" > < p > The index of this tile to set or a Phaser.Tile object. If null the tile is removed from the map.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > x< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "attributes" >
< / td >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > X position to place the tile (given in tile units, not pixels)< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > y< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "attributes" >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< / td >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > Y position to place the tile (given in tile units, not pixels)< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
2014-02-08 07:24:22 +00:00
< tr >
< td class = "name" > < code > layer< / code > < / td >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
|
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< span class = "param-type" > string< / span >
|
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< span class = "param-type" > < a href = "Phaser.TilemapLayer.html" > Phaser.TilemapLayer< / a > < / span >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< / td >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< td class = "attributes" >
< optional>< br >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< / td >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The layer to modify.< / p > < / td >
< / tr >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< / tbody >
< / table >
2013-11-28 15:57:09 +00:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-07-10 19:31:11 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-1144" > line 1144< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
2014-03-24 12:41:45 +00:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The Tile object that was created or added to this map.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Tile.html" > Phaser.Tile< / a > < / span >
< / dd >
< / dl >
2013-11-28 15:57:09 +00:00
< / dd >
< dt >
2014-04-10 22:13:43 +00:00
< h4 class = "name" id = "putTileWorldXY" > < span class = "type-signature" > < / span > putTileWorldXY< span class = "signature" > (tile, x, y, tileWidth, tileHeight, < span class = "optional" > layer< / span > )< / span > < span class = "type-signature" > → {< a href = "Phaser.Tile.html" > Phaser.Tile< / a > }< / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< div class = "description" >
2014-02-08 07:24:22 +00:00
< p > Puts a tile into the Tilemap layer. The coordinates are given in pixel values.< / p >
2013-11-28 15:57:09 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > tile< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-02-08 07:24:22 +00:00
< span class = "param-type" > < a href = "Phaser.Tile.html" > Phaser.Tile< / a > < / span >
|
2013-11-28 15:57:09 +00:00
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The index of this tile to set or a Phaser.Tile object.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
< td class = "name" > < code > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > X position to insert the tile (given in pixels)< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > Y position to insert the tile (given in pixels)< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > tileWidth< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The width of the tile in pixels.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > tileHeight< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The height of the tile in pixels.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
< td class = "name" > < code > layer< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
2014-02-05 06:29:17 +00:00
|
< span class = "param-type" > string< / span >
|
< span class = "param-type" > < a href = "Phaser.TilemapLayer.html" > Phaser.TilemapLayer< / a > < / span >
2013-11-28 15:57:09 +00:00
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The layer to modify.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-07-10 19:31:11 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-1215" > line 1215< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
2014-04-10 22:13:43 +00:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The Tile object that was created or added to this map.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Tile.html" > Phaser.Tile< / a > < / span >
< / dd >
< / dl >
2013-11-28 15:57:09 +00:00
< / dd >
< dt >
2014-02-08 07:24:22 +00:00
< h4 class = "name" id = "random" > < span class = "type-signature" > < / span > random< span class = "signature" > (x, y, width, height, < span class = "optional" > layer< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< div class = "description" >
2014-02-08 07:24:22 +00:00
< p > Randomises a set of tiles in a given area.< / p >
2013-11-28 15:57:09 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > x< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > X position of the top left of the area to operate one, given in tiles, not pixels.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > y< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > Y position of the top left of the area to operate one, given in tiles, not pixels.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > width< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The width in tiles of the area to operate on.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > height< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The height in tiles of the area to operate on.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > layer< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
|
< span class = "param-type" > string< / span >
|
< span class = "param-type" > < a href = "Phaser.TilemapLayer.html" > Phaser.TilemapLayer< / a > < / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > < p > The layer to operate on.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-07-10 19:31:11 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-1585" > line 1585< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< dt >
< h4 class = "name" id = "removeAllLayers" > < span class = "type-signature" > < / span > removeAllLayers< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Removes all layers from this tile map.< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-07-10 19:31:11 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-1703" > line 1703< / a >
2014-04-10 22:13:43 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "removeTile" > < span class = "type-signature" > < / span > removeTile< span class = "signature" > (x, y, < span class = "optional" > layer< / span > )< / span > < span class = "type-signature" > → {< a href = "Phaser.Tile.html" > Phaser.Tile< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Removes the tile located at the given coordinates and updates the collision data.< / 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 > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > X position to place the tile (given in tile units, not pixels)< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > Y position to place the tile (given in tile units, not pixels)< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > layer< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
|
< span class = "param-type" > string< / span >
|
< span class = "param-type" > < a href = "Phaser.TilemapLayer.html" > Phaser.TilemapLayer< / a > < / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > < p > The layer to modify.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-07-10 19:31:11 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-1091" > line 1091< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
2014-04-10 22:13:43 +00:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The Tile object that was removed from this map.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Tile.html" > Phaser.Tile< / a > < / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "removeTileWorldXY" > < span class = "type-signature" > < / span > removeTileWorldXY< span class = "signature" > (x, y, tileWidth, tileHeight, < span class = "optional" > layer< / span > )< / span > < span class = "type-signature" > → {< a href = "Phaser.Tile.html" > Phaser.Tile< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Removes the tile located at the given coordinates and updates the collision data. The coordinates are given in pixel values.< / 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 > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > X position to insert the tile (given in pixels)< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > Y position to insert the tile (given in pixels)< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > tileWidth< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The width of the tile in pixels.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > tileHeight< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The height of the tile in pixels.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > layer< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
|
< span class = "param-type" > string< / span >
|
< span class = "param-type" > < a href = "Phaser.TilemapLayer.html" > Phaser.TilemapLayer< / a > < / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > < p > The layer to modify.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-07-10 19:31:11 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-1122" > line 1122< / a >
2014-04-10 22:13:43 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The Tile object that was removed from this map.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Tile.html" > Phaser.Tile< / a > < / span >
< / dd >
< / dl >
2014-02-08 07:24:22 +00:00
< / dd >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< dt >
< h4 class = "name" id = "replace" > < span class = "type-signature" > < / span > replace< span class = "signature" > (source, dest, x, y, width, height, < span class = "optional" > layer< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Scans the given area for tiles with an index matching < code > source< / code > and updates their index to match < code > dest< / code > .< / p >
< / div >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< h5 > Parameters:< / h5 >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< th > Type< / th >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< th > Argument< / th >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< tbody >
2013-11-28 15:57:09 +00:00
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > source< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The tile index value to scan for.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > dest< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The tile index value to replace found tiles with.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > x< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > X position of the top left of the area to operate one, given in tiles, not pixels.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > y< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > Y position of the top left of the area to operate one, given in tiles, not pixels.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > width< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The width in tiles of the area to operate on.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > height< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The height in tiles of the area to operate on.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
< td class = "name" > < code > layer< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
2014-02-05 06:29:17 +00:00
|
< span class = "param-type" > string< / span >
|
< span class = "param-type" > < a href = "Phaser.TilemapLayer.html" > Phaser.TilemapLayer< / a > < / span >
2013-11-28 15:57:09 +00:00
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The layer to operate on.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-07-10 19:31:11 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-1550" > line 1550< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-05-20 09:12:48 +00:00
< h4 class = "name" id = "searchTileIndex" > < span class = "type-signature" > < / span > searchTileIndex< span class = "signature" > (index, < span class = "optional" > skip< / span > , < span class = "optional" > reverse< / span > , < span class = "optional" > layer< / span > )< / span > < span class = "type-signature" > → {< a href = "Phaser.Tile.html" > Phaser.Tile< / a > }< / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< div class = "description" >
2014-05-20 09:12:48 +00:00
< p > Searches the entire map layer for the first tile matching the given index, then returns that Phaser.Tile object.
If no match is found it returns null.
The search starts from the top-left tile and continues horizontally until it hits the end of the row, then it drops down to the next column.
If the reverse boolean is true, it scans starting from the bottom-right corner travelling up to the top-left.< / p >
2013-11-28 15:57:09 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
2014-02-08 07:24:22 +00:00
< th > Default< / th >
2013-11-28 15:57:09 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-05-20 09:12:48 +00:00
< td class = "name" > < code > index< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
2014-02-08 07:24:22 +00:00
2014-05-20 09:12:48 +00:00
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > The tile index value to search for.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > skip< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
2013-11-28 15:57:09 +00:00
< / td >
< td class = "attributes" >
2014-05-20 09:12:48 +00:00
< optional>< br >
2013-11-28 15:57:09 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "default" >
2014-05-20 09:12:48 +00:00
0
2014-02-08 07:24:22 +00:00
< / td >
2013-11-28 15:57:09 +00:00
2014-05-20 09:12:48 +00:00
< td class = "description last" > < p > The number of times to skip a matching tile before returning.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-05-20 09:12:48 +00:00
< td class = "name" > < code > reverse< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-05-20 09:12:48 +00:00
< span class = "param-type" > number< / span >
2013-11-28 15:57:09 +00:00
< / td >
< td class = "attributes" >
2014-02-08 07:24:22 +00:00
< optional>< br >
2013-11-28 15:57:09 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "default" >
2014-05-20 09:12:48 +00:00
false
2014-02-08 07:24:22 +00:00
< / td >
2013-11-28 15:57:09 +00:00
2014-05-20 09:12:48 +00:00
< td class = "description last" > < p > If true it will scan the layer in reverse, starting at the bottom-right. Otherwise it scans from the top-left.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
< td class = "name" > < code > layer< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
2014-02-05 06:29:17 +00:00
|
< span class = "param-type" > string< / span >
|
< span class = "param-type" > < a href = "Phaser.TilemapLayer.html" > Phaser.TilemapLayer< / a > < / span >
2013-11-28 15:57:09 +00:00
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "default" >
< / td >
2013-11-28 15:57:09 +00:00
2014-05-20 09:12:48 +00:00
< td class = "description last" > < p > The layer to get the tile from.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-07-10 19:31:11 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-1238" > line 1238< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
2014-05-20 09:12:48 +00:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The first (or n skipped) tile with the matching index.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Tile.html" > Phaser.Tile< / a > < / span >
< / dd >
< / dl >
2013-11-28 15:57:09 +00:00
< / dd >
< dt >
2014-05-20 09:12:48 +00:00
< h4 class = "name" id = "setCollision" > < span class = "type-signature" > < / span > setCollision< span class = "signature" > (indexes, < span class = "optional" > collides< / span > , < span class = "optional" > layer< / span > , < span class = "optional" > recalculate< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< div class = "description" >
2014-05-20 09:12:48 +00:00
< p > Sets collision the given tile or tiles. You can pass in either a single numeric index or an array of indexes: [ 2, 3, 15, 20].
2014-02-08 07:24:22 +00:00
The < code > collides< / code > parameter controls if collision will be enabled (true) or disabled (false).< / p >
2013-11-28 15:57:09 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-02-05 06:29:17 +00:00
< th > Argument< / th >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< th > Default< / th >
2013-11-28 15:57:09 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-05-20 09:12:48 +00:00
< td class = "name" > < code > indexes< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
2014-05-20 09:12:48 +00:00
|
< span class = "param-type" > array< / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-02-05 06:29:17 +00:00
< td class = "attributes" >
< / td >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< td class = "default" >
< / td >
2013-11-28 15:57:09 +00:00
2014-05-20 09:12:48 +00:00
< td class = "description last" > < p > Either a single tile index, or an array of tile IDs to be checked for collision.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-05-20 09:12:48 +00:00
< td class = "name" > < code > collides< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-05-20 09:12:48 +00:00
< span class = "param-type" > boolean< / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-02-05 06:29:17 +00:00
< td class = "attributes" >
2014-05-20 09:12:48 +00:00
< optional>< br >
2014-02-05 06:29:17 +00:00
< / td >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< td class = "default" >
2014-05-20 09:12:48 +00:00
true
2014-02-08 07:24:22 +00:00
< / td >
2013-11-28 15:57:09 +00:00
2014-05-20 09:12:48 +00:00
< td class = "description last" > < p > If true it will enable collision. If false it will clear collision.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-05-20 09:12:48 +00:00
< td class = "name" > < code > layer< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-05-20 09:12:48 +00:00
< span class = "param-type" > number< / span >
|
2013-11-28 15:57:09 +00:00
2014-05-20 09:12:48 +00:00
< span class = "param-type" > string< / span >
|
2013-11-28 15:57:09 +00:00
2014-05-20 09:12:48 +00:00
< span class = "param-type" > < a href = "Phaser.TilemapLayer.html" > Phaser.TilemapLayer< / a > < / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > The layer to operate on. If not given will default to this.currentLayer.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > recalculate< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
true
< / td >
< td class = "description last" > < p > Recalculates the tile faces after the update.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-680" > line 680< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "setCollisionBetween" > < span class = "type-signature" > < / span > setCollisionBetween< span class = "signature" > (start, stop, < span class = "optional" > collides< / span > , < span class = "optional" > layer< / span > , < span class = "optional" > recalculate< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Sets collision on a range of tiles where the tile IDs increment sequentially.
Calling this with a start value of 10 and a stop value of 14 would set collision for tiles 10, 11, 12, 13 and 14.
The < code > collides< / code > parameter controls if collision will be enabled (true) or disabled (false).< / 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 > start< / 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 > The first index of the tile to be set for collision.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > stop< / 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 > The last index of the tile to be set for collision.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > collides< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< td class = "attributes" >
2014-02-08 07:24:22 +00:00
< optional>< br >
2014-02-05 06:29:17 +00:00
< / td >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< td class = "default" >
true
< / td >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > If true it will enable collision. If false it will clear collision.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
< td class = "name" > < code > layer< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
2014-02-05 06:29:17 +00:00
|
< span class = "param-type" > string< / span >
|
< span class = "param-type" > < a href = "Phaser.TilemapLayer.html" > Phaser.TilemapLayer< / a > < / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-02-05 06:29:17 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< td class = "default" >
< / td >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The layer to operate on. If not given will default to this.currentLayer.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
2014-05-20 09:12:48 +00:00
< tr >
< td class = "name" > < code > recalculate< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
true
< / td >
< td class = "description last" > < p > Recalculates the tile faces after the update.< / p > < / td >
< / tr >
2013-11-28 15:57:09 +00:00
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-05-20 09:12:48 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-718" > line 718< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-05-20 09:12:48 +00:00
< h4 class = "name" id = "setCollisionByExclusion" > < span class = "type-signature" > < / span > setCollisionByExclusion< span class = "signature" > (indexes, < span class = "optional" > collides< / span > , < span class = "optional" > layer< / span > , < span class = "optional" > recalculate< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< div class = "description" >
2014-02-08 07:24:22 +00:00
< p > Sets collision on all tiles in the given layer, except for the IDs of those in the given array.
The < code > collides< / code > parameter controls if collision will be enabled (true) or disabled (false).< / p >
2013-11-28 15:57:09 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
2014-02-08 07:24:22 +00:00
< th > Default< / th >
2013-11-28 15:57:09 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > indexes< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-02-08 07:24:22 +00:00
< span class = "param-type" > array< / span >
2013-11-28 15:57:09 +00:00
< / td >
< td class = "attributes" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "default" >
< / td >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > An array of the tile IDs to not be counted for collision.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > collides< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-02-08 07:24:22 +00:00
< span class = "param-type" > boolean< / span >
2013-11-28 15:57:09 +00:00
< / td >
< td class = "attributes" >
2014-02-08 07:24:22 +00:00
< optional>< br >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< / td >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< td class = "default" >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
true
2013-11-28 15:57:09 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > If true it will enable collision. If false it will clear collision.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
< td class = "name" > < code > layer< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
2014-02-05 06:29:17 +00:00
|
< span class = "param-type" > string< / span >
|
< span class = "param-type" > < a href = "Phaser.TilemapLayer.html" > Phaser.TilemapLayer< / a > < / span >
2013-11-28 15:57:09 +00:00
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "default" >
< / td >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The layer to operate on. If not given will default to this.currentLayer.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
2014-05-20 09:12:48 +00:00
< tr >
< td class = "name" > < code > recalculate< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
true
< / td >
< td class = "description last" > < p > Recalculates the tile faces after the update.< / p > < / td >
< / tr >
2013-11-28 15:57:09 +00:00
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-05-20 09:12:48 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-755" > line 755< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-08 07:24:22 +00:00
< h4 class = "name" id = "setCollisionByIndex" > < span class = "type-signature" > < protected> < / span > setCollisionByIndex< span class = "signature" > (index, < span class = "optional" > collides< / span > , < span class = "optional" > layer< / span > , < span class = "optional" > recalculate< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< div class = "description" >
2014-02-08 07:24:22 +00:00
< p > Sets collision values on a tile in the set.
You shouldn't usually call this method directly, instead use setCollision, setCollisionBetween or setCollisionByExclusion.< / p >
2013-11-28 15:57:09 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
2014-02-08 07:24:22 +00:00
< th > Default< / th >
2013-11-28 15:57:09 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > index< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "default" >
2013-11-28 15:57:09 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The index of the tile on the layer.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > collides< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-02-08 07:24:22 +00:00
< span class = "param-type" > boolean< / span >
2013-11-28 15:57:09 +00:00
< / td >
< td class = "attributes" >
2014-02-08 07:24:22 +00:00
< optional>< br >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< / td >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< td class = "default" >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
true
2013-11-28 15:57:09 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > If true it will enable collision on the tile. If false it will clear collision values from the tile.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > layer< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
2014-02-08 07:24:22 +00:00
< optional>< br >
2013-11-28 15:57:09 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "default" >
< / td >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The layer to operate on. If not given will default to this.currentLayer.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > recalculate< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-02-08 07:24:22 +00:00
< span class = "param-type" > boolean< / span >
2013-11-28 15:57:09 +00:00
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "default" >
true
< / td >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > Recalculates the tile faces after the update.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-05-20 09:12:48 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-789" > line 789< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-08 07:24:22 +00:00
< h4 class = "name" id = "setLayer" > < span class = "type-signature" > < / span > setLayer< span class = "signature" > (layer)< / span > < span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< div class = "description" >
2014-02-08 07:24:22 +00:00
< p > Sets the current layer to the given index.< / p >
2013-11-28 15:57:09 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > layer< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
2014-02-08 07:24:22 +00:00
|
< span class = "param-type" > string< / span >
|
< span class = "param-type" > < a href = "Phaser.TilemapLayer.html" > Phaser.TilemapLayer< / a > < / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The layer to set as current.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-07-10 19:31:11 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-1057" > line 1057< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "setPreventRecalculate" > < span class = "type-signature" > < / span > setPreventRecalculate< span class = "signature" > (if)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Turn off/on the recalculation of faces for tile or collission updates.
setPreventRecalculate(true) puts recalculation on hold while
setPreventRecalculate(false) recalculates all the changed layers.< / 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 > if< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > < p > true it will put the recalculation on hold.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-886" > line 886< / a >
2014-02-08 07:24:22 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "setTileIndexCallback" > < span class = "type-signature" > < / span > setTileIndexCallback< span class = "signature" > (indexes, callback, callbackContext, < span class = "optional" > layer< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Sets a global collision callback for the given tile index within the layer. This will affect all tiles on this layer that have the same index.
If a callback is already set for the tile index it will be replaced. Set the callback to null to remove it.
If you want to set a callback for a tile at a specific location on the map then see setTileLocationCallback.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< th > Type< / th >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< th > Argument< / th >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2013-11-28 15:57:09 +00:00
2014-02-08 07:24:22 +00:00
< tbody >
2013-11-28 15:57:09 +00:00
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > indexes< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
2014-02-08 07:24:22 +00:00
|
< span class = "param-type" > array< / span >
2013-11-28 15:57:09 +00:00
< / td >
< td class = "attributes" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > Either a single tile index, or an array of tile indexes to have a collision callback set for.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > callback< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-02-08 07:24:22 +00:00
< span class = "param-type" > function< / span >
2013-11-28 15:57:09 +00:00
< / td >
< td class = "attributes" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The callback that will be invoked when the tile is collided with.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > callbackContext< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-02-08 07:24:22 +00:00
< span class = "param-type" > object< / span >
2013-11-28 15:57:09 +00:00
< / td >
< td class = "attributes" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The context under which the callback is called.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
< td class = "name" > < code > layer< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
2014-02-05 06:29:17 +00:00
|
< span class = "param-type" > string< / span >
|
< span class = "param-type" > < a href = "Phaser.TilemapLayer.html" > Phaser.TilemapLayer< / a > < / span >
2013-11-28 15:57:09 +00:00
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The layer to operate on. If not given will default to this.currentLayer.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-05-20 09:12:48 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-617" > line 617< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-08 07:24:22 +00:00
< h4 class = "name" id = "setTileLocationCallback" > < span class = "type-signature" > < / span > setTileLocationCallback< span class = "signature" > (x, y, width, height, callback, callbackContext, < span class = "optional" > layer< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< div class = "description" >
2014-03-14 06:36:05 +00:00
< p > Sets a global collision callback for the given map location within the layer. This will affect all tiles on this layer found in the given area.
2014-02-08 07:24:22 +00:00
If a callback is already set for the tile index it will be replaced. Set the callback to null to remove it.
If you want to set a callback for a tile at a specific location on the map then see setTileLocationCallback.< / p >
2013-11-28 15:57:09 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > x< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > X position of the top left of the area to copy (given in tiles, not pixels)< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > y< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > Y position of the top left of the area to copy (given in tiles, not pixels)< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > width< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The width of the area to copy (given in tiles, not pixels)< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > height< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The height of the area to copy (given in tiles, not pixels)< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > callback< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-02-08 07:24:22 +00:00
< span class = "param-type" > function< / span >
2013-11-28 15:57:09 +00:00
< / td >
< td class = "attributes" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The callback that will be invoked when the tile is collided with.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-08 07:24:22 +00:00
< td class = "name" > < code > callbackContext< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-02-08 07:24:22 +00:00
< span class = "param-type" > object< / span >
2013-11-28 15:57:09 +00:00
< / td >
< td class = "attributes" >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The context under which the callback is called.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
< td class = "name" > < code > layer< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
2014-02-05 06:29:17 +00:00
|
< span class = "param-type" > string< / span >
|
< span class = "param-type" > < a href = "Phaser.TilemapLayer.html" > Phaser.TilemapLayer< / a > < / span >
2013-11-28 15:57:09 +00:00
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The layer to operate on. If not given will default to this.currentLayer.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-05-20 09:12:48 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-648" > line 648< / a >
2014-03-14 06:36:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "setTileSize" > < span class = "type-signature" > < / span > setTileSize< span class = "signature" > (tileWidth, tileHeight)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Sets the base tile size for the map.< / 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 > tileWidth< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The width of the tiles the map uses for calculations.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > tileHeight< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The height of the tiles the map uses for calculations.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-05-20 09:12:48 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-224" > line 224< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-05 06:29:17 +00:00
< h4 class = "name" id = "shuffle" > < span class = "type-signature" > < / span > shuffle< span class = "signature" > (x, y, width, height, < span class = "optional" > layer< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< div class = "description" >
< p > Shuffles a set of tiles in a given area. It will only randomise the tiles in that area, so if they're all the same nothing will appear to have changed!< / 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 > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > X position of the top left of the area to operate one, given in tiles, not pixels.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > Y position of the top left of the area to operate one, given in tiles, not pixels.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > width< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The width in tiles of the area to operate on.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > height< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The height in tiles of the area to operate on.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > layer< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
2014-02-05 06:29:17 +00:00
|
< span class = "param-type" > string< / span >
|
< span class = "param-type" > < a href = "Phaser.TilemapLayer.html" > Phaser.TilemapLayer< / a > < / span >
2013-11-28 15:57:09 +00:00
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > The layer to operate on.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-07-10 19:31:11 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-1630" > line 1630< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-03-14 06:36:05 +00:00
< h4 class = "name" id = "swap" > < span class = "type-signature" > < / span > swap< span class = "signature" > (tileA, tileB, x, y, width, height, < span class = "optional" > layer< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< div class = "description" >
2014-02-05 06:29:17 +00:00
< p > Scans the given area for tiles with an index matching tileA and swaps them with tileB.< / p >
2013-11-28 15:57:09 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-02-05 06:29:17 +00:00
< th > Argument< / th >
2013-11-28 15:57:09 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > tileA< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "attributes" >
< / td >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > First tile index.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > tileB< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "attributes" >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< / td >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > Second tile index.< / p > < / td >
< / tr >
2013-11-28 15:57:09 +00:00
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > x< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "attributes" >
< / td >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > X position of the top left of the area to operate one, given in tiles, not pixels.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > y< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "attributes" >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< / td >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > Y position of the top left of the area to operate one, given in tiles, not pixels.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > width< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "attributes" >
< / td >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > The width in tiles of the area to operate on.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > height< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "attributes" >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< / td >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > The height in tiles of the area to operate on.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > layer< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
2014-02-05 06:29:17 +00:00
|
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< span class = "param-type" > string< / span >
|
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< span class = "param-type" > < a href = "Phaser.TilemapLayer.html" > Phaser.TilemapLayer< / a > < / span >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< / td >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< td class = "attributes" >
< optional>< br >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< / td >
2013-11-28 15:57:09 +00:00
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > The layer to operate on.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-07-10 19:31:11 +00:00
< a href = "Tilemap.js.html" > tilemap/Tilemap.js< / a > , < a href = "Tilemap.js.html#sunlight-1-line-1468" > line 1468< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< / dl >
< / article >
< / section >
< / div >
< div class = "clearfix" > < / div >
< footer >
< span class = "copyright" >
2014-02-05 06:29:17 +00:00
Phaser Copyright © 2012-2014 Photon Storm Ltd.
2013-11-28 15:57:09 +00:00
< / span >
< br / >
< span class = "jsdoc-message" >
2014-04-11 12:09:28 +00:00
Documentation generated by < a href = "https://github.com/jsdoc3/jsdoc" > JSDoc 3.3.0-dev< / a >
2014-07-10 19:31:11 +00:00
on Thu Jul 10 2014 20:19:15 GMT+0100 (BST) using the < a href = "https://github.com/terryweiss/docstrap" > DocStrap template< / a > .
2013-11-28 15:57:09 +00:00
< / span >
< / footer >
< / div >
< div class = "span3" >
< div id = "toc" > < / div >
< / div >
< br clear = "both" >
< / div >
< / div >
< script src = "scripts/sunlight.js" > < / script >
< script src = "scripts/sunlight.javascript.js" > < / script >
< script src = "scripts/sunlight-plugin.doclinks.js" > < / script >
< script src = "scripts/sunlight-plugin.linenumbers.js" > < / script >
< script src = "scripts/sunlight-plugin.menu.js" > < / script >
< script src = "scripts/jquery.min.js" > < / script >
< script src = "scripts/jquery.scrollTo.js" > < / script >
< script src = "scripts/jquery.localScroll.js" > < / script >
< script src = "scripts/bootstrap-dropdown.js" > < / script >
< script src = "scripts/toc.js" > < / script >
< script > Sunlight . highlightAll ( { lineNumbers : true , showMenu : true , enableDoclinks : true } ) ; < / script >
< script >
$( function () {
$( "#toc" ).toc( {
2014-04-10 22:13:43 +00:00
anchorName : function(i, heading, prefix) {
2014-03-14 06:36:05 +00:00
return $(heading).attr("id") || ( prefix + i );
},
2013-11-28 15:57:09 +00:00
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
< / script >
< / body >
< / html >
