2013-10-25 15:54:40 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
2013-11-28 15:57:09 +00:00
< title > Phaser Class: TilemapLayer< / title >
2013-10-25 15:54:40 +00:00
<!-- [if lt IE 9]>
< script src = "//html5shiv.googlecode.com/svn/trunk/html5.js" > < / script >
<![endif]-->
2014-11-15 20:01:46 +00:00
< link type = "text/css" rel = "stylesheet" href = "styles/default.css" >
2013-10-25 15:54:40 +00:00
< link type = "text/css" rel = "stylesheet" href = "styles/sunlight.default.css" >
< link type = "text/css" rel = "stylesheet" href = "styles/site.cerulean.css" >
< / head >
< body >
2014-11-25 00:23:44 +00:00
2013-10-25 15:54:40 +00:00
< div class = "container-fluid" >
< div class = "navbar navbar-fixed-top navbar-inverse" >
2014-11-25 00:23:44 +00:00
< div style = "position: absolute; width: 143px; height: 31px; right: 10px; top: 10px; z-index: 1050" > < a href = "http://phaser.io" > < img src = "img/phaser.png" border = "0" / > < / a > < / div >
2013-10-25 15:54:40 +00:00
< div class = "navbar-inner" >
2014-11-25 00:23:44 +00:00
< a class = "brand" href = "index.html" > Phaser API< / a >
2013-10-25 15:54:40 +00:00
< ul class = "nav" >
2014-11-25 00:23:44 +00:00
2013-10-25 15:54:40 +00:00
< 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-10-25 15:54:40 +00:00
< a href = "Phaser.html" > Phaser< / a >
< / li >
2014-11-15 20:01:46 +00:00
< li class = "class-depth-0" >
< a href = "PIXI.html" > PIXI< / a >
< / li >
2013-10-25 15:54:40 +00:00
< / ul >
< / li >
< li class = "dropdown" >
< a href = "classes.list.html" class = "dropdown-toggle" data-toggle = "dropdown" > Classes< b
class="caret">< / b > < / a >
< ul class = "dropdown-menu " >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Animation.html" > Animation< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.AnimationManager.html" > AnimationManager< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.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-11-25 00:23:44 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.ArraySet.html" > ArraySet< / a >
< / li >
2014-11-15 20:01:46 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.ArrayUtils.html" > ArrayUtils< / a >
< / li >
2014-10-09 15:12:53 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.AudioSprite.html" > AudioSprite< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.BitmapData.html" > BitmapData< / a >
2013-10-25 15:54:40 +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.BitmapText.html" > BitmapText< / a >
2013-10-25 15:54:40 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Button.html" > Button< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Cache.html" > Cache< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Camera.html" > Camera< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Canvas.html" > Canvas< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Circle.html" > Circle< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Color.html" > Color< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Device.html" > Device< / a >
< / li >
2014-11-15 20:01:46 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.DOM.html" > DOM< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Easing.html" > Easing< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-18 03:01:51 +00:00
< a href = "Phaser.Ellipse.html" > Ellipse< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Events.html" > Events< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Filter.html" > Filter< / a >
< / li >
2014-09-09 14:36:56 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.FlexGrid.html" > FlexGrid< / a >
< / li >
< li class = "class-depth-1" >
< a href = "Phaser.FlexLayer.html" > FlexLayer< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Frame.html" > Frame< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.FrameData.html" > FrameData< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Game.html" > Game< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-21 15:37:26 +00:00
< a href = "Phaser.GameObjectCreator.html" > GameObjectCreator< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.GameObjectFactory.html" > GameObjectFactory< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-05 06:29:17 +00:00
< a href = "Phaser.Gamepad.html" > Gamepad< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-05 06:29:17 +00:00
< a href = "Phaser.GamepadButton.html" > GamepadButton< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Graphics.html" > Graphics< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Group.html" > Group< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-08 07:24:22 +00:00
< a href = "Phaser.Image.html" > Image< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Input.html" > Input< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.InputHandler.html" > InputHandler< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Key.html" > Key< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Keyboard.html" > Keyboard< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-05 06:29:17 +00:00
< a href = "Phaser.Line.html" > Line< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.LinkedList.html" > LinkedList< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Loader.html" > Loader< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.LoaderParser.html" > LoaderParser< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Math.html" > Math< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Mouse.html" > Mouse< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.MSPointer.html" > MSPointer< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Net.html" > Net< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.Particle.html" > Particle< / a >
< / li >
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Particles.html" > Particles< / a >
< / li >
2014-10-09 15:12:53 +00:00
< li class = "class-depth-2" >
< a href = "Phaser.Particles.Arcade.html" > Arcade< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Particles.Arcade.Emitter.html" > Emitter< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Physics.html" > Physics< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Physics.Arcade.html" > Arcade< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Arcade.Body.html" > Body< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Ninja.html" > Ninja< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Ninja.AABB.html" > AABB< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Ninja.Body.html" > Body< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Ninja.Circle.html" > Circle< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Ninja.Tile.html" > Tile< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.html" > P2< / a >
< / 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 >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.ContactMaterial.html" > ContactMaterial< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.DistanceConstraint.html" > DistanceConstraint< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-11 12:09:28 +00:00
< li class = "class-depth-3" >
< a href = "Phaser.Physics.P2.FixtureList.html" > FixtureList< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.GearConstraint.html" > GearConstraint< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.InversePointProxy.html" > InversePointProxy< / a >
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 >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.PrismaticConstraint.html" > PrismaticConstraint< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.RevoluteConstraint.html" > RevoluteConstraint< / a >
< / li >
2014-09-09 14:36:56 +00:00
< li class = "class-depth-3" >
< a href = "Phaser.Physics.P2.RotationalSpring.html" > RotationalSpring< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.Spring.html" > Spring< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Plugin.html" > Plugin< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.PluginManager.html" > PluginManager< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Point.html" > Point< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +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-10-25 15:54:40 +00:00
< a href = "Phaser.RandomDataGenerator.html" > RandomDataGenerator< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Rectangle.html" > Rectangle< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.RenderTexture.html" > RenderTexture< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.RequestAnimationFrame.html" > RequestAnimationFrame< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.RetroFont.html" > RetroFont< / a >
< / li >
2014-09-09 14:36:56 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.Rope.html" > Rope< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.ScaleManager.html" > ScaleManager< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Signal.html" > Signal< / a >
< / li >
2014-04-11 12:09:28 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.SignalBinding.html" > SignalBinding< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-05 06:29:17 +00:00
< a href = "Phaser.SinglePad.html" > SinglePad< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Sound.html" > Sound< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.SoundManager.html" > SoundManager< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Sprite.html" > Sprite< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-18 03:01:51 +00:00
< a href = "Phaser.SpriteBatch.html" > SpriteBatch< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Stage.html" > Stage< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.State.html" > State< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.StateManager.html" > StateManager< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Text.html" > Text< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Tile.html" > Tile< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Tilemap.html" > Tilemap< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.TilemapLayer.html" > TilemapLayer< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.TilemapParser.html" > TilemapParser< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Tileset.html" > Tileset< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.TileSprite.html" > TileSprite< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Time.html" > Time< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Timer.html" > Timer< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-05 06:29:17 +00:00
< a href = "Phaser.TimerEvent.html" > TimerEvent< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Touch.html" > Touch< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Tween.html" > Tween< / a >
< / li >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.TweenData.html" > TweenData< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.TweenManager.html" > TweenManager< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Utils.html" > Utils< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Utils.Debug.html" > Debug< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.World.html" > World< / a >
< / li >
2014-11-15 20:01:46 +00:00
< li class = "class-depth-1" >
< a href = "PIXI.AbstractFilter.html" > AbstractFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.AjaxRequest.html" > AjaxRequest< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.AlphaMaskFilter.html" > AlphaMaskFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.AsciiFilter.html" > AsciiFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.AssetLoader.html" > AssetLoader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.AtlasLoader.html" > AtlasLoader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.BaseTexture.html" > BaseTexture< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.BitmapFontLoader.html" > BitmapFontLoader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.BitmapText.html" > BitmapText< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.BlurFilter.html" > BlurFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.BlurXFilter.html" > BlurXFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.BlurYFilter.html" > BlurYFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.CanvasBuffer.html" > CanvasBuffer< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.CanvasGraphics.html" > CanvasGraphics< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.CanvasMaskManager.html" > CanvasMaskManager< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.CanvasRenderer.html" > CanvasRenderer< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.CanvasTinter.html" > CanvasTinter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Circle.html" > Circle< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.ColorMatrixFilter.html" > ColorMatrixFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.ColorStepFilter.html" > ColorStepFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.ComplexPrimitiveShader.html" > ComplexPrimitiveShader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.ConvolutionFilter.html" > ConvolutionFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.CrossHatchFilter.html" > CrossHatchFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.DisplacementFilter.html" > DisplacementFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.DisplayObject.html" > DisplayObject< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.DisplayObjectContainer.html" > DisplayObjectContainer< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.DotScreenFilter.html" > DotScreenFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Ellipse.html" > Ellipse< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Event.html" > Event< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.EventTarget.html" > EventTarget< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.FilterBlock.html" > FilterBlock< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.FilterTexture.html" > FilterTexture< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Graphics.html" > Graphics< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.GraphicsData.html" > GraphicsData< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.GrayFilter.html" > GrayFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.ImageLoader.html" > ImageLoader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.InteractionData.html" > InteractionData< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.InteractionManager.html" > InteractionManager< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.InvertFilter.html" > InvertFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.JsonLoader.html" > JsonLoader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Matrix.html" > Matrix< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.MovieClip.html" > MovieClip< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.NoiseFilter.html" > NoiseFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.NormalMapFilter.html" > NormalMapFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.PixelateFilter.html" > PixelateFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.PIXI.html" > PIXI< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.PixiFastShader.html" > PixiFastShader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.PixiShader.html" > PixiShader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Point.html" > Point< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Polygon.html" > Polygon< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.PolyK.html" > PolyK< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.PrimitiveShader.html" > PrimitiveShader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Rectangle.html" > Rectangle< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.RenderTexture.html" > RenderTexture< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.RGBSplitFilter.html" > RGBSplitFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Rope.html" > Rope< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.RoundedRectangle.html" > RoundedRectangle< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.SepiaFilter.html" > SepiaFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.SmartBlurFilter.html" > SmartBlurFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Spine.html" > Spine< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.SpineLoader.html" > SpineLoader< / a >
< / li >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" >
< a href = "PIXI.SpineTextureLoader.html" > SpineTextureLoader< / a >
< / li >
2014-11-15 20:01:46 +00:00
< li class = "class-depth-1" >
< a href = "PIXI.Sprite.html" > Sprite< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.SpriteBatch.html" > SpriteBatch< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.SpriteSheetLoader.html" > SpriteSheetLoader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Stage.html" > Stage< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Strip.html" > Strip< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.StripShader.html" > StripShader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Text.html" > Text< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Texture.html" > Texture< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.TilingSprite.html" > TilingSprite< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.TiltShiftFilter.html" > TiltShiftFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.TiltShiftXFilter.html" > TiltShiftXFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.TiltShiftYFilter.html" > TiltShiftYFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.TwistFilter.html" > TwistFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.VideoTexture.html" > VideoTexture< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.WebGLBlendModeManager.html" > WebGLBlendModeManager< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.WebGLFastSpriteBatch.html" > WebGLFastSpriteBatch< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.WebGLFilterManager.html" > WebGLFilterManager< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.WebGLRenderer.html" > WebGLRenderer< / a >
< / li >
2013-10-25 15:54:40 +00:00
< / ul >
< / li >
2014-11-25 00:23:44 +00:00
2014-11-15 20:01:46 +00:00
< li class = "dropdown" >
2014-11-25 00:23:44 +00:00
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Core< b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu " >
2014-12-03 10:39:11 +00:00
< li class = "class-depth-1" > < a href = "Phaser.Game.html" > Game< / a > < / li >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" > < a href = "Phaser.Group.html" > Group< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.World.html" > World< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Loader.html" > Loader< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Time.html" > Time< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Camera.html" > Camera< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.StateManager.html" > State Manager< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.TweenManager.html" > Tween Manager< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.SoundManager.html" > Sound Manager< / a > < / li >
2015-01-06 06:57:25 +00:00
< li class = "class-depth-1" > < a href = "Phaser.Input.html" > Input Manager< / a > < / li >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" > < a href = "Phaser.ScaleManager.html" > Scale Manager< / a > < / li >
< / ul >
< / li >
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Game Objects< b class = "caret" > < / b > < / a >
2014-11-15 20:01:46 +00:00
< ul class = "dropdown-menu " >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" > < a href = "Phaser.GameObjectFactory.html" > Factory (game.add)< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.GameObjectCreator.html" > Creator (game.make)< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Sprite.html" > Sprite< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Image.html" > Image< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Sound.html" > Sound< / a > < / li >
2015-01-06 06:57:25 +00:00
< li class = "class-depth-1" > < a href = "Phaser.Particles.Arcade.Emitter.html" > Particle Emitter< / a > < / li >
2014-12-03 10:39:11 +00:00
< li class = "class-depth-1" > < a href = "Phaser.Particle.html" > Particle< / a > < / li >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" > < a href = "Phaser.Text.html" > Text< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Tween.html" > Tween< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.BitmapText.html" > BitmapText< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Tilemap.html" > Tilemap< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.BitmapData.html" > BitmapData< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.RetroFont.html" > RetroFont< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Button.html" > Button< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Animation.html" > Animation< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Graphics.html" > Graphics< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.RenderTexture.html" > RenderTexture< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.TileSprite.html" > TileSprite< / a > < / li >
< / ul >
< / li >
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Geometry< b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu " >
< li class = "class-depth-1" > < a href = "Phaser.Circle.html" > Circle< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Rectangle.html" > Rectangle< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Point.html" > Point< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Line.html" > Line< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Ellipse.html" > Ellipse< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Polygon.html" > Polygon< / a > < / li >
< / ul >
< / li >
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Physics< b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu " >
< li class = "class-depth-1" > < a href = "Phaser.Physics.Arcade.html" > Arcade Physics< / a > < / li >
< li class = "class-depth-2" > < a href = "Phaser.Physics.Arcade.Body.html" > Body< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Physics.P2.html" > P2 Physics< / a > < / li >
< li class = "class-depth-2" > < a href = "Phaser.Physics.P2.Body.html" > Body< / a > < / li >
< li class = "class-depth-2" > < a href = "Phaser.Physics.P2.Spring.html" > Spring< / a > < / li >
< li class = "class-depth-2" > < a href = "Phaser.Physics.P2.CollisionGroup.html" > CollisionGroup< / a > < / li >
< li class = "class-depth-2" > < a href = "Phaser.Physics.P2.ContactMaterial.html" > ContactMaterial< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Physics.Ninja.html" > Ninja Physics< / a > < / li >
< li class = "class-depth-2" > < a href = "Phaser.Physics.Body.html" > Body< / a > < / li >
2014-11-15 20:01:46 +00:00
< / ul >
< / li >
2014-11-25 00:23:44 +00:00
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Input< b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu " >
< li class = "class-depth-1" > < a href = "Phaser.InputHandler.html" > Input Handler< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Pointer.html" > Pointer< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Mouse.html" > Mouse< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Keyboard.html" > Keyboard< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Key.html" > Key< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Gamepad.html" > Gamepad< / a > < / li >
< / ul >
< / li >
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Community< b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu " >
2015-01-06 06:57:25 +00:00
< li class = "class-depth-1" > < a href = "https://leanpub.com/u/photonstorm" > Phaser Books< / a > < / li >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" > < a href = "https://github.com/photonstorm/phaser" > Phaser Github< / a > < / li >
< li class = "class-depth-1" > < a href = "http://examples.phaser.io" > Phaser Examples< / a > < / li >
< li class = "class-depth-1" > < a href = "https://github.com/photonstorm/phaser-plugins" > Phaser Plugins< / a > < / li >
< li class = "class-depth-1" > < a href = "http://www.html5gamedevs.com/forum/14-phaser/" > Forum< / a > < / li >
< li class = "class-depth-1" > < a href = "http://stackoverflow.com/questions/tagged/phaser-framework" > Stack Overflow< / a > < / li >
< li class = "class-depth-1" > < a href = "https://confirmsubscription.com/h/r/369DE48E3E86AF1E" > Newsletter< / a > < / li >
< li class = "class-depth-1" > < a href = "https://twitter.com/photonstorm" > Twitter< / a > < / li >
< li class = "class-depth-1" > < a href = "http://www.html5gamedevs.com/topic/4470-official-phaserio-irc-channel-phaserio-on-freenode/" > IRC< / a > < / li >
< li class = "class-depth-1" > < a href = "https://www.gittip.com/photonstorm/" > GitTip< / a > < / li >
< / ul >
< / li >
2014-11-15 20:01:46 +00:00
< / ul >
< / div >
< / div >
< div class = "row-fluid" >
2013-10-25 15:54:40 +00:00
< div class = "span8" >
< div id = "main" >
2014-11-25 00:23:44 +00:00
<!-- <h1 class="page - title">Class: TilemapLayer</h1> -->
2013-10-25 15:54:40 +00:00
< section >
< header >
< h2 >
< span class = "ancestors" > < a href = "Phaser.html" > Phaser< / a > .< / span >
2013-11-28 15:57:09 +00:00
TilemapLayer
2013-10-25 15:54:40 +00:00
< / h2 >
< / header >
< article >
< div class = "container-overview" >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="TilemapLayer">< span class = "type-signature" > < / span > new TilemapLayer< span class = "signature" > (game, tilemap, index, width, height)< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > A TilemapLayer is a Phaser.Image/Sprite that renders a specific TileLayer of a Tilemap.< / p >
2015-01-06 06:57:25 +00:00
< p > Since a TilemapLayer is a Sprite it can be moved around the display, added to other groups or display objects, etc.< / p >
< p > By default TilemapLayers have fixedToCamera set to < code > true< / code > . Changing this will break Camera follow and scrolling behaviour.< / p >
2013-10-25 15:54:40 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > game< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Game.html" > Phaser.Game< / a > < / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > Game reference to the currently running game.< / p > < / td >
2013-10-25 15:54:40 +00:00
< / tr >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > tilemap< / code > < / td >
2013-10-25 15:54:40 +00:00
< td class = "type" >
2014-02-05 06:29:17 +00:00
< span class = "param-type" > < a href = "Phaser.Tilemap.html" > Phaser.Tilemap< / a > < / span >
2013-10-25 15:54:40 +00:00
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > The tilemap to which this layer belongs.< / p > < / td >
2013-10-25 15:54:40 +00:00
< / tr >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > index< / code > < / td >
2013-10-25 15:54:40 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > integer< / span >
2013-10-25 15:54:40 +00:00
2013-11-28 15:57:09 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The index of the TileLayer to render within the Tilemap.< / 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" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > integer< / span >
2013-10-25 15:54:40 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > Width of the renderable area of the layer (in 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 > height< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > integer< / span >
2013-10-25 15:54:40 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > Height of the renderable area of the layer (in pixels).< / p > < / td >
2013-10-25 15:54:40 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-01-06 06:57:25 +00:00
< a href = "TilemapLayer.js.html" > tilemap/TilemapLayer.js< / a > , < a href = "TilemapLayer.js.html#sunlight-1-line-23" > line 23< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-25 15:54:40 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
< / dd >
< / div >
2014-11-15 20:01:46 +00:00
< h3 class = "subsection-title" > Extends< / h3 >
< ul >
< li > < a href = "Phaser.Image.html" > Phaser.Image< / a > < / li >
< / ul >
2013-10-25 15:54:40 +00:00
< h3 class = "subsection-title" > Members< / h3 >
< dl >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="alive">< span class = "type-signature" > < / span > alive< span class = "type-signature" > :boolean< / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > A useful boolean to control if the Image is alive or dead (in terms of your gameplay, it doesn't effect rendering).< / p >
< / div >
2013-10-25 15:54:40 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Image.html#alive" > Phaser.Image#alive< / a >
< / li > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > true< / li > < / ul > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-86" > line 86< / a >
< / dt >
2013-10-25 15:54:40 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="alpha">< span class = "type-signature" > < / span > alpha< span class = "type-signature" > :Number< / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The opacity of the object.< / p >
< / div >
2013-10-25 15:54:40 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#alpha" > PIXI.DisplayObject#alpha< / a >
< / li > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-65" > line 65< / a >
< / dt >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="anchor">< span class = "type-signature" > < / span > anchor< span class = "type-signature" > :< a href = "PIXI.Point.html" > PIXI.Point< / a > < / span > < / h4 >
< / dt >
< dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The anchor sets the origin point of the texture.
The default is 0,0 this means the texture's origin is the top left
Setting than anchor to 0.5,0.5 means the textures origin is centered
Setting the anchor to 1,1 would mean the textures origin points will be the bottom right corner< / p >
< / div >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.Sprite.html#anchor" > PIXI.Sprite#anchor< / a >
< / li > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sprite.js.html" > pixi/display/Sprite.js< / a > , < a href = "Sprite.js.html#sunlight-1-line-22" > line 22< / a >
< / dt >
2013-10-25 15:54:40 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="angle">< span class = "type-signature" > < / span > angle< span class = "type-signature" > :number< / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Indicates the rotation of the Image, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.
Values outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement player.angle = 450 is the same as player.angle = 90.
If you wish to work in radians instead of degrees use the property Image.rotation instead. Working in radians is also a little faster as it doesn't have to convert the angle. The angle of this Image in degrees.< / p >
< / div >
2013-10-25 15:54:40 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Image.html#angle" > Phaser.Image#angle< / a >
< / li > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-741" > line 741< / a >
< / dt >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="animations">< span class = "type-signature" > < / span > animations< span class = "type-signature" > :< a href = "Phaser.AnimationManager.html" > Phaser.AnimationManager< / a > < / span > < / h4 >
< / dt >
< dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > This manages animations of the sprite. You can modify animations through it (see Phaser.AnimationManager)< / p >
< / div >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Image.html#animations" > Phaser.Image#animations< / a >
< / li > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-63" > line 63< / a >
< / dt >
2013-10-25 15:54:40 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="autoCull">< span class = "type-signature" > < / span > autoCull< span class = "type-signature" > :boolean< / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Should this Image be automatically culled if out of range of the camera?
A culled sprite has its renderable property set to 'false'.
Be advised this is quite an expensive operation, as it has to calculate the bounds of the object every frame, so only enable it if you really need it. A flag indicating if the Image should be automatically camera culled or not.< / p >
< / div >
2013-10-25 15:54:40 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Image.html#autoCull" > Phaser.Image#autoCull< / a >
< / li > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > false< / li > < / ul > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-96" > line 96< / a >
< / dt >
2013-10-25 15:54:40 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="baseTexture">< span class = "type-signature" > < internal> < / span > baseTexture< span class = "type-signature" > :< a href = "PIXI.BaseTexture.html" > PIXI.BaseTexture< / a > < / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Required Pixi var.< / p >
< / div >
2013-10-25 15:54:40 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "important tag-deprecated" > Internal:< / dt >
< dd class = "tag-deprecated" > < ul >
< li > This member is < em > internal (protected)< / em > and may be modified or removed in the future.< / li >
< / ul > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-01-06 06:57:25 +00:00
< a href = "TilemapLayer.js.html" > tilemap/TilemapLayer.js< / a > , < a href = "TilemapLayer.js.html#sunlight-1-line-79" > line 79< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-25 15:54:40 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="blendMode">< span class = "type-signature" > < / span > blendMode< span class = "type-signature" > :Number< / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The blend mode to be applied to the sprite. Set to PIXI.blendModes.NORMAL to remove any blend mode.< / p >
< / div >
2013-10-25 15:54:40 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.Sprite.html#blendMode" > PIXI.Sprite#blendMode< / a >
< / li > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > PIXI.blendModes.NORMAL;< / li > < / ul > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Sprite.js.html" > pixi/display/Sprite.js< / a > , < a href = "Sprite.js.html#sunlight-1-line-68" > line 68< / a >
< / dt >
2013-10-25 15:54:40 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="buttonMode">< span class = "type-signature" > < / span > buttonMode< span class = "type-signature" > :Boolean< / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > This is used to indicate if the displayObject should display a mouse hand cursor on rollover< / p >
< / div >
2013-10-25 15:54:40 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#buttonMode" > PIXI.DisplayObject#buttonMode< / a >
< / li > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-90" > line 90< / a >
< / dt >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="cacheAsBitmap">< span class = "type-signature" > < / span > cacheAsBitmap< span class = "type-signature" > :Boolean< / span > < / h4 >
< / dt >
< dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Set if this display object is cached as a bitmap.
This basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.
To remove simply set this property to 'null'< / p >
< / div >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#cacheAsBitmap" > PIXI.DisplayObject#cacheAsBitmap< / a >
< / li > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-436" > line 436< / a >
< / dt >
2013-10-25 15:54:40 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="cameraOffset">< span class = "type-signature" > < / span > cameraOffset< span class = "type-signature" > :< a href = "Phaser.Point.html" > Phaser.Point< / a > < / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > If this object is fixed to the camera then use this Point to specify how far away from the Camera x/y it's rendered.< / p >
< / div >
2013-10-25 15:54:40 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-01-06 06:57:25 +00:00
< a href = "TilemapLayer.js.html" > tilemap/TilemapLayer.js< / a > , < a href = "TilemapLayer.js.html#sunlight-1-line-123" > line 123< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="canvas">< span class = "type-signature" > < internal> < / span > canvas< span class = "type-signature" > :HTMLCanvasElement< / span > < / h4 >
< / dt >
< dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The canvas to which this TilemapLayer draws.< / p >
< / div >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "important tag-deprecated" > Internal:< / dt >
< dd class = "tag-deprecated" > < ul >
< li > This member is < em > internal (protected)< / em > and may be modified or removed in the future.< / li >
< / ul > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-01-06 06:57:25 +00:00
< a href = "TilemapLayer.js.html" > tilemap/TilemapLayer.js< / a > , < a href = "TilemapLayer.js.html#sunlight-1-line-65" > line 65< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-25 15:54:40 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="children">< span class = "type-signature" > < readonly> < / span > children< span class = "type-signature" > :Array.< < a href = "global.html#DisplayObject" > DisplayObject< / a > >< / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > [read-only] The array of children of this container.< / p >
< / div >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< h5 > Type:< / h5 >
< ul >
< li >
2013-10-25 15:54:40 +00:00
2014-12-03 10:39:11 +00:00
< span class = "param-type" > Array.< < a href = "global.html#DisplayObject" > DisplayObject< / a > >< / span >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< / li >
< / ul >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObjectContainer.html#children" > PIXI.DisplayObjectContainer#children< / a >
< / li > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "DisplayObjectContainer.js.html#sunlight-1-line-17" > line 17< / a >
< / dt >
2013-10-25 15:54:40 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="cropRect">< span class = "type-signature" > < / span > cropRect< span class = "type-signature" > :< a href = "Phaser.Rectangle.html" > Phaser.Rectangle< / a > < / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The Rectangle used to crop the texture. Set this via Sprite.crop. Any time you modify this property directly you must call Sprite.updateCrop.< / p >
< / div >
2013-10-25 15:54:40 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Image.html#cropRect" > Phaser.Image#cropRect< / a >
< / li > < / dd >
2013-10-25 15:54:40 +00:00
2014-02-05 06:29:17 +00:00
< dt class = "tag-default" > Default Value:< / dt >
2014-11-15 20:01:46 +00:00
< dd class = "tag-default" > < ul class = "dummy" > < li > null< / li > < / ul > < / dd >
2014-02-05 06:29:17 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-118" > line 118< / a >
< / dt >
2013-10-25 15:54:40 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="debug">< span class = "type-signature" > < / span > debug< span class = "type-signature" > :boolean< / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Enable an additional " debug rendering" pass to display collision information.< / p >
< / div >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-25 15:54:40 +00:00
2014-02-05 06:29:17 +00:00
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > false< / li > < / ul > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-01-06 06:57:25 +00:00
< a href = "TilemapLayer.js.html" > tilemap/TilemapLayer.js< / a > , < a href = "TilemapLayer.js.html#sunlight-1-line-154" > line 154< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-25 15:54:40 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="debugSettings">< span class = "type-signature" > < / span > debugSettings< span class = "type-signature" > < / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Settings used for debugging and diagnostics.< / p >
< / div >
2013-10-25 15:54:40 +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 >
2014-11-15 20:01:46 +00:00
< th > Argument< / th >
2013-10-25 15:54:40 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > missingImageFill< / code > < / td >
2013-10-25 15:54:40 +00:00
< td class = "type" >
2014-02-05 06:29:17 +00:00
< span class = "param-type" > string< / span >
2013-10-25 15:54:40 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "attributes" >
< nullable>< br >
< / td >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > A tile is rendered as a rectangle using the following fill if a valid tileset/image cannot be found. A value of < code > null< / code > prevents additional rendering for tiles without a valid tileset image. < em > This takes effect even when debug rendering for the layer is not enabled.< / em > < / p > < / td >
2013-10-25 15:54:40 +00:00
< / tr >
2014-11-15 20:01:46 +00:00
< tr >
< td class = "name" > < code > debuggedTileOverfill< / code > < / td >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< td class = "type" >
< span class = "param-type" > string< / span >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< / td >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< td class = "attributes" >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< nullable>< br >
< / td >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > If a Tile has < code > Tile#debug< / code > true then, after normal tile image rendering, a rectangle with the following fill is drawn above/over it. < em > This takes effect even when debug rendering for the layer is not enabled.< / em > < / p > < / td >
< / tr >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< tr >
< td class = "name" > < code > forceFullRedraw< / code > < / td >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< td class = "type" >
< span class = "param-type" > boolean< / span >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< / td >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< td class = "attributes" >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< / td >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > When debug rendering (< code > debug< / code > is true), and this option is enabled, the a full redraw is forced and rendering optimization is suppressed.< / p > < / td >
< / tr >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< tr >
< td class = "name" > < code > debugAlpha< / code > < / td >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< / td >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< td class = "attributes" >
< / td >
< td class = "description last" > < p > When debug rendering (< code > debug< / code > is true), the tileset is initially rendered with this alpha level. This can make the tile edges clearer.< / p > < / td >
< / tr >
2013-10-25 15:54:40 +00:00
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > facingEdgeStroke< / code > < / td >
2013-10-25 15:54:40 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< nullable>< br >
< / td >
< td class = "description last" > < p > When debug rendering (< code > debug< / code > is true), this color/stroke is used to draw " face" edges. A value of < code > null< / code > disables coloring facing edges.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > collidingTileOverfill< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
2013-10-25 15:54:40 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "attributes" >
< nullable>< br >
< / td >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > When debug rendering (< code > debug< / code > is true), this fill is used for tiles that are collidable. A value of < code > null< / code > disables applying the additional overfill.< / p > < / td >
2013-10-25 15:54:40 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-01-06 06:57:25 +00:00
< a href = "TilemapLayer.js.html" > tilemap/TilemapLayer.js< / a > , < a href = "TilemapLayer.js.html#sunlight-1-line-172" > line 172< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-25 15:54:40 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="deltaX">< span class = "type-signature" > < readonly> < / span > deltaX< span class = "type-signature" > :number< / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Returns the delta x value. The difference between world.x now and in the previous step. The delta value. Positive if the motion was to the right, negative if to the left.< / p >
< / div >
2013-10-25 15:54:40 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Image.html#deltaX" > Phaser.Image#deltaX< / a >
< / li > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-765" > line 765< / a >
< / dt >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="deltaY">< span class = "type-signature" > < readonly> < / span > deltaY< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Returns the delta y value. The difference between world.y now and in the previous step. The delta value. Positive if the motion was downwards, negative if upwards.< / p >
< / div >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Image.html#deltaY" > Phaser.Image#deltaY< / a >
< / li > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-782" > line 782< / a >
< / dt >
2013-10-25 15:54:40 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="deltaZ">< span class = "type-signature" > < readonly> < / span > deltaZ< span class = "type-signature" > :number< / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Returns the delta z value. The difference between rotation now and in the previous step. The delta value.< / p >
< / div >
2013-10-25 15:54:40 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Image.html#deltaZ" > Phaser.Image#deltaZ< / a >
< / li > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-799" > line 799< / a >
< / dt >
2013-10-25 15:54:40 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="destroyPhase">< span class = "type-signature" > < / span > destroyPhase< span class = "type-signature" > :boolean< / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > True if this object is currently being destroyed.< / p >
< / div >
2013-10-25 15:54:40 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Image.html#destroyPhase" > Phaser.Image#destroyPhase< / a >
< / li > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-1028" > line 1028< / a >
< / dt >
2013-10-25 15:54:40 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="dirty">< span class = "type-signature" > < internal> < / span > dirty< span class = "type-signature" > :boolean< / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > If true tiles will be force rendered, even if such is not believed to be required.< / p >
< / div >
2013-10-25 15:54:40 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "important tag-deprecated" > Internal:< / dt >
< dd class = "tag-deprecated" > < ul >
< li > This member is < em > internal (protected)< / em > and may be modified or removed in the future.< / li >
< / ul > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-01-06 06:57:25 +00:00
< a href = "TilemapLayer.js.html" > tilemap/TilemapLayer.js< / a > , < a href = "TilemapLayer.js.html#sunlight-1-line-206" > line 206< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="events">< span class = "type-signature" > < / span > events< span class = "type-signature" > :< a href = "Phaser.Events.html" > Phaser.Events< / a > < / span > < / h4 >
< / dt >
< dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The Events you can subscribe to that are dispatched when certain things happen on this Image or its components.< / p >
< / div >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Image.html#events" > Phaser.Image#events< / a >
< / li > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-58" > line 58< / a >
< / dt >
2013-10-25 15:54:40 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="exists">< span class = "type-signature" > < / span > exists< span class = "type-signature" > :boolean< / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > If exists = false then the Image isn't updated by the core game loop.< / p >
< / div >
2013-10-25 15:54:40 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Image.html#exists" > Phaser.Image#exists< / a >
< / li > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > true< / li > < / ul > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-36" > line 36< / a >
< / dt >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="filterArea">< span class = "type-signature" > < / span > filterArea< span class = "type-signature" > :< a href = "PIXI.Rectangle.html" > PIXI.Rectangle< / a > < / span > < / h4 >
< / dt >
< dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The area the filter is applied to like the hitArea this is used as more of an optimisation
rather than figuring out the dimensions of the displayObject each frame you can set this rectangle< / p >
< / div >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#filterArea" > PIXI.DisplayObject#filterArea< / a >
< / li > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-180" > line 180< / a >
< / dt >
2014-03-14 06:36:05 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="filters">< span class = "type-signature" > < / span > filters< span class = "type-signature" > :Array.< Filter>< / span > < / h4 >
2014-03-14 06:36:05 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Sets the filters for the displayObject.
IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.
To remove filters simply set this property to 'null'< / p >
< / div >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > Array.< Filter>< / span >
< / li >
< / ul >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#filters" > PIXI.DisplayObject#filters< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-400" > line 400< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="fixedToCamera">< span class = "type-signature" > < / span > fixedToCamera< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > An object that is fixed to the camera ignores the position of any ancestors in the display list and uses its x/y coordinates as offsets from the top left of the camera.< / p >
< / div >
2014-03-14 06:36:05 +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 >
< tbody >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > fixToCamera< / code > < / td >
2014-03-14 06:36:05 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > boolean< / span >
2014-03-14 06:36:05 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < / td >
2014-03-14 06:36:05 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
2014-11-15 20:01:46 +00:00
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > true< / li > < / ul > < / dd >
< dt class = "tag-source" > Source -
2015-01-06 06:57:25 +00:00
< a href = "TilemapLayer.js.html" > tilemap/TilemapLayer.js< / a > , < a href = "TilemapLayer.js.html#sunlight-1-line-117" > line 117< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="frame">< span class = "type-signature" > < / span > frame< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Gets or sets the current frame index and updates the Texture for display.< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Image.html#frame" > Phaser.Image#frame< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-850" > line 850< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="frameName">< span class = "type-signature" > < / span > frameName< span class = "type-signature" > :string< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Gets or sets the current frame by name and updates the Texture for display.< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Image.html#frameName" > Phaser.Image#frameName< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-879" > line 879< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="game">< span class = "type-signature" > < internal, readonly> < / span > game< span class = "type-signature" > :< a href = "Phaser.Game.html" > Phaser.Game< / a > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > A reference to the currently running Game.< / p >
< / div >
< dl class = "details" >
< dt class = "important tag-deprecated" > Internal:< / dt >
< dd class = "tag-deprecated" > < ul >
< li > This member is < em > internal (protected)< / em > and may be modified or removed in the future.< / li >
< / ul > < / dd >
< dt class = "tag-source" > Source -
2015-01-06 06:57:25 +00:00
< a href = "TilemapLayer.js.html" > tilemap/TilemapLayer.js< / a > , < a href = "TilemapLayer.js.html#sunlight-1-line-34" > line 34< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="height">< span class = "type-signature" > < / span > height< span class = "type-signature" > :Number< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The height of the sprite, setting this will actually modify the scale to achieve the value set< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.Sprite.html#height" > PIXI.Sprite#height< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "Sprite.js.html" > pixi/display/Sprite.js< / a > , < a href = "Sprite.js.html#sunlight-1-line-119" > line 119< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="hitArea">< span class = "type-signature" > < / span > hitArea< span class = "type-signature" > :< a href = "PIXI.Rectangle.html" > PIXI.Rectangle< / a > |< a href = "PIXI.Circle.html" > PIXI.Circle< / a > |< a href = "PIXI.Ellipse.html" > PIXI.Ellipse< / a > |< a href = "PIXI.Polygon.html" > PIXI.Polygon< / a > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > This is the defined area that will pick up mouse / touch events. It is null by default.
Setting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)< / p >
< / div >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > < a href = "PIXI.Rectangle.html" > PIXI.Rectangle< / a > < / span >
|
< span class = "param-type" > < a href = "PIXI.Circle.html" > PIXI.Circle< / a > < / span >
|
< span class = "param-type" > < a href = "PIXI.Ellipse.html" > PIXI.Ellipse< / a > < / span >
|
< span class = "param-type" > < a href = "PIXI.Polygon.html" > PIXI.Polygon< / a > < / span >
< / li >
< / ul >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#hitArea" > PIXI.DisplayObject#hitArea< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-81" > line 81< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="inCamera">< span class = "type-signature" > < readonly> < / span > inCamera< span class = "type-signature" > :boolean< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Checks if the Image bounds are within the game camera, otherwise false if fully outside of it. True if the Image bounds is within the game camera, even if only partially. Otherwise false if fully outside of it.< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Image.html#inCamera" > Phaser.Image#inCamera< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-833" > line 833< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="index">< span class = "type-signature" > < internal, readonly> < / span > index< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The index of this layer within the Tilemap.< / p >
< / div >
< dl class = "details" >
< dt class = "important tag-deprecated" > Internal:< / dt >
< dd class = "tag-deprecated" > < ul >
< li > This member is < em > internal (protected)< / em > and may be modified or removed in the future.< / li >
< / ul > < / dd >
< dt class = "tag-source" > Source -
2015-01-06 06:57:25 +00:00
< a href = "TilemapLayer.js.html" > tilemap/TilemapLayer.js< / a > , < a href = "TilemapLayer.js.html#sunlight-1-line-50" > line 50< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="input">< span class = "type-signature" > < / span > input< span class = "type-signature" > :< a href = "Phaser.InputHandler.html" > Phaser.InputHandler< / a > |null< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The Input Handler for this object. Needs to be enabled with image.inputEnabled = true before you can use it.< / p >
< / div >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > < a href = "Phaser.InputHandler.html" > Phaser.InputHandler< / a > < / span >
|
< span class = "param-type" > null< / span >
< / li >
< / ul >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Image.html#input" > Phaser.Image#input< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-101" > line 101< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="inputEnabled">< span class = "type-signature" > < / span > inputEnabled< span class = "type-signature" > :boolean< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > By default an Image won't process any input events at all. By setting inputEnabled to true the Phaser.InputHandler is
activated for this object and it will then start to process click/touch events and more. Set to true to allow this object to receive input events.< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Image.html#inputEnabled" > Phaser.Image#inputEnabled< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-923" > line 923< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="inWorld">< span class = "type-signature" > < readonly> < / span > inWorld< span class = "type-signature" > :boolean< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Checks if the Image bounds are within the game world, otherwise false if fully outside of it. True if the Image bounds is within the game world, even if only partially. Otherwise false if fully outside of it.< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Image.html#inWorld" > Phaser.Image#inWorld< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-816" > line 816< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="key">< span class = "type-signature" > < / span > key< span class = "type-signature" > :string|< a href = "Phaser.RenderTexture.html" > Phaser.RenderTexture< / a > |< a href = "Phaser.BitmapData.html" > Phaser.BitmapData< / a > |< a href = "PIXI.Texture.html" > PIXI.Texture< / a > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > This is the image or texture used by the Image during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture, BitmapData or PIXI.Texture.< / p >
< / div >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > string< / span >
|
< span class = "param-type" > < a href = "Phaser.RenderTexture.html" > Phaser.RenderTexture< / a > < / span >
|
< span class = "param-type" > < a href = "Phaser.BitmapData.html" > Phaser.BitmapData< / a > < / span >
|
< span class = "param-type" > < a href = "PIXI.Texture.html" > PIXI.Texture< / a > < / span >
< / li >
< / ul >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Image.html#key" > Phaser.Image#key< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-68" > line 68< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="layer">< span class = "type-signature" > < internal, readonly> < / span > layer< span class = "type-signature" > :Phaser.TileLayer< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The layer object within the Tilemap that this layer represents.< / p >
< / div >
< dl class = "details" >
< dt class = "important tag-deprecated" > Internal:< / dt >
< dd class = "tag-deprecated" > < ul >
< li > This member is < em > internal (protected)< / em > and may be modified or removed in the future.< / li >
< / ul > < / dd >
< dt class = "tag-source" > Source -
2015-01-06 06:57:25 +00:00
< a href = "TilemapLayer.js.html" > tilemap/TilemapLayer.js< / a > , < a href = "TilemapLayer.js.html#sunlight-1-line-58" > line 58< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="map">< span class = "type-signature" > < internal, readonly> < / span > map< span class = "type-signature" > :< a href = "Phaser.Tilemap.html" > Phaser.Tilemap< / a > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The Tilemap to which this layer is bound.< / p >
< / div >
< dl class = "details" >
< dt class = "important tag-deprecated" > Internal:< / dt >
< dd class = "tag-deprecated" > < ul >
< li > This member is < em > internal (protected)< / em > and may be modified or removed in the future.< / li >
< / ul > < / dd >
< dt class = "tag-source" > Source -
2015-01-06 06:57:25 +00:00
< a href = "TilemapLayer.js.html" > tilemap/TilemapLayer.js< / a > , < a href = "TilemapLayer.js.html#sunlight-1-line-42" > line 42< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="mask">< span class = "type-signature" > < / span > mask< span class = "type-signature" > :< a href = "PIXI.Graphics.html" > PIXI.Graphics< / a > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.
In PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.
To remove a mask, set this property to null.< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#mask" > PIXI.DisplayObject#mask< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-380" > line 380< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="name">< span class = "type-signature" > < / span > name< span class = "type-signature" > :string< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The name of the layer.< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source -
2015-01-06 06:57:25 +00:00
< a href = "TilemapLayer.js.html" > tilemap/TilemapLayer.js< / a > , < a href = "TilemapLayer.js.html#sunlight-1-line-101" > line 101< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="parent">< span class = "type-signature" > < readonly> < / span > parent< span class = "type-signature" > :< a href = "PIXI.DisplayObjectContainer.html" > PIXI.DisplayObjectContainer< / a > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > [read-only] The display object container that contains this display object.< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#parent" > PIXI.DisplayObject#parent< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-106" > line 106< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="pivot">< span class = "type-signature" > < / span > pivot< span class = "type-signature" > :< a href = "PIXI.Point.html" > PIXI.Point< / a > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The pivot point of the displayObject that it rotates around< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#pivot" > PIXI.DisplayObject#pivot< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-49" > line 49< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="position">< span class = "type-signature" > < / span > position< span class = "type-signature" > :< a href = "PIXI.Point.html" > PIXI.Point< / a > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The coordinate of the object relative to the local coordinates of the parent.< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#position" > PIXI.DisplayObject#position< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-14" > line 14< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="rayStepRate">< span class = "type-signature" > < / span > rayStepRate< span class = "type-signature" > :integer< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > When ray-casting against tiles this is the number of steps it will jump. For larger tile sizes you can increase this to improve performance.< / p >
< / div >
< dl class = "details" >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > 4< / li > < / ul > < / dd >
< dt class = "tag-source" > Source -
2015-01-06 06:57:25 +00:00
< a href = "TilemapLayer.js.html" > tilemap/TilemapLayer.js< / a > , < a href = "TilemapLayer.js.html#sunlight-1-line-213" > line 213< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="renderable">< span class = "type-signature" > < / span > renderable< span class = "type-signature" > :Boolean< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Can this object be rendered< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#renderable" > PIXI.DisplayObject#renderable< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-98" > line 98< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="renderOrderID">< span class = "type-signature" > < readonly> < / span > renderOrderID< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The render order ID, reset every frame.< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Image.html#renderOrderID" > Phaser.Image#renderOrderID< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-908" > line 908< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="renderSettings">< span class = "type-signature" > < / span > renderSettings< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Settings that control standard (non-diagnostic) rendering.< / p >
< / div >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2015-01-06 06:57:25 +00:00
< th > Argument< / th >
2014-11-15 20:01:46 +00:00
2015-01-06 06:57:25 +00:00
< th > Default< / th >
2014-11-15 20:01:46 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > enableScrollDelta< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
2015-01-06 06:57:25 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
true
< / td >
< td class = "description last" > < p > Delta scroll rendering only draws tiles/edges as them come into view.
This can greatly improve scrolling rendering performance, especially when there are many small tiles.
It should only be disabled in rare cases.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > copyCanvas< / code > < / td >
< td class = "type" >
< span class = "param-type" > DOMCanvasElement< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< nullable>< br >
< / td >
< td class = "default" >
(auto)
< / td >
< td class = "description last" > < p > [Internal] If set, force using a separate (shared) copy canvas.
Using a canvas bitblt/copy when the source and destinations region overlap produces unexpected behavior
in some browsers, notably Safari.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > copySliceCount< / code > < / td >
< td class = "type" >
< span class = "param-type" > integer< / span >
< / td >
< td class = "attributes" >
< / td >
2014-11-15 20:01:46 +00:00
2015-01-06 06:57:25 +00:00
< td class = "default" >
< / td >
2014-11-15 20:01:46 +00:00
2015-01-06 06:57:25 +00:00
< td class = "description last" > < p > [Internal] The number of vertical slices to copy when using a < code > copyCanvas< / code > .
This is ratio of the pixel count of the primary canvas to the copy canvas.< / p > < / td >
2014-11-15 20:01:46 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
2015-01-06 06:57:25 +00:00
< dd class = "tag-default" > < ul class = "dummy" > < li > {enableScrollDelta: true, overdrawRatio: 0.20, copyCanvas: null, copySliceCount: 4}< / li > < / ul > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-01-06 06:57:25 +00:00
< a href = "TilemapLayer.js.html" > tilemap/TilemapLayer.js< / a > , < a href = "TilemapLayer.js.html#sunlight-1-line-141" > line 141< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="rotation">< span class = "type-signature" > < / span > rotation< span class = "type-signature" > :Number< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The rotation of the object in radians.< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#rotation" > PIXI.DisplayObject#rotation< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-57" > line 57< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="scale">< span class = "type-signature" > < / span > scale< span class = "type-signature" > :< a href = "PIXI.Point.html" > PIXI.Point< / a > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The scale factor of the object.< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#scale" > PIXI.DisplayObject#scale< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-22" > line 22< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="scrollFactorX">< span class = "type-signature" > < / span > scrollFactorX< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Speed at which this layer scrolls horizontally, relative to the camera (e.g. scrollFactorX of 0.5 scrolls half as quickly as the 'normal' camera-locked layers do).< / p >
< / div >
< dl class = "details" >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > 1< / li > < / ul > < / dd >
< dt class = "tag-source" > Source -
2015-01-06 06:57:25 +00:00
< a href = "TilemapLayer.js.html" > tilemap/TilemapLayer.js< / a > , < a href = "TilemapLayer.js.html#sunlight-1-line-191" > line 191< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="scrollFactorY">< span class = "type-signature" > < / span > scrollFactorY< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Speed at which this layer scrolls vertically, relative to the camera (e.g. scrollFactorY of 0.5 scrolls half as quickly as the 'normal' camera-locked layers do)< / p >
< / div >
< dl class = "details" >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > 1< / li > < / ul > < / dd >
< dt class = "tag-source" > Source -
2015-01-06 06:57:25 +00:00
< a href = "TilemapLayer.js.html" > tilemap/TilemapLayer.js< / a > , < a href = "TilemapLayer.js.html#sunlight-1-line-199" > line 199< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="shader">< span class = "type-signature" > < / span > shader< span class = "type-signature" > :< a href = "PIXI.AbstractFilter.html" > PIXI.AbstractFilter< / a > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The shader that will be used to render the texture to the stage. Set to null to remove a current shader.< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.Sprite.html#shader" > PIXI.Sprite#shader< / a >
< / li > < / dd >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > null< / li > < / ul > < / dd >
< dt class = "tag-source" > Source -
< a href = "Sprite.js.html" > pixi/display/Sprite.js< / a > , < a href = "Sprite.js.html#sunlight-1-line-77" > line 77< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="smoothed">< span class = "type-signature" > < / span > smoothed< span class = "type-signature" > :boolean< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Enable or disable texture smoothing for this Image. Only works for bitmap/image textures. Smoothing is enabled by default. Set to true to smooth the texture of this Image, or false to disable smoothing (great for pixel art)< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Image.html#smoothed" > Phaser.Image#smoothed< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-994" > line 994< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="stage">< span class = "type-signature" > < readonly> < / span > stage< span class = "type-signature" > :< a href = "PIXI.Stage.html" > PIXI.Stage< / a > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > [read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#stage" > PIXI.DisplayObject#stage< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-115" > line 115< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="texture">< span class = "type-signature" > < internal> < / span > texture< span class = "type-signature" > :< a href = "PIXI.Texture.html" > PIXI.Texture< / a > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Required Pixi var.< / p >
< / div >
< dl class = "details" >
< dt class = "important tag-deprecated" > Internal:< / dt >
< dd class = "tag-deprecated" > < ul >
< li > This member is < em > internal (protected)< / em > and may be modified or removed in the future.< / li >
< / ul > < / dd >
< dt class = "tag-source" > Source -
2015-01-06 06:57:25 +00:00
< a href = "TilemapLayer.js.html" > tilemap/TilemapLayer.js< / a > , < a href = "TilemapLayer.js.html#sunlight-1-line-86" > line 86< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="textureFrame">< span class = "type-signature" > < internal> < / span > textureFrame< span class = "type-signature" > :< a href = "Phaser.Frame.html" > Phaser.Frame< / a > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Dimensions of the renderable area.< / p >
< / div >
< dl class = "details" >
< dt class = "important tag-deprecated" > Internal:< / dt >
< dd class = "tag-deprecated" > < ul >
< li > This member is < em > internal (protected)< / em > and may be modified or removed in the future.< / li >
< / ul > < / dd >
< dt class = "tag-source" > Source -
2015-01-06 06:57:25 +00:00
< a href = "TilemapLayer.js.html" > tilemap/TilemapLayer.js< / a > , < a href = "TilemapLayer.js.html#sunlight-1-line-93" > line 93< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="tint">< span class = "type-signature" > < / span > tint< span class = "type-signature" > :Number< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.Sprite.html#tint" > PIXI.Sprite#tint< / a >
< / li > < / dd >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > 0xFFFFFF< / li > < / ul > < / dd >
< dt class = "tag-source" > Source -
< a href = "Sprite.js.html" > pixi/display/Sprite.js< / a > , < a href = "Sprite.js.html#sunlight-1-line-59" > line 59< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="transformCallback">< span class = "type-signature" > < / span > transformCallback< span class = "type-signature" > :function< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The transform callback is an optional callback that if set will be called at the end of the updateTransform method and sent two parameters:
This Display Objects worldTransform matrix and its parents transform matrix. Both are PIXI.Matrix object types.
The matrix are passed by reference and can be modified directly without needing to return them.
This ability allows you to check any of the matrix values and perform actions such as clamping scale or limiting rotation, regardless of the parent transforms.< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#transformCallback" > PIXI.DisplayObject#transformCallback< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-30" > line 30< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="transformCallbackContext">< span class = "type-signature" > < / span > transformCallbackContext< span class = "type-signature" > :Object< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The context under which the transformCallback is invoked.< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#transformCallbackContext" > PIXI.DisplayObject#transformCallbackContext< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-41" > line 41< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="type">< span class = "type-signature" > < internal, readonly> < / span > type< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The const type of this object.< / p >
< / div >
< dl class = "details" >
< dt class = "important tag-deprecated" > Internal:< / dt >
< dd class = "tag-deprecated" > < ul >
< li > This member is < em > internal (protected)< / em > and may be modified or removed in the future.< / li >
< / ul > < / dd >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > Phaser.TILEMAPLAYER< / li > < / ul > < / dd >
< dt class = "tag-source" > Source -
2015-01-06 06:57:25 +00:00
< a href = "TilemapLayer.js.html" > tilemap/TilemapLayer.js< / a > , < a href = "TilemapLayer.js.html#sunlight-1-line-110" > line 110< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="visible">< span class = "type-signature" > < / span > visible< span class = "type-signature" > :Boolean< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The visibility of the object.< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#visible" > PIXI.DisplayObject#visible< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-73" > line 73< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="width">< span class = "type-signature" > < / span > width< span class = "type-signature" > :Number< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The width of the sprite, setting this will actually modify the scale to achieve the value set< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.Sprite.html#width" > PIXI.Sprite#width< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "Sprite.js.html" > pixi/display/Sprite.js< / a > , < a href = "Sprite.js.html#sunlight-1-line-103" > line 103< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="world">< span class = "type-signature" > < / span > world< span class = "type-signature" > :< a href = "Phaser.Point.html" > Phaser.Point< / a > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The world coordinates of this Image. This differs from the x/y coordinates which are relative to the Images container.< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Image.html#world" > Phaser.Image#world< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-80" > line 80< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="worldAlpha">< span class = "type-signature" > < readonly> < / span > worldAlpha< span class = "type-signature" > :Number< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > [read-only] The multiplied alpha of the displayObject< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#worldAlpha" > PIXI.DisplayObject#worldAlpha< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-124" > line 124< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="worldVisible">< span class = "type-signature" > < / span > worldVisible< span class = "type-signature" > :Boolean< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > [read-only] Indicates if the sprite is globally visible.< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#worldVisible" > PIXI.DisplayObject#worldVisible< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-359" > line 359< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="x">< span class = "type-signature" > < / span > x< span class = "type-signature" > :Number< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The position of the displayObject on the x axis relative to the local coordinates of the parent.< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#x" > PIXI.DisplayObject#x< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
2014-11-25 00:23:44 +00:00
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-761" > line 761< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="y">< span class = "type-signature" > < / span > y< span class = "type-signature" > :Number< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The position of the displayObject on the y axis relative to the local coordinates of the parent.< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#y" > PIXI.DisplayObject#y< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
2014-11-25 00:23:44 +00:00
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-776" > line 776< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="z">< span class = "type-signature" > < / span > z< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The z-depth value of this object within its Group (remember the World is a Group as well). No two objects in a Group can have the same z value.< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Image.html#z" > Phaser.Image#z< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-53" > line 53< / a >
< / dt >
< / dl >
< / dd >
< / dl >
< h3 class = "subsection-title" > Methods< / h3 >
< dl >
2015-01-06 06:57:25 +00:00
< dt >
< h4 class = "name "
id="ensureSharedCopyCanvas">< span class = "type-signature" > < internal, static> < / span > ensureSharedCopyCanvas< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Create if needed (and return) a shared copy canvas that is shared across all TilemapLayers.< / p >
< p > Code that uses the canvas is responsible to ensure the dimensions and save/restore state as appropriate.< / p >
< / div >
< dl class = "details" >
< dt class = "important tag-deprecated" > Internal:< / dt >
< dd class = "tag-deprecated" > < ul >
< li > This member is < em > internal (protected)< / em > and may be modified or removed in the future.< / li >
< / ul > < / dd >
< dt class = "tag-source" > Source -
< a href = "TilemapLayer.js.html" > tilemap/TilemapLayer.js< / a > , < a href = "TilemapLayer.js.html#sunlight-1-line-293" > line 293< / a >
< / dt >
< / dl >
< / dd >
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="addChild">< span class = "type-signature" > < / span > addChild< span class = "signature" > (child)< / span > < span class = "type-signature" > → {< a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Adds a child to the container.< / 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 > child< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
< / td >
< td class = "description last" > < p > The DisplayObject to add to the container< / p > < / td >
< / tr >
< / tbody >
< / table >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The child that was added.< / p >
< / div >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObjectContainer.html#addChild" > PIXI.DisplayObjectContainer#addChild< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "DisplayObjectContainer.js.html#sunlight-1-line-90" > line 90< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="addChildAt">< span class = "type-signature" > < / span > addChildAt< span class = "signature" > (child, index)< / span > < span class = "type-signature" > → {< a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown< / 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 > child< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
< / td >
< td class = "description last" > < p > The child to add< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > index< / code > < / td >
< td class = "type" >
< span class = "param-type" > Number< / span >
< / td >
< td class = "description last" > < p > The index to place the child in< / p > < / td >
< / tr >
< / tbody >
< / table >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The child that was added.< / p >
< / div >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObjectContainer.html#addChildAt" > PIXI.DisplayObjectContainer#addChildAt< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "DisplayObjectContainer.js.html#sunlight-1-line-102" > line 102< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="bringToTop">< span class = "type-signature" > < / span > bringToTop< span class = "signature" > ()< / span > < span class = "type-signature" > → {< a href = "Phaser.Image.html" > Phaser.Image< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Brings the Image to the top of the display list it is a child of. Images that are members of a Phaser.Group are only
bought to the top of that Group, not the entire display list.< / p >
< / div >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > < a href = "Phaser.Image.html" > Phaser.Image< / a > < / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > This instance.< / p >
< / div >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Image.html#bringToTop" > Phaser.Image#bringToTop< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-614" > line 614< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="crop">< span class = "type-signature" > < / span > crop< span class = "signature" > (rect, < span class = "optional" > copy< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Crop allows you to crop the texture used to display this Image.
Cropping takes place from the top-left of the Image and can be modified in real-time by providing an updated rectangle object.
The rectangle object given to this method can be either a Phaser.Rectangle or any object so long as it has public x, y, width and height properties.
Please note that the rectangle object given is not duplicated by this method, but rather the Image uses a reference to the rectangle.
Keep this in mind if assigning a rectangle in a for-loop, or when cleaning up for garbage collection.< / p >
2014-11-15 20:01:46 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-12-03 10:39:11 +00:00
< th > Argument< / th >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< th > Default< / th >
2014-11-15 20:01:46 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > rect< / code > < / td >
2014-11-15 20:01:46 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > < a href = "Phaser.Rectangle.html" > Phaser.Rectangle< / a > < / span >
2014-11-15 20:01:46 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< / td >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< td class = "default" >
< / td >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The Rectangle used during cropping. Pass null or no parameters to clear a previously set crop rectangle.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > copy< / 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 false Sprite.cropRect will be a reference to the given rect. If true it will copy the rect values into a local Sprite.cropRect object.< / p > < / td >
2014-11-15 20:01:46 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "Phaser.Image.html#crop" > Phaser.Image#crop< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source -
2014-12-03 10:39:11 +00:00
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-384" > line 384< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="destroy">< span class = "type-signature" > < / span > destroy< span class = "signature" > (< span class = "optional" > destroyChildren< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Destroys the Image. This removes it from its parent group, destroys the input, event and animation handlers if present
and nulls its reference to game, freeing it up for garbage collection.< / p >
2014-11-15 20:01:46 +00:00
< / 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 >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > destroyChildren< / code > < / td >
2014-11-15 20:01:46 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > boolean< / span >
2014-11-15 20:01:46 +00:00
< / td >
< td class = "attributes" >
2014-12-03 10:39:11 +00:00
< optional>< br >
2014-11-15 20:01:46 +00:00
< / td >
< td class = "default" >
2014-12-03 10:39:11 +00:00
true
2014-11-15 20:01:46 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > Should every child of this object have its destroy method called?< / p > < / td >
2014-11-15 20:01:46 +00:00
< / tr >
2014-12-03 10:39:11 +00:00
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Image.html#destroy" > Phaser.Image#destroy< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-514" > line 514< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="generateTexture">< span class = "type-signature" > < / span > generateTexture< span class = "signature" > (resolution, scaleMode, renderer)< / span > < span class = "type-signature" > → {< a href = "PIXI.Texture.html" > PIXI.Texture< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Useful function that returns a texture of the displayObject object that can then be used to create sprites
This can be quite useful if your displayObject is static / complicated and needs to be reused multiple times.< / 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 > resolution< / code > < / td >
< td class = "type" >
< span class = "param-type" > Number< / span >
< / td >
< td class = "description last" > < p > The resolution of the texture being generated< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > scaleMode< / code > < / td >
< td class = "type" >
< span class = "param-type" > Number< / span >
< / td >
< td class = "description last" > < p > See {{#crossLink " PIXI/scaleModes:property" }}PIXI.scaleModes{{/crossLink}} for possible values< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > renderer< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "PIXI.CanvasRenderer.html" > PIXI.CanvasRenderer< / a > < / span >
|
< span class = "param-type" > < a href = "PIXI.WebGLRenderer.html" > PIXI.WebGLRenderer< / a > < / span >
< / td >
< td class = "description last" > < p > The renderer used to generate the texture.< / p > < / td >
< / tr >
< / tbody >
< / table >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > < a href = "PIXI.Texture.html" > PIXI.Texture< / a > < / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > a texture of the graphics object< / p >
< / div >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#generateTexture" > PIXI.DisplayObject#generateTexture< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
2014-11-25 00:23:44 +00:00
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-582" > line 582< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="getBounds">< span class = "type-signature" > < / span > getBounds< span class = "signature" > (matrix)< / span > < span class = "type-signature" > → {< a href = "PIXI.Rectangle.html" > PIXI.Rectangle< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Returns the bounds of the Sprite as a rectangle. The bounds calculation takes the worldTransform into account.< / 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 > matrix< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "PIXI.Matrix.html" > PIXI.Matrix< / a > < / span >
< / td >
< td class = "description last" > < p > the transformation matrix of the sprite< / p > < / td >
< / tr >
< / tbody >
< / table >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > < a href = "PIXI.Rectangle.html" > PIXI.Rectangle< / a > < / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > the framing rectangle< / p >
< / div >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.Sprite.html#getBounds" > PIXI.Sprite#getBounds< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "Sprite.js.html" > pixi/display/Sprite.js< / a > , < a href = "Sprite.js.html#sunlight-1-line-163" > line 163< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="getChildAt">< span class = "type-signature" > < / span > getChildAt< span class = "signature" > (index)< / span > < span class = "type-signature" > → {< a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Returns the child at the specified index< / 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 > index< / code > < / td >
< td class = "type" >
< span class = "param-type" > Number< / span >
< / td >
< td class = "description last" > < p > The index to get the child from< / p > < / td >
< / tr >
< / tbody >
< / table >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The child at the given index, if any.< / p >
< / div >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObjectContainer.html#getChildAt" > PIXI.DisplayObjectContainer#getChildAt< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "DisplayObjectContainer.js.html#sunlight-1-line-193" > line 193< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="getChildIndex">< span class = "type-signature" > < / span > getChildIndex< span class = "signature" > (child)< / span > < span class = "type-signature" > → {Number}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Returns the index position of a child DisplayObject instance< / 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 > child< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
< / td >
< td class = "description last" > < p > The DisplayObject instance to identify< / p > < / td >
< / tr >
< / tbody >
< / table >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > Number< / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The index position of the child display object to identify< / p >
< / div >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObjectContainer.html#getChildIndex" > PIXI.DisplayObjectContainer#getChildIndex< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "DisplayObjectContainer.js.html#sunlight-1-line-158" > line 158< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="getLocalBounds">< span class = "type-signature" > < / span > getLocalBounds< span class = "signature" > ()< / span > < span class = "type-signature" > → {< a href = "PIXI.Rectangle.html" > PIXI.Rectangle< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.< / p >
< / div >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > < a href = "PIXI.Rectangle.html" > PIXI.Rectangle< / a > < / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The rectangular bounding area< / p >
< / div >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObjectContainer.html#getLocalBounds" > PIXI.DisplayObjectContainer#getLocalBounds< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "DisplayObjectContainer.js.html#sunlight-1-line-362" > line 362< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="getRayCastTiles">< span class = "type-signature" > < / span > getRayCastTiles< span class = "signature" > (line, < span class = "optional" > stepRate< / span > , < span class = "optional" > collides< / span > , < span class = "optional" > interestingFace< / span > )< / span > < span class = "type-signature" > → {Phaser.Tile[]}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Gets all tiles that intersect with the given line.< / 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 > line< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Line.html" > Phaser.Line< / a > < / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > The line used to determine which tiles to return.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > stepRate< / code > < / td >
< td class = "type" >
< span class = "param-type" > integer< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
(rayStepRate)
< / td >
< td class = "description last" > < p > How many steps through the ray will we check? Defaults to < code > rayStepRate< / code > .< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > collides< / 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, < em > only< / em > return tiles that collide on one or more faces.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > interestingFace< / 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, < em > only< / em > return tiles that have interesting faces.< / p > < / td >
< / tr >
< / tbody >
< / table >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > Phaser.Tile[]< / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > An array of Phaser.Tiles.< / p >
< / div >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source -
2015-01-06 06:57:25 +00:00
< a href = "TilemapLayer.js.html" > tilemap/TilemapLayer.js< / a > , < a href = "TilemapLayer.js.html#sunlight-1-line-504" > line 504< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="getTiles">< span class = "type-signature" > < / span > getTiles< span class = "signature" > (x, y, width, height, < span class = "optional" > collides< / span > , < span class = "optional" > interestingFace< / span > )< / span > < span class = "type-signature" > → {array.< < a href = "Phaser.Tile.html" > Phaser.Tile< / a > >}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Get all tiles that exist within the given area, defined by the top-left corner, width and height. Values given are in pixels, not tiles.< / 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 > x< / 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 > X position of the top left corner (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 = "default" >
< / td >
< td class = "description last" > < p > Y position of the top left corner (in 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 = "default" >
< / td >
< td class = "description last" > < p > Width of the area to get (in 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 = "default" >
< / td >
< td class = "description last" > < p > Height of the area to get (in pixels).< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > collides< / 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, < em > only< / em > return tiles that collide on one or more faces.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > interestingFace< / 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, < em > only< / em > return tiles that have interesting faces.< / p > < / td >
< / tr >
< / tbody >
< / table >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > array.< < a href = "Phaser.Tile.html" > Phaser.Tile< / a > >< / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > An array of Tiles.< / p >
< / div >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source -
2015-01-06 06:57:25 +00:00
< a href = "TilemapLayer.js.html" > tilemap/TilemapLayer.js< / a > , < a href = "TilemapLayer.js.html#sunlight-1-line-551" > line 551< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="getTileX">< span class = "type-signature" > < / span > getTileX< span class = "signature" > (x)< / span > < span class = "type-signature" > → {integer}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Convert a pixel value to a tile coordinate.< / 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 > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > X position of the point in target tile (in pixels).< / p > < / td >
< / tr >
< / tbody >
< / table >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > integer< / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The X map location of the tile.< / p >
< / div >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source -
2015-01-06 06:57:25 +00:00
< a href = "TilemapLayer.js.html" > tilemap/TilemapLayer.js< / a > , < a href = "TilemapLayer.js.html#sunlight-1-line-455" > line 455< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="getTileXY">< span class = "type-signature" > < / span > getTileXY< span class = "signature" > (x, y, point)< / span > < span class = "type-signature" > → {< a href = "Phaser.Point.html" > Phaser.Point< / a > |object}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Convert a pixel coordinate to a tile coordinate.< / 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 > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > X position of the point in target tile (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 = "description last" > < p > Y position of the point in target tile (in pixels).< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > point< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
|
< span class = "param-type" > object< / span >
< / td >
< td class = "description last" > < p > The Point/object to update.< / p > < / td >
< / tr >
< / tbody >
< / table >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
|
< span class = "param-type" > object< / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > A Point/object with its < code > x< / code > and < code > y< / code > properties set.< / p >
< / div >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source -
2015-01-06 06:57:25 +00:00
< a href = "TilemapLayer.js.html" > tilemap/TilemapLayer.js< / a > , < a href = "TilemapLayer.js.html#sunlight-1-line-485" > line 485< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="getTileY">< span class = "type-signature" > < / span > getTileY< span class = "signature" > (y)< / span > < span class = "type-signature" > → {integer}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Convert a pixel value to a tile coordinate.< / 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 > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > Y position of the point in target tile (in pixels).< / p > < / td >
< / tr >
< / tbody >
< / table >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > integer< / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The Y map location of the tile.< / p >
< / div >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source -
2015-01-06 06:57:25 +00:00
< a href = "TilemapLayer.js.html" > tilemap/TilemapLayer.js< / a > , < a href = "TilemapLayer.js.html#sunlight-1-line-470" > line 470< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="kill">< span class = "type-signature" > < / span > kill< span class = "signature" > ()< / span > < span class = "type-signature" > → {< a href = "Phaser.Image.html" > Phaser.Image< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Kills a Image. A killed Image has its alive, exists and visible properties all set to false.
It will dispatch the onKilled event, you can listen to Image.events.onKilled for the signal.
Note that killing a Image is a way for you to quickly recycle it in a Image pool, it doesn't free it up from memory.
If you don't need this Image any more you should call Image.destroy instead.< / p >
< / div >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > < a href = "Phaser.Image.html" > Phaser.Image< / a > < / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > This instance.< / p >
< / div >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Image.html#kill" > Phaser.Image#kill< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-489" > line 489< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="loadTexture">< span class = "type-signature" > < / span > loadTexture< span class = "signature" > (key, frame)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Changes the Texture the Image is using entirely. The old texture is removed and the new one is referenced or fetched from the Cache.
This causes a WebGL texture update, so use sparingly or in low-intensity portions of your game.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > key< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
|
< span class = "param-type" > < a href = "Phaser.RenderTexture.html" > Phaser.RenderTexture< / a > < / span >
|
< span class = "param-type" > < a href = "Phaser.BitmapData.html" > Phaser.BitmapData< / a > < / span >
|
< span class = "param-type" > < a href = "PIXI.Texture.html" > PIXI.Texture< / a > < / span >
< / td >
< td class = "description last" > < p > This is the image or texture used by the Image during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture, BitmapData or PIXI.Texture.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > frame< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
|
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > If this Image is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Image.html#loadTexture" > Phaser.Image#loadTexture< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-242" > line 242< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="postUpdate">< span class = "type-signature" > < internal> < / span > postUpdate< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Automatically called by World.postUpdate. Handles cache updates.< / p >
2014-11-15 20:01:46 +00:00
< / div >
< dl class = "details" >
2014-12-03 10:39:11 +00:00
< dt class = "important tag-deprecated" > Internal:< / dt >
< dd class = "tag-deprecated" > < ul >
< li > This member is < em > internal (protected)< / em > and may be modified or removed in the future.< / li >
< / ul > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-01-06 06:57:25 +00:00
< a href = "TilemapLayer.js.html" > tilemap/TilemapLayer.js< / a > , < a href = "TilemapLayer.js.html#sunlight-1-line-325" > line 325< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="preUpdate">< span class = "type-signature" > < / span > preUpdate< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Automatically called by World.preUpdate.< / p >
2014-11-15 20:01:46 +00:00
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "Phaser.Image.html#preUpdate" > Phaser.Image#preUpdate< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source -
2014-12-03 10:39:11 +00:00
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-161" > line 161< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="removeChild">< span class = "type-signature" > < / span > removeChild< span class = "signature" > (child)< / span > < span class = "type-signature" > → {< a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > }< / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Removes a child from the container.< / p >
2014-11-15 20:01:46 +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-12-03 10:39:11 +00:00
< td class = "name" > < code > child< / code > < / td >
2014-11-15 20:01:46 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
2014-11-15 20:01:46 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The DisplayObject to remove< / p > < / td >
2014-11-15 20:01:46 +00:00
< / tr >
< / tbody >
< / table >
2014-12-03 10:39:11 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The child that was removed.< / p >
< / div >
< / div >
2014-11-15 20:01:46 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "PIXI.DisplayObjectContainer.html#removeChild" > PIXI.DisplayObjectContainer#removeChild< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source -
2014-12-03 10:39:11 +00:00
< a href = "DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "DisplayObjectContainer.js.html#sunlight-1-line-210" > line 210< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="removeChildAt">< span class = "type-signature" > < / span > removeChildAt< span class = "signature" > (index)< / span > < span class = "type-signature" > → {< a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > }< / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Removes a child from the specified index position.< / p >
2014-11-15 20:01:46 +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-12-03 10:39:11 +00:00
< td class = "name" > < code > index< / code > < / td >
2014-11-15 20:01:46 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > Number< / span >
2014-11-15 20:01:46 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The index to get the child from< / p > < / td >
2014-11-15 20:01:46 +00:00
< / tr >
< / tbody >
< / table >
2014-12-03 10:39:11 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The child that was removed.< / p >
< / div >
< / div >
2014-11-15 20:01:46 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "PIXI.DisplayObjectContainer.html#removeChildAt" > PIXI.DisplayObjectContainer#removeChildAt< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source -
2014-12-03 10:39:11 +00:00
< a href = "DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "DisplayObjectContainer.js.html#sunlight-1-line-225" > line 225< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="removeChildren">< span class = "type-signature" > < / span > removeChildren< span class = "signature" > (beginIndex, endIndex)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Removes all children from this container that are within the begin and end indexes.< / p >
2014-11-15 20:01:46 +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-12-03 10:39:11 +00:00
< td class = "name" > < code > beginIndex< / code > < / td >
2014-11-15 20:01:46 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > Number< / span >
2014-11-15 20:01:46 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The beginning position. Default value is 0.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > endIndex< / code > < / td >
< td class = "type" >
< span class = "param-type" > Number< / span >
< / td >
< td class = "description last" > < p > The ending position. Default value is size of the container.< / p > < / td >
2014-11-15 20:01:46 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "PIXI.DisplayObjectContainer.html#removeChildren" > PIXI.DisplayObjectContainer#removeChildren< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source -
2014-12-03 10:39:11 +00:00
< a href = "DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "DisplayObjectContainer.js.html#sunlight-1-line-243" > line 243< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="removeStageReference">< span class = "type-signature" > < / span > removeStageReference< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Removes the current stage reference from the container and all of its children.< / p >
2014-11-15 20:01:46 +00:00
< / div >
< dl class = "details" >
2014-12-03 10:39:11 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObjectContainer.html#removeStageReference" > PIXI.DisplayObjectContainer#removeStageReference< / a >
< / li > < / dd >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2014-12-03 10:39:11 +00:00
< a href = "DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "DisplayObjectContainer.js.html#sunlight-1-line-404" > line 404< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="render">< span class = "type-signature" > < internal> < / span > render< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Renders the tiles to the layer canvas and pushes to the display.< / p >
2014-11-15 20:01:46 +00:00
< / div >
< dl class = "details" >
2014-12-03 10:39:11 +00:00
< dt class = "important tag-deprecated" > Internal:< / dt >
< dd class = "tag-deprecated" > < ul >
< li > This member is < em > internal (protected)< / em > and may be modified or removed in the future.< / li >
< / ul > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-01-06 06:57:25 +00:00
< a href = "TilemapLayer.js.html" > tilemap/TilemapLayer.js< / a > , < a href = "TilemapLayer.js.html#sunlight-1-line-984" > line 984< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="reset">< span class = "type-signature" > < / span > reset< span class = "signature" > (x, y)< / span > < span class = "type-signature" > → {< a href = "Phaser.Image.html" > Phaser.Image< / a > }< / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Resets the Image. This places the Image at the given x/y world coordinates and then sets alive, exists, visible and renderable all to true.< / p >
2014-11-15 20:01:46 +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-12-03 10:39:11 +00:00
< td class = "name" > < code > x< / code > < / td >
2014-11-15 20:01:46 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > number< / span >
2014-11-15 20:01:46 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The x coordinate (in world space) to position the Image at.< / 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 (in world space) to position the Image at.< / p > < / td >
2014-11-15 20:01:46 +00:00
< / tr >
< / tbody >
< / table >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > < a href = "Phaser.Image.html" > Phaser.Image< / a > < / span >
2014-11-15 20:01:46 +00:00
-
< / div >
< div class = "returns-desc param-desc" >
2014-12-03 10:39:11 +00:00
< p > This instance.< / p >
2014-11-15 20:01:46 +00:00
< / div >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "Phaser.Image.html#reset" > Phaser.Image#reset< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source -
2014-12-03 10:39:11 +00:00
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-591" > line 591< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="resetFrame">< span class = "type-signature" > < / span > resetFrame< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Resets the Texture frame dimensions that the Image uses for rendering.< / p >
2014-11-15 20:01:46 +00:00
< / div >
2014-12-03 10:39:11 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Image.html#resetFrame" > Phaser.Image#resetFrame< / a >
< / li > < / dd >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< dt class = "tag-source" > Source -
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-369" > line 369< / a >
< / dt >
2013-10-25 15:54:40 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="resetTilesetCache">< span class = "type-signature" > < / span > resetTilesetCache< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
2015-01-06 06:57:25 +00:00
< p > The TilemapLayer caches tileset look-ups.< / p >
< p > Call this method of clear the cache if tilesets have been added or updated after the layer has been rendered.< / p >
2014-11-15 20:01:46 +00:00
< / div >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-01-06 06:57:25 +00:00
< a href = "TilemapLayer.js.html" > tilemap/TilemapLayer.js< / a > , < a href = "TilemapLayer.js.html#sunlight-1-line-663" > line 663< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-25 15:54:40 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
< / dd >
2014-02-05 06:29:17 +00:00
2013-10-25 15:54:40 +00:00
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="resizeWorld">< span class = "type-signature" > < / span > resizeWorld< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< div class = "description" >
< p > Sets the world size to match the size of this layer.< / p >
< / div >
2013-11-28 15:57:09 +00:00
2014-12-03 10:39:11 +00:00
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-01-06 06:57:25 +00:00
< a href = "TilemapLayer.js.html" > tilemap/TilemapLayer.js< / a > , < a href = "TilemapLayer.js.html#sunlight-1-line-357" > line 357< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-11-28 15:57:09 +00:00
2014-07-10 19:31:11 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-07-10 19:31:11 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="revive">< span class = "type-signature" > < / span > revive< span class = "signature" > ()< / span > < span class = "type-signature" > → {< a href = "Phaser.Image.html" > Phaser.Image< / a > }< / span > < / h4 >
2014-07-10 19:31:11 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-07-10 19:31:11 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Brings a 'dead' Image back to life, optionally giving it the health value specified.
A resurrected Image has its alive, exists and visible properties all set to true.
It will dispatch the onRevived event, you can listen to Image.events.onRevived for the signal.< / p >
2014-11-15 20:01:46 +00:00
< / div >
2014-07-10 19:31:11 +00:00
2014-11-15 20:01:46 +00:00
2014-07-10 19:31:11 +00:00
2014-12-03 10:39:11 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
2014-07-10 19:31:11 +00:00
2014-12-03 10:39:11 +00:00
< div class = "returns-type" >
< span class = "param-type" > < a href = "Phaser.Image.html" > Phaser.Image< / a > < / span >
2014-07-10 19:31:11 +00:00
2014-12-03 10:39:11 +00:00
-
< / div >
2014-07-10 19:31:11 +00:00
2014-12-03 10:39:11 +00:00
< div class = "returns-desc param-desc" >
< p > This instance.< / p >
< / div >
2014-07-10 19:31:11 +00:00
2014-12-03 10:39:11 +00:00
< / div >
2014-07-10 19:31:11 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2014-07-10 19:31:11 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "Phaser.Image.html#revive" > Phaser.Image#revive< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
2014-07-10 19:31:11 +00:00
2014-11-15 20:01:46 +00:00
2014-07-10 19:31:11 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2014-12-03 10:39:11 +00:00
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-465" > line 465< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-07-10 19:31:11 +00:00
2013-11-28 15:57:09 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
< / dd >
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="setChildIndex">< span class = "type-signature" > < / span > setChildIndex< span class = "signature" > (child, index)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-03-14 06:36:05 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Changes the position of an existing child in the display object container< / p >
2014-03-14 06:36:05 +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-12-03 10:39:11 +00:00
< td class = "name" > < code > child< / code > < / td >
2014-03-14 06:36:05 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
2014-03-14 06:36:05 +00:00
< / td >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The child DisplayObject instance for which you want to change the index number< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > index< / code > < / td >
< td class = "type" >
< span class = "param-type" > Number< / span >
< / td >
< td class = "description last" > < p > The resulting index number for the child display object< / p > < / td >
2014-03-14 06:36:05 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "PIXI.DisplayObjectContainer.html#setChildIndex" > PIXI.DisplayObjectContainer#setChildIndex< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2014-12-03 10:39:11 +00:00
< a href = "DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "DisplayObjectContainer.js.html#sunlight-1-line-175" > line 175< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-03-14 06:36:05 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="setFrame">< span class = "type-signature" > < / span > setFrame< span class = "signature" > (frame)< / span > < span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Sets the Texture frame the Image uses for rendering.
This is primarily an internal method used by Image.loadTexture, although you may call it directly.< / 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-12-03 10:39:11 +00:00
< td class = "name" > < code > frame< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > < a href = "Phaser.Frame.html" > Phaser.Frame< / a > < / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The Frame to be used by the Image texture.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
2014-11-15 20:01:46 +00:00
< / tbody >
< / table >
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "Phaser.Image.html#setFrame" > Phaser.Image#setFrame< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2014-12-03 10:39:11 +00:00
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-314" > line 314< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="setScaleMinMax">< span class = "type-signature" > < / span > setScaleMinMax< span class = "signature" > (minX, minY, maxX, maxY)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Sets the scaleMin and scaleMax values in one call.
These values are used to limit how far this Image will scale (either up or down) based on its parent.
For example if this Image has a minScale value of 1 and its parent has a scale value of 0.5, the 0.5 will be ignored and the scale value of 1 will be used.
By using these values you can carefully control how Images deal with responsive scaling.< / p >
< p > If only one parameter is given then that value will be used for both scaleMin and scaleMax:
setScaleMinMax(1) = scaleMin.x, scaleMin.y, scaleMax.x and scaleMax.y all = 1< / p >
< p > If only two parameters are given the first is set as scaleMin.x and y and the second as scaleMax.x and y:
setScaleMinMax(0.5, 2) = scaleMin.x and y = 0.5 and scaleMax.x and y = 2< / p >
< p > If you wish to set scaleMin with different values for x and y then either modify Image.scaleMin directly, or pass < code > null< / code > for the maxX and maxY parameters.< / p >
< p > Call setScaleMinMax(null) to clear both the scaleMin and scaleMax values.< / p >
2014-11-15 20:01:46 +00:00
< / div >
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< h5 > Parameters:< / h5 >
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< th > Type< / th >
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
2014-12-03 10:39:11 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > minX< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
|
< span class = "param-type" > null< / span >
< / td >
< td class = "description last" > < p > The minimum horizontal scale value this Image can scale down to.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > minY< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
|
< span class = "param-type" > null< / span >
< / td >
< td class = "description last" > < p > The minimum vertical scale value this Image can scale down to.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > maxX< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
|
< span class = "param-type" > null< / span >
< / td >
2013-11-28 15:57:09 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The maximum horizontal scale value this Image can scale up to.< / p > < / td >
< / tr >
2013-11-28 15:57:09 +00:00
2014-03-14 06:36:05 +00:00
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > maxY< / code > < / td >
2014-03-14 06:36:05 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > number< / span >
|
< span class = "param-type" > null< / span >
2014-03-14 06:36:05 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The maximum vertical scale value this Image can scale up to.< / p > < / td >
2014-03-14 06:36:05 +00:00
< / tr >
2013-11-28 15:57:09 +00:00
< / tbody >
< / table >
2013-10-25 15:54:40 +00:00
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
< dl class = "details" >
2013-10-25 15:54:40 +00:00
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "Phaser.Image.html#setScaleMinMax" > Phaser.Image#setScaleMinMax< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2014-12-03 10:39:11 +00:00
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-670" > line 670< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-11-28 15:57:09 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="setStageReference">< span class = "type-signature" > < / span > setStageReference< span class = "signature" > (stage)< / span > < span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.< / 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-12-03 10:39:11 +00:00
< td class = "name" > < code > stage< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > < a href = "PIXI.Stage.html" > PIXI.Stage< / a > < / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > the stage that the container will have as its current stage reference< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
2014-11-15 20:01:46 +00:00
< / tbody >
< / table >
2013-11-28 15:57:09 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "PIXI.DisplayObjectContainer.html#setStageReference" > PIXI.DisplayObjectContainer#setStageReference< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2014-12-03 10:39:11 +00:00
< a href = "DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "DisplayObjectContainer.js.html#sunlight-1-line-386" > line 386< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-11-28 15:57:09 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="setTexture">< span class = "type-signature" > < / span > setTexture< span class = "signature" > (texture)< / span > < span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Sets the texture of the sprite< / p >
2013-11-28 15:57:09 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
2013-10-25 15:54:40 +00:00
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2013-11-28 15:57:09 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > texture< / code > < / td >
2014-02-05 06:29:17 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > < a href = "PIXI.Texture.html" > PIXI.Texture< / a > < / span >
2014-02-05 06:29:17 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The PIXI texture that is displayed by the sprite< / p > < / td >
2014-02-05 06:29:17 +00:00
< / tr >
2013-10-25 15:54:40 +00:00
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
< dl class = "details" >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "PIXI.Sprite.html#setTexture" > PIXI.Sprite#setTexture< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2014-12-03 10:39:11 +00:00
< a href = "Sprite.js.html" > pixi/display/Sprite.js< / a > , < a href = "Sprite.js.html#sunlight-1-line-135" > line 135< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-25 15:54:40 +00:00
< / dl >
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
2013-10-25 15:54:40 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="swapChildren">< span class = "type-signature" > < / span > swapChildren< span class = "signature" > (child, child2)< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
2013-11-28 15:57:09 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Swaps the position of 2 Display Objects within this container.< / p >
2013-11-28 15:57:09 +00:00
< / div >
2013-10-25 15:54:40 +00:00
2013-11-28 15:57:09 +00:00
< h5 > Parameters:< / h5 >
2013-10-25 15:54:40 +00:00
2013-11-28 15:57:09 +00:00
< table class = "params table table-striped" >
2013-10-25 15:54:40 +00:00
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > child< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
< / td >
< td class = "description last" > < p > -< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > child2< / code > < / td >
2013-10-25 15:54:40 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
2013-10-25 15:54:40 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > -< / p > < / td >
2013-10-25 15:54:40 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
< dl class = "details" >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "PIXI.DisplayObjectContainer.html#swapChildren" > PIXI.DisplayObjectContainer#swapChildren< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2014-12-03 10:39:11 +00:00
< a href = "DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "DisplayObjectContainer.js.html#sunlight-1-line-133" > line 133< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-25 15:54:40 +00:00
< / dl >
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
2013-10-25 15:54:40 +00:00
< / dd >
2013-11-28 15:57:09 +00:00
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="toGlobal">< span class = "type-signature" > < / span > toGlobal< span class = "signature" > (position)< / span > < span class = "type-signature" > → {< a href = "PIXI.Point.html" > PIXI.Point< / a > }< / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Calculates the global position of the display object< / p >
2013-11-28 15:57:09 +00:00
< / div >
2013-10-25 15:54:40 +00:00
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > position< / code > < / td >
2014-11-15 20:01:46 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > < a href = "PIXI.Point.html" > PIXI.Point< / a > < / span >
2014-11-15 20:01:46 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The world origin to calculate from< / p > < / td >
2014-11-15 20:01:46 +00:00
< / tr >
< / tbody >
< / table >
2014-12-03 10:39:11 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > < a href = "PIXI.Point.html" > PIXI.Point< / a > < / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > A point object representing the position of this object< / p >
< / div >
< / div >
2013-11-28 15:57:09 +00:00
< dl class = "details" >
2013-10-25 15:54:40 +00:00
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "PIXI.DisplayObject.html#toGlobal" > PIXI.DisplayObject#toGlobal< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2014-12-03 10:39:11 +00:00
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-616" > line 616< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-11-28 15:57:09 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
< / dd >
2013-10-25 15:54:40 +00:00
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="toLocal">< span class = "type-signature" > < / span > toLocal< span class = "signature" > (position, < span class = "optional" > from< / span > )< / span > < span class = "type-signature" > → {< a href = "PIXI.Point.html" > PIXI.Point< / a > }< / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Calculates the local position of the display object relative to another point< / p >
2013-10-25 15:54:40 +00:00
< / div >
2014-11-15 20:01:46 +00:00
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-12-03 10:39:11 +00:00
< th > Argument< / th >
2014-11-15 20:01:46 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > position< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "PIXI.Point.html" > PIXI.Point< / a > < / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The world origin to calculate from< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > from< / code > < / td >
2014-11-15 20:01:46 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
2014-11-15 20:01:46 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The DisplayObject to calculate the global position from< / p > < / td >
2014-11-15 20:01:46 +00:00
< / tr >
< / tbody >
< / table >
2014-12-03 10:39:11 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > < a href = "PIXI.Point.html" > PIXI.Point< / a > < / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > A point object representing the position of this object< / p >
< / div >
< / div >
2013-10-25 15:54:40 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "PIXI.DisplayObject.html#toLocal" > PIXI.DisplayObject#toLocal< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2014-12-03 10:39:11 +00:00
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-630" > line 630< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-25 15:54:40 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="update">< span class = "type-signature" > < / span > update< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > Override and use this function in your own custom objects to handle any update requirements you may have.< / p >
2013-10-25 15:54:40 +00:00
< / div >
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Image.html#update" > Phaser.Image#update< / a >
< / li > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-204" > line 204< / a >
< / dt >
2013-10-25 15:54:40 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="updateCache">< span class = "type-signature" > < / span > updateCache< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > Generates and updates the cached sprite for this object.< / p >
2013-10-25 15:54:40 +00:00
< / div >
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#updateCache" > PIXI.DisplayObject#updateCache< / a >
< / li > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2014-11-25 00:23:44 +00:00
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-606" > line 606< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-25 15:54:40 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="updateCrop">< span class = "type-signature" > < / span > updateCrop< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > If you have set a crop rectangle on this Image via Image.crop and since modified the Image.cropRect property (or the rectangle it references)
then you need to update the crop frame by calling this method.< / p >
2013-10-25 15:54:40 +00:00
< / div >
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Image.html#updateCrop" > Phaser.Image#updateCrop< / a >
< / li > < / dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Image.js.html" > gameobjects/Image.js< / a > , < a href = "Image.js.html#sunlight-1-line-427" > line 427< / a >
< / dt >
2013-10-25 15:54:40 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-25 15:54:40 +00:00
< / dd >
< / dl >
< / article >
< / section >
< / div >
< div class = "clearfix" > < / div >
< footer >
< span class = "copyright" >
2014-02-05 06:29:17 +00:00
Phaser Copyright © 2012-2014 Photon Storm Ltd.
2013-10-25 15:54:40 +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 >
2015-01-06 06:57:25 +00:00
on Tue Jan 06 2015 06:32:23 GMT-0000 (GMT) using the < a href = "https://github.com/terryweiss/docstrap" > DocStrap template< / a > .
2013-10-25 15:54:40 +00:00
< / span >
< / footer >
< / div >
< div class = "span3" >
< div id = "toc" > < / div >
< / div >
< br clear = "both" >
< / div >
< / div >
< script src = "scripts/sunlight.js" > < / script >
< script src = "scripts/sunlight.javascript.js" > < / script >
< script src = "scripts/sunlight-plugin.doclinks.js" > < / script >
< script src = "scripts/sunlight-plugin.linenumbers.js" > < / script >
< script src = "scripts/sunlight-plugin.menu.js" > < / script >
< script src = "scripts/jquery.min.js" > < / script >
< script src = "scripts/jquery.scrollTo.js" > < / script >
< script src = "scripts/jquery.localScroll.js" > < / script >
< script src = "scripts/bootstrap-dropdown.js" > < / script >
< script src = "scripts/toc.js" > < / script >
< script > Sunlight . highlightAll ( { lineNumbers : true , showMenu : true , enableDoclinks : true } ) ; < / script >
< script >
$( function () {
$( "#toc" ).toc( {
2014-04-10 22:13:43 +00:00
anchorName : function(i, heading, prefix) {
2014-03-14 06:36:05 +00:00
return $(heading).attr("id") || ( prefix + i );
},
2013-10-25 15:54:40 +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 >
