2013-10-25 15:54:40 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > Phaser Class: TileSprite< / title >
<!-- [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 >
< div class = "container-fluid" >
< div class = "navbar navbar-fixed-top navbar-inverse" >
< div class = "navbar-inner" >
< a class = "brand" href = "index.html" > Phaser< / a >
< ul class = "nav" >
< li class = "dropdown" >
< a href = "namespaces.list.html" class = "dropdown-toggle" data-toggle = "dropdown" > Namespaces< b
class="caret">< / b > < / a >
< ul class = "dropdown-menu " >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-0" >
2013-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-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 >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.BitmapText.html" > BitmapText< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Button.html" > Button< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-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-2" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Easing.Back.html" > Back< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Easing.Bounce.html" > Bounce< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Easing.Circular.html" > Circular< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Easing.Cubic.html" > Cubic< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Easing.Elastic.html" > Elastic< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Easing.Exponential.html" > Exponential< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Easing.Linear.html" > Linear< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Easing.Quadratic.html" > Quadratic< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Easing.Quartic.html" > Quartic< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Easing.Quintic.html" > Quintic< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Easing.Sinusoidal.html" > Sinusoidal< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-18 03:01:51 +00:00
< a href = "Phaser.Ellipse.html" > Ellipse< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Events.html" > Events< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Filter.html" > Filter< / a >
< / li >
2014-09-09 14:36:56 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.FlexGrid.html" > FlexGrid< / a >
< / li >
< li class = "class-depth-1" >
< a href = "Phaser.FlexLayer.html" > FlexLayer< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-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 >
< / 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 >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.PrismaticConstraint.html" > PrismaticConstraint< / a >
< / 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-07 06:10:15 +00:00
< a href = "Phaser.Polygon.html" > Polygon< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.QuadTree.html" > QuadTree< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-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-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 >
< 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-15 20:01:46 +00:00
< li class = "dropdown" >
< a href = "global.html" class = "dropdown-toggle" data-toggle = "dropdown" > Global< b
class="caret">< / b > < / a >
< ul class = "dropdown-menu " >
< li class = "class-depth-0" >
< a href = "global.html#clone" > clone< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#createCustomLayer" > createCustomLayer< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#createFixedLayer" > createFixedLayer< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#createFluidLayer" > createFluidLayer< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#createFullLayer" > createFullLayer< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#debug" > debug< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#destroy" > destroy< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#onResize" > onResize< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#originalEvent" > originalEvent< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#refresh" > refresh< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#reset" > reset< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#setSize" > setSize< / a >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< / div >
< div class = "row-fluid" >
2013-10-25 15:54:40 +00:00
< div class = "span8" >
< div id = "main" >
< h1 class = "page-title" > Class: TileSprite< / h1 >
< section >
< header >
< h2 >
< span class = "ancestors" > < a href = "Phaser.html" > Phaser< / a > .< / span >
TileSprite
< / h2 >
2014-02-18 03:01:51 +00:00
< div class = "class-description" > < p > Phaser.TileSprite< / p > < / div >
2013-10-25 15:54:40 +00:00
< / header >
< article >
< div class = "container-overview" >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="TileSprite">< span class = "type-signature" > < / span > new TileSprite< span class = "signature" > (game, x, y, width, height, key, frame)< / 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-02-18 03:01:51 +00:00
< p > A TileSprite is a Sprite that has a repeating texture. The texture can be scrolled and scaled and will automatically wrap on the edges as it does so.
2014-03-14 06:36:05 +00:00
Please note that TileSprites, as with normal Sprites, have no input handler or physics bodies by default. Both need enabling.< / 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 >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > A reference to the currently running game.< / p > < / td >
2013-10-25 15:54:40 +00:00
< / tr >
< tr >
< td class = "name" > < code > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > The x coordinate (in world space) to position the TileSprite at.< / p > < / td >
2013-10-25 15:54:40 +00:00
< / tr >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > The y coordinate (in world space) to position the TileSprite at.< / p > < / td >
2013-10-25 15:54:40 +00:00
< / tr >
< tr >
< td class = "name" > < code > width< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > The width of the TileSprite.< / p > < / td >
2013-10-25 15:54:40 +00:00
< / tr >
< tr >
< td class = "name" > < code > height< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > The height of the TileSprite.< / p > < / td >
2013-10-25 15:54:40 +00:00
< / tr >
< 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 >
|
2014-02-18 03:01:51 +00:00
< span class = "param-type" > < a href = "Phaser.BitmapData.html" > Phaser.BitmapData< / a > < / span >
|
2014-11-15 20:01:46 +00:00
< span class = "param-type" > < a href = "PIXI.Texture.html" > PIXI.Texture< / a > < / span >
2013-10-25 15:54:40 +00:00
< / td >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > This is the image or texture used by the TileSprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture 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 TileSprite 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 >
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 -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-22" > line 22< / 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 >
< / div >
2014-10-09 15:12:53 +00:00
< h3 class = "subsection-title" > Extends< / h3 >
< ul >
2014-11-15 20:01:46 +00:00
< li > < a href = "PIXI.TilingSprite.html" > PIXI.TilingSprite< / a > < / li >
2014-10-09 15:12:53 +00:00
< / ul >
2013-10-25 15:54:40 +00:00
< h3 class = "subsection-title" > Members< / h3 >
< dl >
2014-09-09 14:36:56 +00:00
< 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 >
2014-09-09 14:36:56 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > A useful boolean to control if the TileSprite is alive or dead (in terms of your gameplay, it doesn't effect rendering).< / p >
< / div >
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2014-09-09 14:36:56 +00:00
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > true< / li > < / ul > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-141" > line 141< / a >
< / dt >
2014-09-09 14:36:56 +00:00
< / dl >
< / dd >
2013-10-25 15:54:40 +00:00
< 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
2014-02-18 03:01:51 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > The opacity of the object.< / p >
2014-02-18 03:01:51 +00:00
< / 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 Sprite, 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 Sprite.rotation instead. Working in radians is also a little faster as it doesn't have to convert the angle. The angle of this Sprite 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
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 = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-558" > line 558< / 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 = "tag-source" > Source -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-61" > line 61< / a >
< / dt >
2014-03-14 06:36:05 +00:00
2014-03-24 12:41:45 +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 >
2014-03-24 12:41:45 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
< div class = "description" >
< p > Should this Sprite be automatically culled if out of range of the camera?
A culled sprite has its renderable property set to 'false'.
2014-11-15 20:01:46 +00:00
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 Sprite should be automatically camera culled or not.< / p >
2014-03-24 12:41:45 +00:00
< / div >
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +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 >
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-108" > line 108< / a >
< / dt >
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="blendMode">< span class = "type-signature" > < / span > blendMode< span class = "type-signature" > :Number< / span > < / h4 >
< / dt >
< dd >
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The blend mode to be applied to the sprite< / p >
< / div >
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2014-03-24 12:41:45 +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.TilingSprite.html#blendMode" > PIXI.TilingSprite#blendMode< / a >
< / li > < / dd >
2014-03-24 12:41:45 +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 > PIXI.blendModes.NORMAL;< / li > < / ul > < / dd >
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "TilingSprite.js.html" > pixi/extras/TilingSprite.js< / a > , < a href = "TilingSprite.js.html#sunlight-1-line-77" > line 77< / a >
< / dt >
2014-03-24 12:41:45 +00:00
2014-03-14 06:36:05 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="body">< span class = "type-signature" > < / span > body< span class = "type-signature" > :< a href = "Phaser.Physics.Arcade.Body.html" > Phaser.Physics.Arcade.Body< / a > |< a href = "Phaser.Physics.P2.Body.html" > Phaser.Physics.P2.Body< / a > |< a href = "Phaser.Physics.Ninja.Body.html" > Phaser.Physics.Ninja.Body< / a > |null< / 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" >
< p > By default Sprites won't add themselves to any physics system and their physics body will be < code > null< / code > .
2014-03-28 01:42:49 +00:00
To enable them for physics you need to call < code > game.physics.enable(sprite, system)< / code > where < code > sprite< / code > is this object
2014-03-14 06:36:05 +00:00
and < code > system< / code > is the Physics system you want to use to manage this body. Once enabled you can access all physics related properties via < code > Sprite.body< / code > .< / p >
< p > Important: Enabling a Sprite for P2 or Ninja physics will automatically set < code > Sprite.anchor< / code > to 0.5 so the physics body is centered on the Sprite.
If you need a different result then adjust or re-create the Body shape offsets manually, and/or reset the anchor after enabling physics.< / p >
< / div >
2014-11-15 20:01:46 +00:00
< h5 > Type:< / h5 >
< ul >
< li >
2014-03-14 06:36:05 +00:00
< span class = "param-type" > < a href = "Phaser.Physics.Arcade.Body.html" > Phaser.Physics.Arcade.Body< / a > < / span >
|
< span class = "param-type" > < a href = "Phaser.Physics.P2.Body.html" > Phaser.Physics.P2.Body< / a > < / span >
|
< span class = "param-type" > < a href = "Phaser.Physics.Ninja.Body.html" > Phaser.Physics.Ninja.Body< / a > < / span >
|
< span class = "param-type" > null< / span >
2014-11-15 20:01:46 +00:00
< / li >
< / ul >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2014-03-14 06:36:05 +00:00
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > null< / li > < / ul > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-135" > line 135< / 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
< 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 >
2014-03-24 12:41:45 +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 >
2014-03-24 12:41:45 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > If this object is fixedToCamera then this stores the x/y offset that its drawn at, from the top-left of the camera view.< / p >
2014-03-24 12:41:45 +00:00
< / div >
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-122" > line 122< / a >
< / dt >
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="checkWorldBounds">< span class = "type-signature" > < / span > checkWorldBounds< span class = "type-signature" > :boolean< / span > < / h4 >
< / dt >
< dd >
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > If true the Sprite checks if it is still within the world each frame, when it leaves the world it dispatches Sprite.events.onOutOfBounds
and optionally kills the sprite (if Sprite.outOfBoundsKill is true). By default this is disabled because the Sprite has to calculate its
bounds every frame to support it, and not all games need it. Enable it by setting the value to true.< / p >
< / div >
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2014-03-24 12:41:45 +00:00
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > false< / li > < / ul > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-117" > line 117< / a >
< / dt >
2013-10-25 15:54:40 +00:00
2014-04-29 14:39:02 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="children">< span class = "type-signature" > < readonly> < / span > children< span class = "type-signature" > :Array.< DisplayObject>< / span > < / h4 >
2014-04-29 14:39:02 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +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 >
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > Array.< DisplayObject>< / span >
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
< / li >
< / ul >
< dl class = "details" >
< 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 >
< 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 >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="defaultCursor">< span class = "type-signature" > < / span > defaultCursor< span class = "type-signature" > :String< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true< / 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#defaultCursor" > PIXI.DisplayObject#defaultCursor< / 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-143" > line 143< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="destroyPhase">< span class = "type-signature" > < / span > destroyPhase< span class = "type-signature" > :boolean< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > True if this object is currently being destroyed.< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-797" > line 797< / a >
< / dt >
< / dl >
< / dd >
< 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 >
< div class = "description" >
< p > The Events you can subscribe to that are dispatched when certain things happen on this Sprite or its components.< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-56" > line 56< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="exists">< span class = "type-signature" > < / span > exists< span class = "type-signature" > :boolean< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > TileSprite.exists controls if the core game loop and physics update this TileSprite or not.
When you set TileSprite.exists to false it will remove its Body from the physics world (if it has one) and also set TileSprite.visible to false.
Setting TileSprite.exists to true will re-add the Body to the physics world (if it has a body) and set TileSprite.visible to true. If the TileSprite is processed by the core game update and physics.< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-655" > line 655< / a >
< / dt >
< / dl >
< / dd >
< 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 >
< 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 >
< dl class = "details" >
< 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 >
< 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 >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="filters">< span class = "type-signature" > < / span > filters< span class = "type-signature" > :Array.< Filter>< / span > < / h4 >
< / dt >
< dd >
< 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" > :boolean< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > An TileSprite that is fixed to the camera uses its x/y coordinates as offsets from the top left of the camera. These are stored in TileSprite.cameraOffset.
Note that the cameraOffset values are in addition to any parent in the display list.
So if this TileSprite was in a Group that has x: 200, then this will be added to the cameraOffset.x Set to true to fix this TileSprite to the Camera at its current world coordinates.< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-624" > line 624< / a >
< / 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 Cache for display.< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-582" > line 582< / 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 name and updates the Texture Cache for display.< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-603" > line 603< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="game">< span class = "type-signature" > < / span > game< span class = "type-signature" > :< a href = "Phaser.Game.html" > Phaser.Game< / a > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > A reference to the currently running Game.< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-34" > line 34< / a >
< / 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 tiling sprite< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.TilingSprite.html#height" > PIXI.TilingSprite#height< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "TilingSprite.js.html" > pixi/extras/TilingSprite.js< / a > , < a href = "TilingSprite.js.html#sunlight-1-line-27" > line 27< / a >
< / 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 TilingSprite, 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.TilingSprite.html#height" > PIXI.TilingSprite#height< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "TilingSprite.js.html" > pixi/extras/TilingSprite.js< / a > , < a href = "TilingSprite.js.html#sunlight-1-line-111" > line 111< / 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="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 = "tag-source" > Source -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-93" > line 93< / 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 a TileSprite 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 = "tag-source" > Source -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-702" > line 702< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="interactive">< span class = "type-signature" > < / span > interactive< span class = "type-signature" > :Boolean< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Indicates if the sprite will have touch and mouse interactivity. It is false by default< / 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#interactive" > PIXI.DisplayObject#interactive< / a >
< / li > < / dd >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > false< / li > < / ul > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-339" > line 339< / 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 Sprite 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 = "tag-source" > Source -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-66" > line 66< / a >
< / 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 user defined name given to this Sprite.< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-40" > line 40< / a >
< / 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="renderable">< span class = "type-signature" > < / span > renderable< span class = "type-signature" > :Boolean< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Whether this sprite is renderable or not< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.TilingSprite.html#renderable" > PIXI.TilingSprite#renderable< / a >
< / li > < / dd >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > true< / li > < / ul > < / dd >
< dt class = "tag-source" > Source -
< a href = "TilingSprite.js.html" > pixi/extras/TilingSprite.js< / a > , < a href = "TilingSprite.js.html#sunlight-1-line-59" > line 59< / a >
< / 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="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="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" > < / span > texture< span class = "type-signature" > :< a href = "PIXI.Texture.html" > PIXI.Texture< / a > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The texture that the sprite is using< / 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#texture" > PIXI.Sprite#texture< / 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-33" > line 33< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="tilePosition">< span class = "type-signature" > < / span > tilePosition< span class = "type-signature" > :< a href = "PIXI.Point.html" > PIXI.Point< / a > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The offset position of the image that is being tiled< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.TilingSprite.html#tilePosition" > PIXI.TilingSprite#tilePosition< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "TilingSprite.js.html" > pixi/extras/TilingSprite.js< / a > , < a href = "TilingSprite.js.html#sunlight-1-line-51" > line 51< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="tileScale">< span class = "type-signature" > < / span > tileScale< span class = "type-signature" > :< a href = "PIXI.Point.html" > PIXI.Point< / a > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The scaling of the image that is being tiled< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.TilingSprite.html#tileScale" > PIXI.TilingSprite#tileScale< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "TilingSprite.js.html" > pixi/extras/TilingSprite.js< / a > , < a href = "TilingSprite.js.html#sunlight-1-line-35" > line 35< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="tileScaleOffset">< span class = "type-signature" > < / span > tileScaleOffset< span class = "type-signature" > :< a href = "PIXI.Point.html" > PIXI.Point< / a > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > A point that represents the scale of the texture object< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.TilingSprite.html#tileScaleOffset" > PIXI.TilingSprite#tileScaleOffset< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "TilingSprite.js.html" > pixi/extras/TilingSprite.js< / a > , < a href = "TilingSprite.js.html#sunlight-1-line-43" > line 43< / a >
< / 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< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.TilingSprite.html#tint" > PIXI.TilingSprite#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 = "TilingSprite.js.html" > pixi/extras/TilingSprite.js< / a > , < a href = "TilingSprite.js.html#sunlight-1-line-68" > line 68< / 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" > < 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 = "tag-source" > Source -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-46" > line 46< / a >
< / 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 with of the tiling sprite< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.TilingSprite.html#width" > PIXI.TilingSprite#width< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "TilingSprite.js.html" > pixi/extras/TilingSprite.js< / a > , < a href = "TilingSprite.js.html#sunlight-1-line-19" > line 19< / 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.TilingSprite.html#width" > PIXI.TilingSprite#width< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "TilingSprite.js.html" > pixi/extras/TilingSprite.js< / a > , < a href = "TilingSprite.js.html#sunlight-1-line-95" > line 95< / 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 Sprite. This differs from the x/y coordinates which are relative to the Sprites container.< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-98" > line 98< / 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 TileSprite on the x axis relative to the local coordinates of the parent.< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-743" > line 743< / a >
< / 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 TileSprite on the y axis relative to the local coordinates of the parent.< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-770" > line 770< / a >
< / 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 = "tag-source" > Source -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-51" > line 51< / a >
< / dt >
< / dl >
< / dd >
< / dl >
< h3 class = "subsection-title" > Methods< / h3 >
< dl >
< 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="autoScroll">< span class = "type-signature" > < / span > autoScroll< span class = "signature" > (x, y)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Sets this TileSprite to automatically scroll in the given direction until stopped via TileSprite.stopScroll().
The scroll speed is specified in pixels per second.
A negative x value will scroll to the left. A positive x value will scroll to the right.
A negative y value will scroll up. A positive y value will scroll down.< / 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 > Horizontal scroll speed in pixels per second.< / 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 > Vertical scroll speed in pixels per second.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-304" > line 304< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="click">< span class = "type-signature" > < / span > click< span class = "signature" > (interactionData)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > A callback that is used when the users clicks on the displayObject with their mouse's left button< / 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 > interactionData< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "PIXI.InteractionData.html" > PIXI.InteractionData< / a > < / span >
< / td >
< td class = "description last" > < p > -< / 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 = "PIXI.DisplayObject.html#click" > PIXI.DisplayObject#click< / 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-252" > line 252< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="destroy">< span class = "type-signature" > < / span > destroy< span class = "signature" > (< span class = "optional" > destroyChildren< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Destroys the TileSprite. This removes it from its parent group, destroys the event and animation handlers if present
and nulls its reference to game, freeing it up for garbage collection.< / 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 > destroyChildren< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
true
< / td >
< td class = "description last" > < p > Should every child of this object have its destroy method called?< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-433" > line 433< / 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 -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-583" > line 583< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="generateTilingTexture">< span class = "type-signature" > < / span > generateTilingTexture< span class = "signature" > (forcePowerOfTwo)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< 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 > forcePowerOfTwo< / code > < / td >
< td class = "type" >
< span class = "param-type" > Boolean< / span >
< / td >
< td class = "description last" > < p > Whether we want to force the texture to be a power of two< / 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 = "PIXI.TilingSprite.html#generateTilingTexture" > PIXI.TilingSprite#generateTilingTexture< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "TilingSprite.js.html" > pixi/extras/TilingSprite.js< / a > , < a href = "TilingSprite.js.html#sunlight-1-line-373" > line 373< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="getBounds">< span class = "type-signature" > < / span > getBounds< span class = "signature" > ()< / span > < span class = "type-signature" > → {< a href = "PIXI.Rectangle.html" > PIXI.Rectangle< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Returns the framing rectangle of the sprite as a PIXI.Rectangle object< / 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 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.TilingSprite.html#getBounds" > PIXI.TilingSprite#getBounds< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "TilingSprite.js.html" > pixi/extras/TilingSprite.js< / a > , < a href = "TilingSprite.js.html#sunlight-1-line-280" > line 280< / 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="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 TileSprite 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 TileSprite 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 TileSprite 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 = "tag-source" > Source -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-333" > line 333< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="mousedown">< span class = "type-signature" > < / span > mousedown< span class = "signature" > (interactionData)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > A callback that is used when the user clicks the mouse's left button down over the sprite< / 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 > interactionData< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "PIXI.InteractionData.html" > PIXI.InteractionData< / a > < / span >
< / td >
< td class = "description last" > < p > -< / 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 = "PIXI.DisplayObject.html#mousedown" > PIXI.DisplayObject#mousedown< / 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-258" > line 258< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="mouseout">< span class = "type-signature" > < / span > mouseout< span class = "signature" > (interactionData)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > A callback that is used when the users mouse leaves the displayObject< / 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 > interactionData< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "PIXI.InteractionData.html" > PIXI.InteractionData< / a > < / span >
< / td >
< td class = "description last" > < p > -< / 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 = "PIXI.DisplayObject.html#mouseout" > PIXI.DisplayObject#mouseout< / 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-245" > line 245< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="mouseover">< span class = "type-signature" > < / span > mouseover< span class = "signature" > (interactionData)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > A callback that is used when the users mouse rolls over the displayObject< / 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 > interactionData< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "PIXI.InteractionData.html" > PIXI.InteractionData< / a > < / span >
< / td >
< td class = "description last" > < p > -< / 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 = "PIXI.DisplayObject.html#mouseover" > PIXI.DisplayObject#mouseover< / 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-239" > line 239< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="mouseup">< span class = "type-signature" > < / span > mouseup< span class = "signature" > (interactionData)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > A callback that is used when the user releases the mouse's left button that was over the displayObject
for this callback to be fired, the mouse's left button must have been pressed down over the displayObject< / 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 > interactionData< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "PIXI.InteractionData.html" > PIXI.InteractionData< / a > < / span >
< / td >
< td class = "description last" > < p > -< / 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 = "PIXI.DisplayObject.html#mouseup" > PIXI.DisplayObject#mouseup< / 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-264" > line 264< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="mouseupoutside">< span class = "type-signature" > < / span > mouseupoutside< span class = "signature" > (interactionData)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject
for this callback to be fired, the mouse's left button must have been pressed down over the displayObject< / 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 > interactionData< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "PIXI.InteractionData.html" > PIXI.InteractionData< / a > < / span >
< / td >
< td class = "description last" > < p > -< / 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 = "PIXI.DisplayObject.html#mouseupoutside" > PIXI.DisplayObject#mouseupoutside< / 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-271" > line 271< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="play">< span class = "type-signature" > < / span > play< span class = "signature" > (name, < span class = "optional" > frameRate< / span > , < span class = "optional" > loop< / span > , < span class = "optional" > killOnComplete< / span > )< / span > < span class = "type-signature" > → {< a href = "Phaser.Animation.html" > Phaser.Animation< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Play an animation based on the given key. The animation should previously have been added via sprite.animations.add()
If the requested animation is already playing this request will be ignored. If you need to reset an already running animation do so directly on the Animation object itself.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
2014-04-29 14:39:02 +00:00
< thead >
< tr >
< th > Name< / th >
2014-11-15 20:01:46 +00:00
< th > Type< / th >
< th > Argument< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > The name of the animation to be played, e.g. " fire" , " walk" , " jump" .< / p > < / td >
< / tr >
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
< tr >
< td class = "name" > < code > frameRate< / code > < / td >
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
null
< / td >
< td class = "description last" > < p > The framerate to play the animation at. The speed is given in frames per second. If not provided the previously set frameRate of the Animation is used.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > loop< / 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 > Should the animation be looped after playback. If not provided the previously set loop value of the Animation is used.< / p > < / td >
< / tr >
2014-04-29 14:39:02 +00:00
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > killOnComplete< / code > < / td >
2014-04-29 14:39:02 +00:00
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
2014-11-15 20:01:46 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
< td class = "default" >
false
< / td >
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > If set to true when the animation completes (only happens if loop=false) the parent Sprite will be killed.< / p > < / td >
2014-04-29 14:39:02 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > < a href = "Phaser.Animation.html" > Phaser.Animation< / a > < / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > A reference to playing Animation instance.< / p >
< / div >
< / div >
< dl class = "details" >
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-504" > line 504< / a >
< / dt >
2014-04-29 14:39:02 +00:00
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="postUpdate">< span class = "type-signature" > < / span > postUpdate< 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
< div class = "description" >
< p > Internal function called by the World postUpdate cycle.< / p >
< / 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
< 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 -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-276" > line 276< / 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="preUpdate">< span class = "type-signature" > < / span > preUpdate< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
2013-10-25 15:54:40 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Automatically called by World.preUpdate.< / p >
< / 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 -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-166" > line 166< / a >
< / 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 "
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-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-11-15 20:01:46 +00:00
< p > Removes a child from the container.< / p >
2014-03-14 06:36:05 +00:00
< / div >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< h5 > Parameters:< / h5 >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< table class = "params table table-striped" >
2014-03-14 06:36:05 +00:00
< 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 > child< / 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" > < 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
< td class = "description last" > < p > The DisplayObject to remove< / p > < / td >
2014-03-14 06:36:05 +00:00
< / tr >
2014-11-15 20:01:46 +00:00
< / 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 removed.< / p >
< / div >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< / div >
< dl class = "details" >
2014-03-14 06:36:05 +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#removeChild" > PIXI.DisplayObjectContainer#removeChild< / a >
< / li > < / dd >
2014-03-14 06:36:05 +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-210" > line 210< / 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 >
2013-11-28 15:57:09 +00:00
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
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 >
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-11-15 20:01:46 +00:00
< p > Removes a child from the specified index position.< / p >
2013-11-28 15:57:09 +00:00
< / div >
2014-11-15 20:01:46 +00:00
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" >
2013-11-28 15:57:09 +00:00
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > index< / 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" > Number< / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The index to get the child from< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +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 >
< dl class = "details" >
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 >
< a href = "PIXI.DisplayObjectContainer.html#removeChildAt" > PIXI.DisplayObjectContainer#removeChildAt< / a >
< / li > < / dd >
2013-11-28 15:57:09 +00:00
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 = "tag-source" > Source -
< a href = "DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "DisplayObjectContainer.js.html#sunlight-1-line-225" > line 225< / a >
< / 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 "
id="removeChildren">< span class = "type-signature" > < / span > removeChildren< span class = "signature" > (beginIndex, endIndex)< / 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
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Removes all children from this container that are within the begin and end indexes.< / p >
< / 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" >
2013-11-28 15:57:09 +00:00
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > beginIndex< / 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" > Number< / span >
< / td >
< 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 >
2013-11-28 15:57:09 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The ending position. Default value is size of the container.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
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 = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObjectContainer.html#removeChildren" > PIXI.DisplayObjectContainer#removeChildren< / a >
< / li > < / dd >
2013-11-28 15:57:09 +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-243" > line 243< / a >
< / 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 "
id="removeStageReference">< span class = "type-signature" > < / span > removeStageReference< span class = "signature" > ()< / 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
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Removes the current stage reference from the container and all of its children.< / p >
< / div >
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
< dl class = "details" >
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 = "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 >
2013-11-28 15:57:09 +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-404" > line 404< / a >
< / dt >
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
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="reset">< span class = "type-signature" > < / span > reset< span class = "signature" > (x, y)< / 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
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Resets the TileSprite. This places the TileSprite at the given x/y world coordinates, resets the tilePosition and then
sets alive, exists, visible and renderable all to true. Also resets the outOfBounds state.
If the TileSprite has a physics body that too is reset.< / p >
< / 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" >
2013-11-28 15:57:09 +00:00
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > x< / 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" > number< / span >
< / td >
< td class = "description last" > < p > The x coordinate (in world space) to position the Sprite at.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The y coordinate (in world space) to position the Sprite at.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-desc param-desc" >
< p > (Phaser.TileSprite) This instance.< / p >
< / div >
< / div >
< dl class = "details" >
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-522" > line 522< / a >
< / dt >
2013-11-28 15:57:09 +00:00
2014-02-24 12:14:30 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-02-24 12:14:30 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="rightclick">< span class = "type-signature" > < / span > rightclick< span class = "signature" > (interactionData)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-02-24 12:14:30 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-02-24 12:14:30 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > A callback that is used when the users clicks on the displayObject with their mouse's right button< / p >
< / div >
2014-02-24 12:14:30 +00:00
2014-11-15 20:01:46 +00:00
< h5 > Parameters:< / h5 >
2014-02-24 12:14:30 +00:00
2014-11-15 20:01:46 +00:00
< table class = "params table table-striped" >
2014-02-24 12:14:30 +00:00
< 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 > interactionData< / code > < / td >
2014-02-24 12:14:30 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > < a href = "PIXI.InteractionData.html" > PIXI.InteractionData< / a > < / span >
2014-02-24 12:14:30 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > -< / p > < / td >
2014-02-24 12:14:30 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2014-02-24 12:14:30 +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#rightclick" > PIXI.DisplayObject#rightclick< / a >
< / li > < / dd >
2014-02-24 12:14:30 +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-279" > line 279< / a >
< / dt >
2014-02-24 12:14:30 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-02-24 12:14:30 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="rightdown">< span class = "type-signature" > < / span > rightdown< span class = "signature" > (interactionData)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-02-24 12:14:30 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-02-24 12:14:30 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > A callback that is used when the user clicks the mouse's right button down over the sprite< / p >
2014-02-24 12:14:30 +00:00
< / div >
2014-11-15 20:01:46 +00:00
2014-02-24 12:14:30 +00:00
2014-11-15 20:01:46 +00:00
< h5 > Parameters:< / h5 >
2014-02-24 12:14:30 +00:00
2014-11-15 20:01:46 +00:00
< table class = "params table table-striped" >
2014-02-24 12:14:30 +00:00
< 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 > interactionData< / code > < / td >
2014-02-24 12:14:30 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > < a href = "PIXI.InteractionData.html" > PIXI.InteractionData< / a > < / span >
2014-02-24 12:14:30 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > -< / p > < / td >
2014-02-24 12:14:30 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2014-02-24 12:14:30 +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#rightdown" > PIXI.DisplayObject#rightdown< / a >
< / li > < / dd >
2014-02-24 12:14:30 +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-285" > line 285< / a >
< / dt >
2014-02-24 12:14:30 +00:00
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 "
id="rightup">< span class = "type-signature" > < / span > rightup< span class = "signature" > (interactionData)< / 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
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > A callback that is used when the user releases the mouse's right button that was over the displayObject
for this callback to be fired the mouse's right button must have been pressed down over the displayObject< / p >
< / 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" >
2013-11-28 15:57:09 +00:00
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > interactionData< / 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" > < a href = "PIXI.InteractionData.html" > PIXI.InteractionData< / a > < / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > -< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
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 = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#rightup" > PIXI.DisplayObject#rightup< / a >
< / li > < / dd >
2013-11-28 15:57:09 +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-291" > line 291< / a >
< / 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 "
id="rightupoutside">< span class = "type-signature" > < / span > rightupoutside< span class = "signature" > (interactionData)< / 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
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject
for this callback to be fired, the mouse's right button must have been pressed down over the displayObject< / p >
< / 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" >
2013-11-28 15:57:09 +00:00
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > interactionData< / 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" > < a href = "PIXI.InteractionData.html" > PIXI.InteractionData< / a > < / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > -< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
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 = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#rightupoutside" > PIXI.DisplayObject#rightupoutside< / a >
< / li > < / dd >
2013-11-28 15:57:09 +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-298" > line 298< / a >
< / 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 "
id="setChildIndex">< span class = "type-signature" > < / span > setChildIndex< span class = "signature" > (child, index)< / 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
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Changes the position of an existing child in the display object container< / p >
< / 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" >
2013-11-28 15:57:09 +00:00
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > child< / 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" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
< / td >
< 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 >
2013-11-28 15:57:09 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The resulting index number for the child display object< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
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 = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObjectContainer.html#setChildIndex" > PIXI.DisplayObjectContainer#setChildIndex< / a >
< / li > < / dd >
2013-11-28 15:57:09 +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-175" > line 175< / a >
< / 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 "
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
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Sets the Texture frame the TileSprite uses for rendering.
This is primarily an internal method used by TileSprite.loadTexture, although you may call it directly.< / p >
< / 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" >
2013-11-28 15:57:09 +00:00
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > frame< / 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" > < a href = "Phaser.Frame.html" > Phaser.Frame< / a > < / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The Frame to be used by the TileSprite texture.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
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 -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-385" > line 385< / a >
< / dt >
2014-03-14 06:36:05 +00:00
2014-03-28 01:42:49 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-03-28 01:42:49 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="setStageReference">< span class = "type-signature" > < / span > setStageReference< span class = "signature" > (stage)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-03-28 01:42:49 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-03-28 01:42:49 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.< / p >
2014-03-28 01:42:49 +00:00
< / div >
2014-11-15 20:01:46 +00:00
2014-03-28 01:42:49 +00:00
2014-11-15 20:01:46 +00:00
< h5 > Parameters:< / h5 >
2014-03-28 01:42:49 +00:00
2014-11-15 20:01:46 +00:00
< table class = "params table table-striped" >
2014-03-28 01:42:49 +00:00
< 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 > stage< / code > < / td >
2014-03-28 01:42:49 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > < a href = "PIXI.Stage.html" > PIXI.Stage< / a > < / span >
2014-03-28 01:42:49 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > the stage that the container will have as its current stage reference< / p > < / td >
2014-03-28 01:42:49 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2014-03-28 01:42:49 +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#setStageReference" > PIXI.DisplayObjectContainer#setStageReference< / a >
< / li > < / dd >
2014-03-28 01:42:49 +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-386" > line 386< / a >
< / dt >
2014-03-28 01:42:49 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-03-28 01:42:49 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="setTexture">< span class = "type-signature" > < / span > setTexture< span class = "signature" > (texture)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-03-28 01:42:49 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-03-28 01:42:49 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > Sets the texture of the sprite< / p >
2014-03-28 01:42:49 +00:00
< / div >
2014-11-15 20:01:46 +00:00
2014-03-28 01:42:49 +00:00
2014-11-15 20:01:46 +00:00
< h5 > Parameters:< / h5 >
2014-03-28 01:42:49 +00:00
2014-11-15 20:01:46 +00:00
< table class = "params table table-striped" >
2014-03-28 01:42:49 +00:00
< 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 > texture< / code > < / td >
2014-03-28 01:42:49 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > < a href = "PIXI.Texture.html" > PIXI.Texture< / a > < / span >
2014-03-28 01:42:49 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The PIXI texture that is displayed by the sprite< / p > < / td >
2014-03-28 01:42:49 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2014-03-28 01:42:49 +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#setTexture" > PIXI.Sprite#setTexture< / a >
< / li > < / dd >
2014-03-28 01:42:49 +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-135" > line 135< / a >
< / dt >
2014-03-28 01:42:49 +00:00
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 "
id="stopScroll">< span class = "type-signature" > < / span > stopScroll< span class = "signature" > ()< / 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
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Stops an automatically scrolling TileSprite.< / p >
< / div >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-321" > line 321< / a >
< / dt >
2013-11-28 15:57:09 +00:00
< / dl >
2014-02-18 03:01:51 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2014-02-18 03:01:51 +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 "
id="swapChildren">< span class = "type-signature" > < / span > swapChildren< span class = "signature" > (child, child2)< / 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
2014-02-18 03:01:51 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > Swaps the position of 2 Display Objects within this container.< / p >
2014-02-18 03:01:51 +00:00
< / div >
2013-11-28 15:57:09 +00:00
2014-02-18 03:01:51 +00:00
2014-09-09 14:36:56 +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-11-15 20:01:46 +00:00
< td class = "name" > < code > child< / code > < / td >
2014-09-09 14:36:56 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
2014-09-09 14:36:56 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > -< / p > < / td >
2014-09-09 14:36:56 +00:00
< / tr >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > child2< / code > < / td >
2014-09-09 14:36:56 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
2014-09-09 14:36:56 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > -< / p > < / td >
2014-09-09 14:36:56 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2014-02-18 03:01:51 +00:00
< dl class = "details" >
2013-11-28 15:57:09 +00:00
2014-02-18 03:01:51 +00:00
2013-11-28 15:57:09 +00:00
2014-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#swapChildren" > PIXI.DisplayObjectContainer#swapChildren< / a >
< / li > < / dd >
2013-11-28 15:57:09 +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-133" > line 133< / a >
< / dt >
2013-11-28 15:57:09 +00:00
< / dl >
2014-02-18 03:01:51 +00:00
2014-11-15 20:01:46 +00:00
2014-02-18 03:01:51 +00:00
2013-11-28 15:57:09 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="tap">< span class = "type-signature" > < / span > tap< span class = "signature" > (interactionData)< / 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
2014-02-18 03:01:51 +00:00
2014-02-08 07:24:22 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > A callback that is used when the users taps on the sprite with their finger
basically a touch version of click< / p >
2014-02-08 07:24:22 +00:00
< / div >
2014-02-18 03:01:51 +00:00
2013-11-28 15:57:09 +00:00
2014-03-14 06:36:05 +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-11-15 20:01:46 +00:00
< td class = "name" > < code > interactionData< / 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" > < a href = "PIXI.InteractionData.html" > PIXI.InteractionData< / a > < / span >
2014-03-14 06:36:05 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > -< / p > < / td >
2014-03-14 06:36:05 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
< dl class = "details" >
2014-02-18 03:01:51 +00:00
2013-11-28 15:57:09 +00:00
2014-02-18 03:01:51 +00:00
2013-11-28 15:57:09 +00:00
2014-02-18 03:01:51 +00:00
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#tap" > PIXI.DisplayObject#tap< / a >
< / li > < / dd >
2013-11-28 15:57:09 +00:00
2014-02-18 03:01:51 +00:00
2013-11-28 15:57:09 +00:00
2014-02-18 03:01:51 +00:00
2013-11-28 15:57:09 +00:00
2014-02-18 03:01:51 +00:00
2013-11-28 15:57:09 +00:00
2014-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-309" > line 309< / a >
< / dt >
2014-02-08 07:24:22 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-02-08 07:24:22 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
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 >
2014-02-08 07:24:22 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-02-08 07:24:22 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > Calculates the global position of the display object< / p >
2014-02-08 07:24:22 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > position< / code > < / td >
2014-02-08 07:24:22 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > < a href = "PIXI.Point.html" > PIXI.Point< / a > < / span >
2014-02-08 07:24:22 +00:00
< / td >
2014-02-18 03:01:51 +00:00
2014-02-08 07:24:22 +00:00
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The world origin to calculate from< / p > < / td >
2014-02-18 03:01:51 +00:00
< / tr >
2014-11-15 20:01:46 +00:00
< / tbody >
< / table >
2014-02-18 03:01:51 +00:00
2014-11-15 20:01:46 +00:00
2014-02-18 03:01:51 +00:00
2014-11-15 20:01:46 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
2014-02-08 07:24:22 +00:00
2014-11-15 20:01:46 +00:00
< div class = "returns-type" >
< span class = "param-type" > < a href = "PIXI.Point.html" > PIXI.Point< / a > < / span >
2014-02-08 07:24:22 +00:00
2014-11-15 20:01:46 +00:00
-
< / div >
< div class = "returns-desc param-desc" >
< p > A point object representing the position of this object< / p >
< / div >
2014-02-08 07:24:22 +00:00
2014-11-15 20:01:46 +00:00
< / div >
2014-02-08 07:24:22 +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#toGlobal" > PIXI.DisplayObject#toGlobal< / a >
< / li > < / dd >
2014-02-08 07:24:22 +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-617" > line 617< / a >
< / 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 "
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-11-28 15:57:09 +00:00
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" >
< p > Calculates the local position of the display object relative to another point< / p >
< / 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 >
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< th > Type< / th >
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< th > Argument< / th >
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
2014-02-18 03:01:51 +00:00
2014-11-15 20:01:46 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2014-02-18 03:01:51 +00:00
2014-11-15 20:01:46 +00:00
< tbody >
2014-02-18 03:01:51 +00:00
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > position< / code > < / td >
2014-02-18 03:01:51 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > < a href = "PIXI.Point.html" > PIXI.Point< / a > < / span >
2014-02-18 03:01:51 +00:00
< / td >
< td class = "attributes" >
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The world origin to calculate from< / p > < / td >
2014-02-18 03:01:51 +00:00
< / tr >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > from< / code > < / td >
2014-02-18 03:01:51 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
2014-02-18 03:01:51 +00:00
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The DisplayObject to calculate the global position from< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +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" >
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#toLocal" > PIXI.DisplayObject#toLocal< / a >
< / li > < / dd >
2013-11-28 15:57:09 +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-631" > line 631< / a >
< / 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 "
id="touchend">< span class = "type-signature" > < / span > touchend< span class = "signature" > (interactionData)< / 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-11-15 20:01:46 +00:00
< p > A callback that is used when the user releases a touch over the displayObject< / p >
2013-11-28 15:57:09 +00:00
< / div >
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 >
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< th > Type< / th >
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
< th class = "last" > Description< / th >
< / tr >
< / thead >
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< tbody >
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< tr >
< td class = "name" > < code > interactionData< / code > < / td >
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< td class = "type" >
< span class = "param-type" > < a href = "PIXI.InteractionData.html" > PIXI.InteractionData< / a > < / span >
2013-11-28 15:57:09 +00:00
2014-11-15 20:01:46 +00:00
< / td >
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
< td class = "description last" > < p > -< / p > < / td >
< / tr >
2013-11-28 15:57:09 +00:00
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 >
< a href = "PIXI.DisplayObject.html#touchend" > PIXI.DisplayObject#touchend< / a >
< / li > < / dd >
2013-11-28 15:57:09 +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-322" > line 322< / a >
< / dt >
2014-03-24 12:41:45 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="touchendoutside">< span class = "type-signature" > < / span > touchendoutside< span class = "signature" > (interactionData)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-03-24 12:41:45 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > A callback that is used when the user releases the touch that was over the displayObject
for this callback to be fired, The touch must have started over the sprite< / p >
2014-03-24 12:41:45 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > interactionData< / code > < / td >
2014-03-24 12:41:45 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > < a href = "PIXI.InteractionData.html" > PIXI.InteractionData< / a > < / span >
2014-03-24 12:41:45 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > -< / p > < / td >
2014-03-24 12:41:45 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +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#touchendoutside" > PIXI.DisplayObject#touchendoutside< / a >
< / li > < / dd >
2014-03-24 12:41:45 +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-328" > line 328< / a >
< / 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
2014-07-10 19:31:11 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="touchstart">< span class = "type-signature" > < / span > touchstart< span class = "signature" > (interactionData)< / span > < span class = "type-signature" > < / 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
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > A callback that is used when the user touches over the displayObject< / p >
2014-07-10 19:31:11 +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-11-15 20:01:46 +00:00
< td class = "name" > < code > interactionData< / code > < / td >
2014-07-10 19:31:11 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > < a href = "PIXI.InteractionData.html" > PIXI.InteractionData< / a > < / span >
2014-07-10 19:31:11 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > -< / p > < / td >
2014-07-10 19:31:11 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2014-07-10 19:31:11 +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#touchstart" > PIXI.DisplayObject#touchstart< / a >
< / li > < / dd >
2014-07-10 19:31:11 +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-316" > line 316< / a >
< / dt >
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
2013-11-28 15:57:09 +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-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-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-11-28 15:57:09 +00:00
< / div >
2014-11-15 20:01:46 +00:00
2013-11-28 15:57:09 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "TileSprite.js.html" > gameobjects/TileSprite.js< / a > , < a href = "TileSprite.js.html#sunlight-1-line-266" > line 266< / a >
< / 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 "
id="updateCache">< span class = "type-signature" > < / span > updateCache< span class = "signature" > ()< / 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-11-15 20:01:46 +00:00
< p > Generates and updates the cached sprite for this object.< / p >
2013-11-28 15:57:09 +00:00
< / div >
2014-11-15 20:01:46 +00:00
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 >
< a href = "PIXI.DisplayObject.html#updateCache" > PIXI.DisplayObject#updateCache< / a >
< / li > < / dd >
2013-11-28 15:57:09 +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-607" > line 607< / a >
< / 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 >
< / dl >
2013-10-25 15:54:40 +00:00
< / 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 >
2014-11-15 20:01:46 +00:00
on Sat Nov 15 2014 19:55:03 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 >