Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-12-24 12:03:36 +00:00
Code Issues Projects Releases Packages Wiki Activity
phaser/docs/Phaser.TileSprite.html
photonstorm 4b22f48c75 2.4.2 release.
2015-07-29 15:01:04 +01:00

12220 lines
No EOL
211 KiB
HTML
Raw Blame History

<!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]-->
<link type="text/css" rel="stylesheet" href="styles/default.css">
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
<div style="position: absolute; width: 143px; height: 31px; right: 10px; top: 10px; z-index: 1050"><a href="http://phaser.io"><img src="img/phaser.png" border="0" /></a></div>
<div class="navbar-inner">
<a class="brand" href="index.html">Phaser API</a>
<ul class="nav">
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-0">
<a href="Phaser.html">Phaser</a>
</li>
<li class="class-depth-0">
<a href="PIXI.html">PIXI</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1">
<a href="Phaser.Animation.html">Animation</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AnimationManager.html">AnimationManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AnimationParser.html">AnimationParser</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ArraySet.html">ArraySet</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ArrayUtils.html">ArrayUtils</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Button.html">Button</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Cache.html">Cache</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Camera.html">Camera</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Canvas.html">Canvas</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Circle.html">Circle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Color.html">Color</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Angle.html">Angle</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Animation.html">Animation</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.AutoCull.html">AutoCull</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Bounds.html">Bounds</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.BringToTop.html">BringToTop</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Core.html">Core</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Crop.html">Crop</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Delta.html">Delta</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Destroy.html">Destroy</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.FixedToCamera.html">FixedToCamera</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Health.html">Health</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.InCamera.html">InCamera</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.InputEnabled.html">InputEnabled</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.InWorld.html">InWorld</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.LifeSpan.html">LifeSpan</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.LoadTexture.html">LoadTexture</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Overlap.html">Overlap</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.PhysicsBody.html">PhysicsBody</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Reset.html">Reset</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.ScaleMinMax.html">ScaleMinMax</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Smoothed.html">Smoothed</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Create.html">Create</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Creature.html">Creature</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Device.html">Device</a>
</li>
<li class="class-depth-1">
<a href="Phaser.DeviceButton.html">DeviceButton</a>
</li>
<li class="class-depth-1">
<a href="Phaser.DOM.html">DOM</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Easing.html">Easing</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Back.html">Back</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Bounce.html">Bounce</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Circular.html">Circular</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Cubic.html">Cubic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Elastic.html">Elastic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Exponential.html">Exponential</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Linear.html">Linear</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quadratic.html">Quadratic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quartic.html">Quartic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quintic.html">Quintic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Ellipse.html">Ellipse</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Events.html">Events</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Filter.html">Filter</a>
</li>
<li class="class-depth-1">
<a href="Phaser.FlexGrid.html">FlexGrid</a>
</li>
<li class="class-depth-1">
<a href="Phaser.FlexLayer.html">FlexLayer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Frame.html">Frame</a>
</li>
<li class="class-depth-1">
<a href="Phaser.FrameData.html">FrameData</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Game.html">Game</a>
</li>
<li class="class-depth-1">
<a href="Phaser.GameObjectCreator.html">GameObjectCreator</a>
</li>
<li class="class-depth-1">
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Gamepad.html">Gamepad</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Graphics.html">Graphics</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Group.html">Group</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Image.html">Image</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ImageCollection.html">ImageCollection</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Input.html">Input</a>
</li>
<li class="class-depth-1">
<a href="Phaser.InputHandler.html">InputHandler</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Key.html">Key</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Keyboard.html">Keyboard</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Line.html">Line</a>
</li>
<li class="class-depth-1">
<a href="Phaser.LinkedList.html">LinkedList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Loader.html">Loader</a>
</li>
<li class="class-depth-1">
<a href="Phaser.LoaderParser.html">LoaderParser</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Math.html">Math</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Matrix.html">Matrix</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Mouse.html">Mouse</a>
</li>
<li class="class-depth-1">
<a href="Phaser.MSPointer.html">MSPointer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Net.html">Net</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Particle.html">Particle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Physics.html">Physics</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Physics.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Arcade.Body.html">Body</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Arcade.html#TilemapCollision">TilemapCollision</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Physics.Ninja.html">Ninja</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.AABB.html">AABB</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Body.html">Body</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Circle.html">Circle</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Tile.html">Tile</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Physics.P2.html">P2</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Body.html">Body</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.BodyDebug.html">BodyDebug</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.DistanceConstraint.html">DistanceConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.FixtureList.html">FixtureList</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.GearConstraint.html">GearConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.InversePointProxy.html">InversePointProxy</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.LockConstraint.html">LockConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Material.html">Material</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PointProxy.html">PointProxy</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PrismaticConstraint.html">PrismaticConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RevoluteConstraint.html">RevoluteConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RotationalSpring.html">RotationalSpring</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Spring.html">Spring</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Plugin.html">Plugin</a>
</li>
<li class="class-depth-1">
<a href="Phaser.PluginManager.html">PluginManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Point.html">Point</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Pointer.html">Pointer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Polygon.html">Polygon</a>
</li>
<li class="class-depth-1">
<a href="Phaser.QuadTree.html">QuadTree</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Rectangle.html">Rectangle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RenderTexture.html">RenderTexture</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RetroFont.html">RetroFont</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Rope.html">Rope</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RoundedRectangle.html">RoundedRectangle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ScaleManager.html">ScaleManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Signal.html">Signal</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SignalBinding.html">SignalBinding</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SinglePad.html">SinglePad</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Sound.html">Sound</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SoundManager.html">SoundManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Sprite.html">Sprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SpriteBatch.html">SpriteBatch</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Stage.html">Stage</a>
</li>
<li class="class-depth-1">
<a href="Phaser.State.html">State</a>
</li>
<li class="class-depth-1">
<a href="Phaser.StateManager.html">StateManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Text.html">Text</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tile.html">Tile</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tilemap.html">Tilemap</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TilemapParser.html">TilemapParser</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tileset.html">Tileset</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Time.html">Time</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Timer.html">Timer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TimerEvent.html">TimerEvent</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Touch.html">Touch</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tween.html">Tween</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TweenData.html">TweenData</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TweenManager.html">TweenManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Utils.html">Utils</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Utils.Debug.html">Debug</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Video.html">Video</a>
</li>
<li class="class-depth-1">
<a href="Phaser.World.html">World</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AbstractFilter.html">AbstractFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BaseTexture.html">BaseTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasBuffer.html">CanvasBuffer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasGraphics.html">CanvasGraphics</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasMaskManager.html">CanvasMaskManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasRenderer.html">CanvasRenderer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasTinter.html">CanvasTinter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ComplexPrimitiveShader.html">ComplexPrimitiveShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DisplayObject.html">DisplayObject</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DisplayObjectContainer.html">DisplayObjectContainer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Event.html">Event</a>
</li>
<li class="class-depth-1">
<a href="PIXI.EventTarget.html">EventTarget</a>
</li>
<li class="class-depth-1">
<a href="PIXI.FilterTexture.html">FilterTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Graphics.html">Graphics</a>
</li>
<li class="class-depth-1">
<a href="PIXI.GraphicsData.html">GraphicsData</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PIXI.html">PIXI</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PixiFastShader.html">PixiFastShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PixiShader.html">PixiShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PolyK.html">PolyK</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PrimitiveShader.html">PrimitiveShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.RenderTexture.html">RenderTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Rope.html">Rope</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Sprite.html">Sprite</a>
</li>
<li class="class-depth-1">
<a href="PIXI.SpriteBatch.html">SpriteBatch</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Stage.html">Stage</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Strip.html">Strip</a>
</li>
<li class="class-depth-1">
<a href="PIXI.StripShader.html">StripShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Texture.html">Texture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.TilingSprite.html">TilingSprite</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLBlendModeManager.html">WebGLBlendModeManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLFastSpriteBatch.html">WebGLFastSpriteBatch</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLFilterManager.html">WebGLFilterManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLRenderer.html">WebGLRenderer</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-0">
<a href="global.html#AUTO">AUTO</a>
</li>
<li class="class-depth-0">
<a href="global.html#BITMAPDATA">BITMAPDATA</a>
</li>
<li class="class-depth-0">
<a href="global.html#BITMAPTEXT">BITMAPTEXT</a>
</li>
<li class="class-depth-0">
<a href="global.html#blendModes">blendModes</a>
</li>
<li class="class-depth-0">
<a href="global.html#BUTTON">BUTTON</a>
</li>
<li class="class-depth-0">
<a href="global.html#CANVAS">CANVAS</a>
</li>
<li class="class-depth-0">
<a href="global.html#CANVAS_FILTER">CANVAS_FILTER</a>
</li>
<li class="class-depth-0">
<a href="global.html#CIRCLE">CIRCLE</a>
</li>
<li class="class-depth-0">
<a href="global.html#CREATURE">CREATURE</a>
</li>
<li class="class-depth-0">
<a href="global.html#DOWN">DOWN</a>
</li>
<li class="class-depth-0">
<a href="global.html#ELLIPSE">ELLIPSE</a>
</li>
<li class="class-depth-0">
<a href="global.html#EMITTER">EMITTER</a>
</li>
<li class="class-depth-0">
<a href="global.html#GAMES">GAMES</a>
</li>
<li class="class-depth-0">
<a href="global.html#GRAPHICS">GRAPHICS</a>
</li>
<li class="class-depth-0">
<a href="global.html#GROUP">GROUP</a>
</li>
<li class="class-depth-0">
<a href="global.html#HEADLESS">HEADLESS</a>
</li>
<li class="class-depth-0">
<a href="global.html#IMAGE">IMAGE</a>
</li>
<li class="class-depth-0">
<a href="global.html#LEFT">LEFT</a>
</li>
<li class="class-depth-0">
<a href="global.html#LINE">LINE</a>
</li>
<li class="class-depth-0">
<a href="global.html#MATRIX">MATRIX</a>
</li>
<li class="class-depth-0">
<a href="global.html#NONE">NONE</a>
</li>
<li class="class-depth-0">
<a href="global.html#POINT">POINT</a>
</li>
<li class="class-depth-0">
<a href="global.html#POINTER">POINTER</a>
</li>
<li class="class-depth-0">
<a href="global.html#POLYGON">POLYGON</a>
</li>
<li class="class-depth-0">
<a href="global.html#RECTANGLE">RECTANGLE</a>
</li>
<li class="class-depth-0">
<a href="global.html#RENDERTEXTURE">RENDERTEXTURE</a>
</li>
<li class="class-depth-0">
<a href="global.html#RETROFONT">RETROFONT</a>
</li>
<li class="class-depth-0">
<a href="global.html#RIGHT">RIGHT</a>
</li>
<li class="class-depth-0">
<a href="global.html#ROPE">ROPE</a>
</li>
<li class="class-depth-0">
<a href="global.html#ROUNDEDRECTANGLE">ROUNDEDRECTANGLE</a>
</li>
<li class="class-depth-0">
<a href="global.html#scaleModes">scaleModes</a>
</li>
<li class="class-depth-0">
<a href="global.html#SPRITE">SPRITE</a>
</li>
<li class="class-depth-0">
<a href="global.html#SPRITEBATCH">SPRITEBATCH</a>
</li>
<li class="class-depth-0">
<a href="global.html#TEXT">TEXT</a>
</li>
<li class="class-depth-0">
<a href="global.html#TILEMAP">TILEMAP</a>
</li>
<li class="class-depth-0">
<a href="global.html#TILEMAPLAYER">TILEMAPLAYER</a>
</li>
<li class="class-depth-0">
<a href="global.html#TILESPRITE">TILESPRITE</a>
</li>
<li class="class-depth-0">
<a href="global.html#UP">UP</a>
</li>
<li class="class-depth-0">
<a href="global.html#VERSION">VERSION</a>
</li>
<li class="class-depth-0">
<a href="global.html#VIDEO">VIDEO</a>
</li>
<li class="class-depth-0">
<a href="global.html#WEBGL">WEBGL</a>
</li>
<li class="class-depth-0">
<a href="global.html#WEBGL_FILTER">WEBGL_FILTER</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Core<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.Game.html">Game</a></li>
<li class="class-depth-1"><a href="Phaser.Group.html">Group</a></li>
<li class="class-depth-1"><a href="Phaser.World.html">World</a></li>
<li class="class-depth-1"><a href="Phaser.Loader.html">Loader</a></li>
<li class="class-depth-1"><a href="Phaser.Cache.html">Cache</a></li>
<li class="class-depth-1"><a href="Phaser.Time.html">Time</a></li>
<li class="class-depth-1"><a href="Phaser.Camera.html">Camera</a></li>
<li class="class-depth-1"><a href="Phaser.StateManager.html">State Manager</a></li>
<li class="class-depth-1"><a href="Phaser.TweenManager.html">Tween Manager</a></li>
<li class="class-depth-1"><a href="Phaser.SoundManager.html">Sound Manager</a></li>
<li class="class-depth-1"><a href="Phaser.Input.html">Input Manager</a></li>
<li class="class-depth-1"><a href="Phaser.ScaleManager.html">Scale Manager</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Game Objects<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.GameObjectFactory.html">Factory (game.add)</a></li>
<li class="class-depth-1"><a href="Phaser.GameObjectCreator.html">Creator (game.make)</a></li>
<li class="class-depth-1"><a href="Phaser.Sprite.html">Sprite</a></li>
<li class="class-depth-1"><a href="Phaser.Image.html">Image</a></li>
<li class="class-depth-1"><a href="Phaser.Sound.html">Sound</a></li>
<li class="class-depth-1"><a href="Phaser.Video.html">Video</a></li>
<li class="class-depth-1"><a href="Phaser.Particles.Arcade.Emitter.html">Particle Emitter</a></li>
<li class="class-depth-1"><a href="Phaser.Particle.html">Particle</a></li>
<li class="class-depth-1"><a href="Phaser.Text.html">Text</a></li>
<li class="class-depth-1"><a href="Phaser.Tween.html">Tween</a></li>
<li class="class-depth-1"><a href="Phaser.BitmapText.html">BitmapText</a></li>
<li class="class-depth-1"><a href="Phaser.Tilemap.html">Tilemap</a></li>
<li class="class-depth-1"><a href="Phaser.BitmapData.html">BitmapData</a></li>
<li class="class-depth-1"><a href="Phaser.RetroFont.html">RetroFont</a></li>
<li class="class-depth-1"><a href="Phaser.Button.html">Button</a></li>
<li class="class-depth-1"><a href="Phaser.Animation.html">Animation</a></li>
<li class="class-depth-1"><a href="Phaser.Graphics.html">Graphics</a></li>
<li class="class-depth-1"><a href="Phaser.RenderTexture.html">RenderTexture</a></li>
<li class="class-depth-1"><a href="Phaser.TileSprite.html">TileSprite</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Geometry<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.Circle.html">Circle</a></li>
<li class="class-depth-1"><a href="Phaser.Ellipse.html">Ellipse</a></li>
<li class="class-depth-1"><a href="Phaser.Line.html">Line</a></li>
<li class="class-depth-1"><a href="Phaser.Matrix.html">Matrix</a></li>
<li class="class-depth-1"><a href="Phaser.Point.html">Point</a></li>
<li class="class-depth-1"><a href="Phaser.Polygon.html">Polygon</a></li>
<li class="class-depth-1"><a href="Phaser.Rectangle.html">Rectangle</a></li>
<li class="class-depth-1"><a href="Phaser.RoundedRectangle.html">Rounded Rectangle</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Physics<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.Physics.Arcade.html">Arcade Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.Arcade.Body.html">Body</a></li>
<li class="class-depth-1"><a href="Phaser.Physics.P2.html">P2 Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.Body.html">Body</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.Spring.html">Spring</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a></li>
<li class="class-depth-1"><a href="Phaser.Physics.Ninja.html">Ninja Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.Body.html">Body</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Input<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.InputHandler.html">Input Handler</a></li>
<li class="class-depth-1"><a href="Phaser.Pointer.html">Pointer</a></li>
<li class="class-depth-1"><a href="Phaser.DeviceButton.html">Device Button</a></li>
<li class="class-depth-1"><a href="Phaser.Mouse.html">Mouse</a></li>
<li class="class-depth-1"><a href="Phaser.Keyboard.html">Keyboard</a></li>
<li class="class-depth-1"><a href="Phaser.Key.html">Key</a></li>
<li class="class-depth-1"><a href="Phaser.Gamepad.html">Gamepad</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Community<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="http://phaser.io">Phaser Web Site</a></li>
<li class="class-depth-1"><a href="https://github.com/photonstorm/phaser">Phaser Github</a></li>
<li class="class-depth-1"><a href="http://phaser.io/examples">Phaser Examples</a></li>
<li class="class-depth-1"><a href="https://github.com/photonstorm/phaser-plugins">Phaser Plugins</a></li>
<li class="class-depth-1"><a href="http://www.html5gamedevs.com/forum/14-phaser/">Forum</a></li>
<li class="class-depth-1"><a href="http://stackoverflow.com/questions/tagged/phaser-framework">Stack Overflow</a></li>
<li class="class-depth-1"><a href="http://phaser.io/learn">Tutorials</a></li>
<li class="class-depth-1"><a href="https://confirmsubscription.com/h/r/369DE48E3E86AF1E">Newsletter</a></li>
<li class="class-depth-1"><a href="http://phaser.io/community/twitter">Twitter</a></li>
<li class="class-depth-1"><a href="http://phaser.io/community/irc">IRC</a></li>
<li class="class-depth-1"><a href="https://www.codeandweb.com/texturepacker/phaser">Texture Packer</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span8">
<div id="main">
<!--<h1 class="page-title">Class: TileSprite</h1>-->
<section>
<header>
<h2>
<span class="ancestors"><a href="Phaser.html">Phaser</a>.</span>
TileSprite
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<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>
</dt>
<dd>
<div class="description">
<p>A TileSprite is a Sprite that has a repeating texture. The texture can be scrolled and scaled independently of the TileSprite itself.
Textures will automatically wrap and are designed so that you can create game backdrops using seamless textures as a source.</p>
<p>TileSprites have no input handler or physics bodies by default, both need enabling in the same way as for normal Sprites.</p>
<p>You shouldn't ever create a TileSprite any larger than your actual screen size. If you want to create a large repeating background
that scrolls across the whole map of your game, then you create a TileSprite that fits the screen size and then use the <code>tilePosition</code>
property to scroll the texture as the player moves. If you create a TileSprite that is thousands of pixels in size then it will
consume huge amounts of memory and cause performance issues. Remember: use <code>tilePosition</code> to scroll your texture and <code>tileScale</code> to
adjust the scale of the texture - don't resize the sprite itself or make it larger than it needs.</p>
<p>An important note about texture dimensions:</p>
<p>When running under Canvas a TileSprite can use any texture size without issue. When running under WebGL the texture should ideally be
a power of two in size (i.e. 4, 8, 16, 32, 64, 128, 256, 512, etch pixels width by height). If the texture isn't a power of two
it will be rendered to a blank canvas that is the correct size, which means you may have 'blank' areas appearing to the right and
bottom of your frame. To avoid this ensure your textures are perfect powers of two.</p>
<p>TileSprites support animations in the same way that Sprites do. You add and play animations using the AnimationManager. However
if your game is running under WebGL please note that each frame of the animation must be a power of two in size, or it will receive
additional padding to enforce it to be so.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>game</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span>
</td>
<td class="description last"><p>A reference to the currently running game.</p></td>
</tr>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The x coordinate (in world space) to position the TileSprite at.</p></td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The y coordinate (in world space) to position the TileSprite at.</p></td>
</tr>
<tr>
<td class="name"><code>width</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The width of the TileSprite.</p></td>
</tr>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The height of the TileSprite.</p></td>
</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>
|
<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 Phaser Image Cache entry, or an instance of a RenderTexture, PIXI.Texture or BitmapData.</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="src_gameobjects_TileSprite.js.html">gameobjects/TileSprite.js</a>, <a href="src_gameobjects_TileSprite.js.html#sunlight-1-line-59">line 59</a>
</dt>
</dl>
</dd>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li><a href="PIXI.TilingSprite.html">PIXI.TilingSprite</a></li>
<li><a href="Phaser.Component.Core.html">Phaser.Component.Core</a></li>
<li><a href="Phaser.Component.Angle.html">Phaser.Component.Angle</a></li>
<li><a href="Phaser.Component.Animation.html">Phaser.Component.Animation</a></li>
<li><a href="Phaser.Component.AutoCull.html">Phaser.Component.AutoCull</a></li>
<li><a href="Phaser.Component.Bounds.html">Phaser.Component.Bounds</a></li>
<li><a href="Phaser.Component.BringToTop.html">Phaser.Component.BringToTop</a></li>
<li><a href="Phaser.Component.Destroy.html">Phaser.Component.Destroy</a></li>
<li><a href="Phaser.Component.FixedToCamera.html">Phaser.Component.FixedToCamera</a></li>
<li><a href="Phaser.Component.Health.html">Phaser.Component.Health</a></li>
<li><a href="Phaser.Component.InCamera.html">Phaser.Component.InCamera</a></li>
<li><a href="Phaser.Component.InputEnabled.html">Phaser.Component.InputEnabled</a></li>
<li><a href="Phaser.Component.InWorld.html">Phaser.Component.InWorld</a></li>
<li><a href="Phaser.Component.LifeSpan.html">Phaser.Component.LifeSpan</a></li>
<li><a href="Phaser.Component.LoadTexture.html">Phaser.Component.LoadTexture</a></li>
<li><a href="Phaser.Component.Overlap.html">Phaser.Component.Overlap</a></li>
<li><a href="Phaser.Component.PhysicsBody.html">Phaser.Component.PhysicsBody</a></li>
<li><a href="Phaser.Component.Reset.html">Phaser.Component.Reset</a></li>
<li><a href="Phaser.Component.Smoothed.html">Phaser.Component.Smoothed</a></li>
</ul>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name "
id="alive"><span class="type-signature"></span>alive<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>A useful flag to control if the Game Object is alive or dead.</p>
<p>This is set automatically by the Health components <code>damage</code> method should the object run out of health.
Or you can toggle it via your game code.</p>
<p>This property is mostly just provided to be used by your game - it doesn't effect rendering or logic updates.
However you can use <code>Group.getFirstAlive</code> in conjunction with this property for fast object pooling and recycling.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.LifeSpan.html#alive">Phaser.Component.LifeSpan#alive</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="src_gameobjects_components_LifeSpan.js.html">gameobjects/components/LifeSpan.js</a>, <a href="src_gameobjects_components_LifeSpan.js.html#sunlight-1-line-50">line 50</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="alpha"><span class="type-signature"></span>alpha<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The opacity 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#alpha">PIXI.DisplayObject#alpha</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-65">line 65</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="anchor"><span class="type-signature"></span>anchor<span class="type-signature"> :Point</span></h4>
</dt>
<dd>
<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>
<dl class="details">
<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>
<dt class="tag-source">Source -
<a href="src_pixi_display_Sprite.js.html">pixi/display/Sprite.js</a>, <a href="src_pixi_display_Sprite.js.html#sunlight-1-line-22">line 22</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="angle"><span class="type-signature"></span>angle<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The angle property is the rotation of the Game Object in <em>degrees</em> from its original orientation.</p>
<p>Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.</p>
<p>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.</p>
<p>If you wish to work in radians instead of degrees you can use the property <code>rotation</code> instead.
Working in radians is slightly faster as it doesn't have to perform any calculations.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Angle.html#angle">Phaser.Component.Angle#angle</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Angle.js.html">gameobjects/components/Angle.js</a>, <a href="src_gameobjects_components_Angle.js.html#sunlight-1-line-29">line 29</a>
</dt>
</dl>
</dd>
<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>
<div class="description">
<p>If the Game Object is enabled for animation (such as a Phaser.Sprite) this is a reference to its AnimationManager instance.
Through it you can create, play, pause and stop animations.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#animations">Phaser.Component.Core#animations</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-184">line 184</a>
</dt>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="Phaser.AnimationManager.html">Phaser.AnimationManager</a></li>
</ul>
</dd>
</dl>
</dd>
<dt>
<h4 class="name "
id="autoCull"><span class="type-signature"></span>autoCull<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>A Game Object with <code>autoCull</code> set to true will check its bounds against the World Camera every frame.
If it is not intersecting the Camera bounds at any point then it has its <code>renderable</code> property set to <code>false</code>.
This keeps the Game Object alive and still processing updates, but forces it to skip the render step entirely.</p>
<p>This is a relatively expensive operation, especially if enabled on hundreds of Game Objects. So enable it only if you know it's required,
or you have tested performance and find it acceptable.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.AutoCull.html#autoCull">Phaser.Component.AutoCull#autoCull</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="src_gameobjects_components_AutoCull.js.html">gameobjects/components/AutoCull.js</a>, <a href="src_gameobjects_components_AutoCull.js.html#sunlight-1-line-28">line 28</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="blendMode"><span class="type-signature"></span>blendMode<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The blend mode to be applied to the 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#blendMode">PIXI.TilingSprite#blendMode</a>
</li></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>PIXI.blendModes.NORMAL;</li></ul></dd>
<dt class="tag-source">Source -
<a href="src_pixi_extras_TilingSprite.js.html">pixi/extras/TilingSprite.js</a>, <a href="src_pixi_extras_TilingSprite.js.html#sunlight-1-line-86">line 86</a>
</dt>
</dl>
</dd>
<dt>
<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>
</dt>
<dd>
<div class="description">
<p><code>body</code> is the Game Objects physics body. Once a Game Object is enabled for physics you access all associated
properties and methods via it.</p>
<p>By default Game Objects won't add themselves to any physics system and their <code>body</code> property will be <code>null</code>.</p>
<p>To enable this Game Object for physics you need to call <code>game.physics.enable(object, system)</code> where <code>object</code> is this object
and <code>system</code> is the Physics system you are using. If none is given it defaults to <code>Phaser.Physics.Arcade</code>.</p>
<p>You can alternatively call <code>game.physics.arcade.enable(object)</code>, or add this Game Object to a physics enabled Group.</p>
<p>Important: Enabling a Game Object for P2 or Ninja physics will automatically set its <code>anchor</code> property to 0.5,
so the physics body is centered on the Game Object.</p>
<p>If you need a different result then adjust or re-create the Body shape offsets manually or reset the anchor after enabling physics.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<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>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.PhysicsBody.html#body">Phaser.Component.PhysicsBody#body</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="src_gameobjects_components_PhysicsBody.js.html">gameobjects/components/PhysicsBody.js</a>, <a href="src_gameobjects_components_PhysicsBody.js.html#sunlight-1-line-91">line 91</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="bottom"><span class="type-signature">&lt;readonly> </span>bottom<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The sum of the y and height properties.
This is the same as <code>y + height - offsetY</code>.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Bounds.html#bottom">Phaser.Component.Bounds#bottom</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Bounds.js.html">gameobjects/components/Bounds.js</a>, <a href="src_gameobjects_components_Bounds.js.html#sunlight-1-line-110">line 110</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="cacheAsBitmap"><span class="type-signature"></span>cacheAsBitmap<span class="type-signature"> :Boolean</span></h4>
</dt>
<dd>
<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>
<dl class="details">
<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>
<dt class="tag-source">Source -
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-366">line 366</a>
</dt>
</dl>
</dd>
<dt>
<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>
</dt>
<dd>
<div class="description">
<p>The x/y coordinate offset applied to the top-left of the camera that this Game Object will be drawn at if <code>fixedToCamera</code> is true.</p>
<p>The values are relative to the top-left of the camera view and in addition to any parent of the Game Object on the display list.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.FixedToCamera.html#cameraOffset">Phaser.Component.FixedToCamera#cameraOffset</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_FixedToCamera.js.html">gameobjects/components/FixedToCamera.js</a>, <a href="src_gameobjects_components_FixedToCamera.js.html#sunlight-1-line-86">line 86</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="canvasBuffer"><span class="type-signature"></span>canvasBuffer<span class="type-signature"> :PIXICanvasBuffer</span></h4>
</dt>
<dd>
<div class="description">
<p>The CanvasBuffer object that the tiled texture is drawn to.</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#canvasBuffer">PIXI.TilingSprite#canvasBuffer</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_pixi_extras_TilingSprite.js.html">pixi/extras/TilingSprite.js</a>, <a href="src_pixi_extras_TilingSprite.js.html#sunlight-1-line-95">line 95</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="checkWorldBounds"><span class="type-signature"></span>checkWorldBounds<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>If this is set to <code>true</code> the Game Object checks if it is within the World bounds each frame. </p>
<p>When it is no longer intersecting the world bounds it dispatches the <code>onOutOfBounds</code> event.</p>
<p>If it was <em>previously</em> out of bounds but is now intersecting the world bounds again it dispatches the <code>onEnterBounds</code> event.</p>
<p>It also optionally kills the Game Object if <code>outOfBoundsKill</code> is <code>true</code>.</p>
<p>When <code>checkWorldBounds</code> is enabled it forces the Game Object to calculate its full bounds every frame.</p>
<p>This is a relatively expensive operation, especially if enabled on hundreds of Game Objects. So enable it only if you know it's required,
or you have tested performance and find it acceptable.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.InWorld.html#checkWorldBounds">Phaser.Component.InWorld#checkWorldBounds</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="src_gameobjects_components_InWorld.js.html">gameobjects/components/InWorld.js</a>, <a href="src_gameobjects_components_InWorld.js.html#sunlight-1-line-92">line 92</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="children"><span class="type-signature">&lt;readonly> </span>children<span class="type-signature"> :Array.&lt;<a href="global.html#DisplayObject">DisplayObject</a>></span></h4>
</dt>
<dd>
<div class="description">
<p>[read-only] The array of children of this container.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.&lt;<a href="global.html#DisplayObject">DisplayObject</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.DisplayObjectContainer.html#children">PIXI.DisplayObjectContainer#children</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-17">line 17</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="components"><span class="type-signature">&lt;internal> </span>components<span class="type-signature"> :object</span></h4>
</dt>
<dd>
<div class="description">
<p>The components this Game Object has installed.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#components">Phaser.Component.Core#components</a>
</li></dd>
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-160">line 160</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="damage"><span class="type-signature"></span>damage<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Damages the Game Object. This removes the given amount of health from the <code>health</code> property.</p>
<p>If health is taken below or is equal to zero then the <code>kill</code> method is called.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Health.html#damage">Phaser.Component.Health#damage</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Health.js.html">gameobjects/components/Health.js</a>, <a href="src_gameobjects_components_Health.js.html#sunlight-1-line-46">line 46</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="debug"><span class="type-signature"></span>debug<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>A debug flag designed for use with <code>Game.enableStep</code>.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#debug">Phaser.Component.Core#debug</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="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-209">line 209</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="destroyPhase"><span class="type-signature">&lt;readonly> </span>destroyPhase<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>As a Game Object runs through its destroy method this flag is set to true,
and can be checked in any sub-systems or plugins it is being destroyed from.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Destroy.html#destroyPhase">Phaser.Component.Destroy#destroyPhase</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Destroy.js.html">gameobjects/components/Destroy.js</a>, <a href="src_gameobjects_components_Destroy.js.html#sunlight-1-line-22">line 22</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>All Phaser Game Objects have an Events class which contains all of the events that are dispatched when certain things happen to this
Game Object, or any of its components.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#events">Phaser.Component.Core#events</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-176">line 176</a>
</dt>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="Phaser.Events.html">Phaser.Events</a></li>
</ul>
</dd>
</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>Controls if this Game Object is processed by the core game loop.
If this Game Object has a physics body it also controls if its physics body is updated or not.
When <code>exists</code> is set to <code>false</code> it will remove its physics body from the physics world if it has one.
It also toggles the <code>visible</code> property to false as well.</p>
<p>Setting <code>exists</code> to true will add its physics body back in to the physics world, if it has one.
It will also set the <code>visible</code> property to <code>true</code>.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#exists">Phaser.Component.Core#exists</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-275">line 275</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="filterArea"><span class="type-signature"></span>filterArea<span class="type-signature"> :Rectangle</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="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-183">line 183</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="filters"><span class="type-signature"></span>filters<span class="type-signature"> :Array.&lt;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.&lt;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="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-328">line 328</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>A Game Object that is &quot;fixed&quot; to the camera uses its x/y coordinates as offsets from the top left of the camera during rendering.</p>
<p>The values are adjusted at the rendering stage, overriding the Game Objects actual world position.</p>
<p>The end result is that the Game Object will appear to be 'fixed' to the camera, regardless of where in the game world
the camera is viewing. This is useful if for example this Game Object is a UI item that you wish to be visible at all times
regardless where in the world the camera is.</p>
<p>The offsets are stored in the <code>cameraOffset</code> property.</p>
<p>Note that the <code>cameraOffset</code> values are in addition to any parent of this Game Object on the display list.</p>
<p>Be careful not to set <code>fixedToCamera</code> on Game Objects which are in Groups that already have <code>fixedToCamera</code> enabled on them.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.FixedToCamera.html#fixedToCamera">Phaser.Component.FixedToCamera#fixedToCamera</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_FixedToCamera.js.html">gameobjects/components/FixedToCamera.js</a>, <a href="src_gameobjects_components_FixedToCamera.js.html#sunlight-1-line-56">line 56</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="frame"><span class="type-signature"></span>frame<span class="type-signature"> :integer</span></h4>
</dt>
<dd>
<div class="description">
<p>Gets or sets the current frame index of the texture being used to render this Game Object.</p>
<p>To change the frame set <code>frame</code> to the index of the new frame in the sprite sheet you wish this Game Object to use,
for example: <code>player.frame = 4</code>.</p>
<p>If the frame index given doesn't exist it will revert to the first frame found in the texture.</p>
<p>If you are using a texture atlas then you should use the <code>frameName</code> property instead.</p>
<p>If you wish to fully replace the texture being used see <code>loadTexture</code>.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.LoadTexture.html#frame">Phaser.Component.LoadTexture#frame</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_LoadTexture.js.html">gameobjects/components/LoadTexture.js</a>, <a href="src_gameobjects_components_LoadTexture.js.html#sunlight-1-line-218">line 218</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 of the texture being used to render this Game Object.</p>
<p>To change the frame set <code>frameName</code> to the name of the new frame in the texture atlas you wish this Game Object to use,
for example: <code>player.frameName = &quot;idle&quot;</code>.</p>
<p>If the frame name given doesn't exist it will revert to the first frame found in the texture and throw a console warning.</p>
<p>If you are using a sprite sheet then you should use the <code>frame</code> property instead.</p>
<p>If you wish to fully replace the texture being used see <code>loadTexture</code>.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.LoadTexture.html#frameName">Phaser.Component.LoadTexture#frameName</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_LoadTexture.js.html">gameobjects/components/LoadTexture.js</a>, <a href="src_gameobjects_components_LoadTexture.js.html#sunlight-1-line-243">line 243</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="fresh"><span class="type-signature">&lt;readonly> </span>fresh<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>A Game Object is considered <code>fresh</code> if it has just been created or reset and is yet to receive a renderer transform update.
This property is mostly used internally by the physics systems, but is exposed for the use of plugins.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#fresh">Phaser.Component.Core#fresh</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-239">line 239</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="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#game">Phaser.Component.Core#game</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-145">line 145</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="heal"><span class="type-signature"></span>heal<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Heal the Game Object. This adds the given amount of health to the <code>health</code> property.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Health.html#heal">Phaser.Component.Health#heal</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Health.js.html">gameobjects/components/Health.js</a>, <a href="src_gameobjects_components_Health.js.html#sunlight-1-line-69">line 69</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="health"><span class="type-signature"></span>health<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The Game Objects health value. This is a handy property for setting and manipulating health on a Game Object.</p>
<p>It can be used in combination with the <code>damage</code> method or modified directly.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Health.html#health">Phaser.Component.Health#health</a>
</li></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>1</li></ul></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Health.js.html">gameobjects/components/Health.js</a>, <a href="src_gameobjects_components_Health.js.html#sunlight-1-line-26">line 26</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="src_pixi_extras_TilingSprite.js.html">pixi/extras/TilingSprite.js</a>, <a href="src_pixi_extras_TilingSprite.js.html#sunlight-1-line-532">line 532</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="src_pixi_extras_TilingSprite.js.html">pixi/extras/TilingSprite.js</a>, <a href="src_pixi_extras_TilingSprite.js.html#sunlight-1-line-27">line 27</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="hitArea"><span class="type-signature"></span>hitArea<span class="type-signature"> :Rectangle|Circle|Ellipse|Polygon</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">Rectangle</span>
|
<span class="param-type">Circle</span>
|
<span class="param-type">Ellipse</span>
|
<span class="param-type">Polygon</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="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-81">line 81</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="inCamera"><span class="type-signature">&lt;readonly> </span>inCamera<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>Checks if the Game Objects bounds intersect with the Game Camera bounds.
Returns <code>true</code> if they do, otherwise <code>false</code> if fully outside of the Cameras bounds.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.AutoCull.html#inCamera">Phaser.Component.AutoCull#inCamera</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_AutoCull.js.html">gameobjects/components/AutoCull.js</a>, <a href="src_gameobjects_components_AutoCull.js.html#sunlight-1-line-37">line 37</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="inCamera"><span class="type-signature">&lt;readonly> </span>inCamera<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>Checks if this Game Objects bounds intersects with the Game Cameras bounds.</p>
<p>It will be <code>true</code> if they intersect, or <code>false</code> if the Game Object is fully outside of the Cameras bounds.</p>
<p>An object outside the bounds can be considered for camera culling if it has the AutoCull component.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.InCamera.html#inCamera">Phaser.Component.InCamera#inCamera</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_InCamera.js.html">gameobjects/components/InCamera.js</a>, <a href="src_gameobjects_components_InCamera.js.html#sunlight-1-line-26">line 26</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 Game Object.</p>
<p>By default it is disabled. If you wish this Game Object to process input events you should enable it with: <code>inputEnabled = true</code>.</p>
<p>After you have done this, this property will be a reference to the Phaser InputHandler.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="Phaser.InputHandler.html">Phaser.InputHandler</a></span>
|
<span class="param-type">null</span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.InputEnabled.html#input">Phaser.Component.InputEnabled#input</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_InputEnabled.js.html">gameobjects/components/InputEnabled.js</a>, <a href="src_gameobjects_components_InputEnabled.js.html#sunlight-1-line-24">line 24</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 Game Object won't process any input events. By setting <code>inputEnabled</code> to true a Phaser.InputHandler is created
for this Game Object and it will then start to process click / touch events and more.</p>
<p>You can then access the Input Handler via <code>this.input</code>.</p>
<p>Note that Input related events are dispatched from <code>this.events</code>, i.e.: <code>events.onInputDown</code>.</p>
<p>If you set this property to false it will stop the Input Handler from processing any more input events.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.InputEnabled.html#inputEnabled">Phaser.Component.InputEnabled#inputEnabled</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_InputEnabled.js.html">gameobjects/components/InputEnabled.js</a>, <a href="src_gameobjects_components_InputEnabled.js.html#sunlight-1-line-38">line 38</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="inWorld"><span class="type-signature">&lt;readonly> </span>inWorld<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>Checks if the Game Objects bounds are within, or intersect at any point with the Game World bounds.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.InWorld.html#inWorld">Phaser.Component.InWorld#inWorld</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_InWorld.js.html">gameobjects/components/InWorld.js</a>, <a href="src_gameobjects_components_InWorld.js.html#sunlight-1-line-114">line 114</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="Phaser.Video.html">Phaser.Video</a>|<a href="PIXI.Texture.html">PIXI.Texture</a></span></h4>
</dt>
<dd>
<div class="description">
<p>The key of the image or texture used by this Game Object during rendering.
If it is a string it's the string used to retrieve the texture from the Phaser Image Cache.
It can also be an instance of a RenderTexture, BitmapData, Video or PIXI.Texture.
If a Game Object is created without a key it is automatically assigned the key <code>__default</code> which is a 32x32 transparent PNG stored within the Cache.
If a Game Object is given a key which doesn't exist in the Image Cache it is re-assigned the key <code>__missing</code> which is a 32x32 PNG of a green box with a line through it.</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="Phaser.Video.html">Phaser.Video</a></span>
|
<span class="param-type"><a href="PIXI.Texture.html">PIXI.Texture</a></span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#key">Phaser.Component.Core#key</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-194">line 194</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="left"><span class="type-signature">&lt;readonly> </span>left<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The left coordinate of the Game Object.
This is the same as <code>x - offsetX</code>.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Bounds.html#left">Phaser.Component.Bounds#left</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Bounds.js.html">gameobjects/components/Bounds.js</a>, <a href="src_gameobjects_components_Bounds.js.html#sunlight-1-line-59">line 59</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="lifespan"><span class="type-signature"></span>lifespan<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The lifespan allows you to give a Game Object a lifespan in milliseconds.</p>
<p>Once the Game Object is 'born' you can set this to a positive value.</p>
<p>It is automatically decremented by the millisecond equivalent of <code>game.time.physicsElapsed</code> each frame.
When it reaches zero it will call the <code>kill</code> method.</p>
<p>Very handy for particles, bullets, collectibles, or any other short-lived entity.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.LifeSpan.html#lifespan">Phaser.Component.LifeSpan#lifespan</a>
</li></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>0</li></ul></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_LifeSpan.js.html">gameobjects/components/LifeSpan.js</a>, <a href="src_gameobjects_components_LifeSpan.js.html#sunlight-1-line-65">line 65</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="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-303">line 303</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="maxHealth"><span class="type-signature"></span>maxHealth<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The Game Objects maximum health value. This works in combination with the <code>heal</code> method to ensure
the health value never exceeds the maximum.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Health.html#maxHealth">Phaser.Component.Health#maxHealth</a>
</li></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>100</li></ul></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Health.js.html">gameobjects/components/Health.js</a>, <a href="src_gameobjects_components_Health.js.html#sunlight-1-line-35">line 35</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>A user defined name given to this Game Object.
This value isn't ever used internally by Phaser, it is meant as a game level property.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#name">Phaser.Component.Core#name</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-153">line 153</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="offsetX"><span class="type-signature">&lt;readonly> </span>offsetX<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The amount the Game Object is visually offset from its x coordinate.
This is the same as <code>width * anchor.x</code>.
It will only be &gt; 0 if anchor.x is not equal to zero.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Bounds.html#offsetX">Phaser.Component.Bounds#offsetX</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Bounds.js.html">gameobjects/components/Bounds.js</a>, <a href="src_gameobjects_components_Bounds.js.html#sunlight-1-line-24">line 24</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="offsetY"><span class="type-signature">&lt;readonly> </span>offsetY<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The amount the Game Object is visually offset from its y coordinate.
This is the same as <code>height * anchor.y</code>.
It will only be &gt; 0 if anchor.y is not equal to zero.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Bounds.html#offsetY">Phaser.Component.Bounds#offsetY</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Bounds.js.html">gameobjects/components/Bounds.js</a>, <a href="src_gameobjects_components_Bounds.js.html#sunlight-1-line-42">line 42</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="outOfBoundsKill"><span class="type-signature"></span>outOfBoundsKill<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>If this and the <code>checkWorldBounds</code> property are both set to <code>true</code> then the <code>kill</code> method is called as soon as <code>inWorld</code> returns false.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.InWorld.html#outOfBoundsKill">Phaser.Component.InWorld#outOfBoundsKill</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="src_gameobjects_components_InWorld.js.html">gameobjects/components/InWorld.js</a>, <a href="src_gameobjects_components_InWorld.js.html#sunlight-1-line-100">line 100</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="parent"><span class="type-signature">&lt;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="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-98">line 98</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="pendingDestroy"><span class="type-signature"></span>pendingDestroy<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>A Game Object is that is pendingDestroy is flagged to have its destroy method called on the next logic update.
You can set it directly to allow you to flag an object to be destroyed on its next update.</p>
<p>This is extremely useful if you wish to destroy an object from within one of its own callbacks
such as with Buttons or other Input events.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#pendingDestroy">Phaser.Component.Core#pendingDestroy</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-250">line 250</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="physicsType"><span class="type-signature">&lt;readonly> </span>physicsType<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The const physics body type of this object.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_gameobjects_TileSprite.js.html">gameobjects/TileSprite.js</a>, <a href="src_gameobjects_TileSprite.js.html#sunlight-1-line-78">line 78</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="pivot"><span class="type-signature"></span>pivot<span class="type-signature"> :Point</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="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_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"> :Point</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="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-14">line 14</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="previousPosition"><span class="type-signature">&lt;readonly> </span>previousPosition<span class="type-signature"> :<a href="Phaser.Point.html">Phaser.Point</a></span></h4>
</dt>
<dd>
<div class="description">
<p>The position the Game Object was located in the previous frame.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#previousPosition">Phaser.Component.Core#previousPosition</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-216">line 216</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="previousRotation"><span class="type-signature">&lt;readonly> </span>previousRotation<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The rotation the Game Object was in set to in the previous frame. Value is in radians.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#previousRotation">Phaser.Component.Core#previousRotation</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-223">line 223</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="refreshTexture"><span class="type-signature"></span>refreshTexture<span class="type-signature"> :Boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>If true the TilingSprite will run generateTexture on its <strong>next</strong> render pass.
This is set by the likes of Phaser.LoadTexture.setFrame.</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#refreshTexture">PIXI.TilingSprite#refreshTexture</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="src_pixi_extras_TilingSprite.js.html">pixi/extras/TilingSprite.js</a>, <a href="src_pixi_extras_TilingSprite.js.html#sunlight-1-line-119">line 119</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="src_pixi_extras_TilingSprite.js.html">pixi/extras/TilingSprite.js</a>, <a href="src_pixi_extras_TilingSprite.js.html#sunlight-1-line-59">line 59</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="renderOrderID"><span class="type-signature">&lt;readonly> </span>renderOrderID<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The render order ID is used internally by the renderer and Input Manager and should not be modified.
This property is mostly used internally by the renderers, but is exposed for the use of plugins.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#renderOrderID">Phaser.Component.Core#renderOrderID</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-231">line 231</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="right"><span class="type-signature">&lt;readonly> </span>right<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The right coordinate of the Game Object.
This is the same as <code>x + width - offsetX</code>.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Bounds.html#right">Phaser.Component.Bounds#right</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Bounds.js.html">gameobjects/components/Bounds.js</a>, <a href="src_gameobjects_components_Bounds.js.html#sunlight-1-line-76">line 76</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="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_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"> :Point</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="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_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="src_pixi_display_Sprite.js.html">pixi/display/Sprite.js</a>, <a href="src_pixi_display_Sprite.js.html#sunlight-1-line-96">line 96</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="smoothed"><span class="type-signature"></span>smoothed<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>Enable or disable texture smoothing for this Game Object.</p>
<p>It only takes effect if the Game Object is using an image based texture.</p>
<p>Smoothing is enabled by default.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Smoothed.html#smoothed">Phaser.Component.Smoothed#smoothed</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Smoothed.js.html">gameobjects/components/Smoothed.js</a>, <a href="src_gameobjects_components_Smoothed.js.html#sunlight-1-line-25">line 25</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="stage"><span class="type-signature">&lt;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="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-107">line 107</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="src_pixi_display_Sprite.js.html">pixi/display/Sprite.js</a>, <a href="src_pixi_display_Sprite.js.html#sunlight-1-line-33">line 33</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="textureDebug"><span class="type-signature"></span>textureDebug<span class="type-signature"> :Boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>If enabled a green rectangle will be drawn behind the generated tiling texture, allowing you to visually
debug the texture being used.</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#textureDebug">PIXI.TilingSprite#textureDebug</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_pixi_extras_TilingSprite.js.html">pixi/extras/TilingSprite.js</a>, <a href="src_pixi_extras_TilingSprite.js.html#sunlight-1-line-77">line 77</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="tilePattern"><span class="type-signature"></span>tilePattern<span class="type-signature"> :PIXITexture</span></h4>
</dt>
<dd>
<div class="description">
<p>The Context fill pattern that is used to draw the TilingSprite in Canvas mode only (will be null in WebGL).</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#tilePattern">PIXI.TilingSprite#tilePattern</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_pixi_extras_TilingSprite.js.html">pixi/extras/TilingSprite.js</a>, <a href="src_pixi_extras_TilingSprite.js.html#sunlight-1-line-111">line 111</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="tilePosition"><span class="type-signature"></span>tilePosition<span class="type-signature"> :Point</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="src_pixi_extras_TilingSprite.js.html">pixi/extras/TilingSprite.js</a>, <a href="src_pixi_extras_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"> :Point</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="src_pixi_extras_TilingSprite.js.html">pixi/extras/TilingSprite.js</a>, <a href="src_pixi_extras_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"> :Point</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="src_pixi_extras_TilingSprite.js.html">pixi/extras/TilingSprite.js</a>, <a href="src_pixi_extras_TilingSprite.js.html#sunlight-1-line-43">line 43</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="tilingTexture"><span class="type-signature"></span>tilingTexture<span class="type-signature"> :PIXITexture</span></h4>
</dt>
<dd>
<div class="description">
<p>An internal Texture object that holds the tiling texture that was generated from TilingSprite.texture.</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#tilingTexture">PIXI.TilingSprite#tilingTexture</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_pixi_extras_TilingSprite.js.html">pixi/extras/TilingSprite.js</a>, <a href="src_pixi_extras_TilingSprite.js.html#sunlight-1-line-103">line 103</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="src_pixi_extras_TilingSprite.js.html">pixi/extras/TilingSprite.js</a>, <a href="src_pixi_extras_TilingSprite.js.html#sunlight-1-line-68">line 68</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="tintedTexture"><span class="type-signature"></span>tintedTexture<span class="type-signature"> :Canvas</span></h4>
</dt>
<dd>
<div class="description">
<p>A canvas that contains the tinted version of the Sprite (in Canvas mode, WebGL doesn't populate this)</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#tintedTexture">PIXI.Sprite#tintedTexture</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="src_pixi_display_Sprite.js.html">pixi/display/Sprite.js</a>, <a href="src_pixi_display_Sprite.js.html#sunlight-1-line-78">line 78</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="top"><span class="type-signature">&lt;readonly> </span>top<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The y coordinate of the Game Object.
This is the same as <code>y - offsetY</code>.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Bounds.html#top">Phaser.Component.Bounds#top</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Bounds.js.html">gameobjects/components/Bounds.js</a>, <a href="src_gameobjects_components_Bounds.js.html#sunlight-1-line-93">line 93</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="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_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="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-41">line 41</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="type"><span class="type-signature">&lt;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="src_gameobjects_TileSprite.js.html">gameobjects/TileSprite.js</a>, <a href="src_gameobjects_TileSprite.js.html#sunlight-1-line-72">line 72</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="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-73">line 73</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="width"><span class="type-signature"></span>width<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The width of the sprite, setting this will actually modify the scale to achieve the value set</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.TilingSprite.html#width">PIXI.TilingSprite#width</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_pixi_extras_TilingSprite.js.html">pixi/extras/TilingSprite.js</a>, <a href="src_pixi_extras_TilingSprite.js.html#sunlight-1-line-514">line 514</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 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="src_pixi_extras_TilingSprite.js.html">pixi/extras/TilingSprite.js</a>, <a href="src_pixi_extras_TilingSprite.js.html#sunlight-1-line-19">line 19</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 Game Object in pixels.
Depending on where in the display list this Game Object is placed this value can differ from <code>position</code>,
which contains the x/y coordinates relative to the Game Objects parent.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#world">Phaser.Component.Core#world</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-202">line 202</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="worldAlpha"><span class="type-signature">&lt;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="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-116">line 116</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="worldPosition"><span class="type-signature">&lt;readonly> </span>worldPosition<span class="type-signature"> :Point</span></h4>
</dt>
<dd>
<div class="description">
<p>The position of the Display Object based on the world transform.
This value is updated at the end of updateTransform and takes all parent transforms into account.</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#worldPosition">PIXI.DisplayObject#worldPosition</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-135">line 135</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="worldRotation"><span class="type-signature">&lt;readonly> </span>worldRotation<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The rotation of the Display Object, in radians, based on the world transform.
This value is updated at the end of updateTransform and takes all parent transforms into account.</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#worldRotation">PIXI.DisplayObject#worldRotation</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-155">line 155</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="worldScale"><span class="type-signature">&lt;readonly> </span>worldScale<span class="type-signature"> :Point</span></h4>
</dt>
<dd>
<div class="description">
<p>The scale of the Display Object based on the world transform.
This value is updated at the end of updateTransform and takes all parent transforms into account.</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#worldScale">PIXI.DisplayObject#worldScale</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-145">line 145</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="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-279">line 279</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 Game Object on the x axis relative to the local coordinates of the parent.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.PhysicsBody.html#x">Phaser.Component.PhysicsBody#x</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_PhysicsBody.js.html">gameobjects/components/PhysicsBody.js</a>, <a href="src_gameobjects_components_PhysicsBody.js.html#sunlight-1-line-98">line 98</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="x"><span class="type-signature"></span>x<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The position of the displayObject on the x axis relative to the local coordinates of the parent.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#x">PIXI.DisplayObject#x</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-726">line 726</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 displayObject on the y axis relative to the local coordinates of the parent.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#y">PIXI.DisplayObject#y</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-744">line 744</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 Game Object on the y axis relative to the local coordinates of the parent.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.PhysicsBody.html#y">Phaser.Component.PhysicsBody#y</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_PhysicsBody.js.html">gameobjects/components/PhysicsBody.js</a>, <a href="src_gameobjects_components_PhysicsBody.js.html#sunlight-1-line-124">line 124</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 of this Game Object within its parent Group.
No two objects in a Group can have the same z value.
This value is adjusted automatically whenever the Group hierarchy changes.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#z">Phaser.Component.Core#z</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-168">line 168</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"> &rarr; {<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="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-91">line 91</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"> &rarr; {<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="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-103">line 103</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="src_gameobjects_TileSprite.js.html">gameobjects/TileSprite.js</a>, <a href="src_gameobjects_TileSprite.js.html#sunlight-1-line-149">line 149</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="bringToTop"><span class="type-signature"></span>bringToTop<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Brings this Game Object to the top of its parents display list.
Visually this means it will render over the top of any old child in the same Group.</p>
<p>If this Game Object hasn't been added to a custom Group then this method will bring it to the top of the Game World,
because the World is the root Group from which all Game Objects descend.</p>
</div>
<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>This instance.</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.BringToTop.html#bringToTop">Phaser.Component.BringToTop#bringToTop</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_BringToTop.js.html">gameobjects/components/BringToTop.js</a>, <a href="src_gameobjects_components_BringToTop.js.html#sunlight-1-line-24">line 24</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">
&lt;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="src_gameobjects_TileSprite.js.html">gameobjects/TileSprite.js</a>, <a href="src_gameobjects_TileSprite.js.html#sunlight-1-line-178">line 178</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"> &rarr; {<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 &quot;PIXI/scaleModes:property&quot;}}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="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-549">line 549</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="src_pixi_extras_TilingSprite.js.html">pixi/extras/TilingSprite.js</a>, <a href="src_pixi_extras_TilingSprite.js.html#sunlight-1-line-335">line 335</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getBounds"><span class="type-signature"></span>getBounds<span class="signature">()</span><span class="type-signature"> &rarr; {Rectangle}</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">Rectangle</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="src_pixi_extras_TilingSprite.js.html">pixi/extras/TilingSprite.js</a>, <a href="src_pixi_extras_TilingSprite.js.html#sunlight-1-line-420">line 420</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"> &rarr; {<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="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-194">line 194</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"> &rarr; {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="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-159">line 159</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getLocalBounds"><span class="type-signature"></span>getLocalBounds<span class="signature">()</span><span class="type-signature"> &rarr; {Rectangle}</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">Rectangle</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="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-367">line 367</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="kill"><span class="type-signature"></span>kill<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Kills a Game Object. A killed Game Object has its <code>alive</code>, <code>exists</code> and <code>visible</code> properties all set to false.</p>
<p>It will dispatch the <code>onKilled</code> event. You can listen to <code>events.onKilled</code> for the signal.</p>
<p>Note that killing a Game Object is a way for you to quickly recycle it in an object pool,
it doesn't destroy the object or free it up from memory.</p>
<p>If you don't need this Game Object any more you should call <code>destroy</code> instead.</p>
</div>
<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>This instance.</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.LifeSpan.html#kill">Phaser.Component.LifeSpan#kill</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_LifeSpan.js.html">gameobjects/components/LifeSpan.js</a>, <a href="src_gameobjects_components_LifeSpan.js.html#sunlight-1-line-113">line 113</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="loadTexture"><span class="type-signature"></span>loadTexture<span class="signature">(key, <span class="optional">frame</span>, <span class="optional">stopAnimation</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Changes the base texture the Game Object is using. The old texture is removed and the new one is referenced or fetched from the Cache.</p>
<p>If your Game Object is using a frame from a texture atlas and you just wish to change to another frame, then see the <code>frame</code> or <code>frameName</code> properties instead.</p>
<p>You should only use <code>loadTexture</code> if you want to replace the base texture entirely.</p>
<p>Calling this method causes a WebGL texture update, so use sparingly or in low-intensity portions of your game, or if you know the new texture is already on the GPU.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
|
<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="Phaser.Video.html">Phaser.Video</a></span>
|
<span class="param-type"><a href="PIXI.Texture.html">PIXI.Texture</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><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 Image entry, or an instance of a RenderTexture, BitmapData, Video 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="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>If this Sprite 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>
<tr>
<td class="name"><code>stopAnimation</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>If an animation is already playing on this Sprite you can choose to stop it or let it carry on playing.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.LoadTexture.html#loadTexture">Phaser.Component.LoadTexture#loadTexture</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_LoadTexture.js.html">gameobjects/components/LoadTexture.js</a>, <a href="src_gameobjects_components_LoadTexture.js.html#sunlight-1-line-42">line 42</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="moveDown"><span class="type-signature"></span>moveDown<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Moves this Game Object down one place in its parents display list.
This call has no effect if the Game Object is already at the bottom of the display list.</p>
<p>If this Game Object hasn't been added to a custom Group then this method will move it one object down within the Game World,
because the World is the root Group from which all Game Objects descend.</p>
</div>
<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>This instance.</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.BringToTop.html#moveDown">Phaser.Component.BringToTop#moveDown</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_BringToTop.js.html">gameobjects/components/BringToTop.js</a>, <a href="src_gameobjects_components_BringToTop.js.html#sunlight-1-line-87">line 87</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="moveUp"><span class="type-signature"></span>moveUp<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Moves this Game Object up one place in its parents display list.
This call has no effect if the Game Object is already at the top of the display list.</p>
<p>If this Game Object hasn't been added to a custom Group then this method will move it one object up within the Game World,
because the World is the root Group from which all Game Objects descend.</p>
</div>
<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>This instance.</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.BringToTop.html#moveUp">Phaser.Component.BringToTop#moveUp</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_BringToTop.js.html">gameobjects/components/BringToTop.js</a>, <a href="src_gameobjects_components_BringToTop.js.html#sunlight-1-line-66">line 66</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="overlap"><span class="type-signature"></span>overlap<span class="signature">(displayObject)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Checks to see if the bounds of this Game Object overlaps with the bounds of the given Display Object,
which can be a Sprite, Image, TileSprite or anything that extends those such as Button or provides a <code>getBounds</code> method and result.</p>
<p>This check ignores the <code>hitArea</code> property if set and runs a <code>getBounds</code> comparison on both objects to determine the result.</p>
<p>Therefore it's relatively expensive to use in large quantities, i.e. with lots of Sprites at a high frequency.
It should be fine for low-volume testing where physics isn't required.</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>displayObject</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span>
|
<span class="param-type"><a href="Phaser.Image.html">Phaser.Image</a></span>
|
<span class="param-type"><a href="Phaser.TileSprite.html">Phaser.TileSprite</a></span>
|
<span class="param-type"><a href="Phaser.Button.html">Phaser.Button</a></span>
|
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
</td>
<td class="description last"><p>The display object to check against.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">boolean</span>
-
</div>
<div class="returns-desc param-desc">
<p>True if the bounds of this Game Object intersects at any point with the bounds of the given display object.</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Overlap.html#overlap">Phaser.Component.Overlap#overlap</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Overlap.js.html">gameobjects/components/Overlap.js</a>, <a href="src_gameobjects_components_Overlap.js.html#sunlight-1-line-29">line 29</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"> &rarr; {<a href="Phaser.Animation.html">Phaser.Animation</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Plays an Animation.</p>
<p>The animation should have previously been created via <code>animations.add</code>.</p>
<p>If the animation is already playing calling this again won't do anything.
If you need to reset an already running animation do so directly on the Animation object itself or via <code>AnimationManager.stop</code>.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>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. &quot;fire&quot;, &quot;walk&quot;, &quot;jump&quot;. Must have been previously created via 'AnimationManager.add'.</p></td>
</tr>
<tr>
<td class="name"><code>frameRate</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;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">
&lt;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>
<tr>
<td class="name"><code>killOnComplete</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>If set to true when the animation completes (only happens if loop=false) the parent Sprite will be killed.</p></td>
</tr>
</tbody>
</table>
<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.</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Animation.html#play">Phaser.Component.Animation#play</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Animation.js.html">gameobjects/components/Animation.js</a>, <a href="src_gameobjects_components_Animation.js.html#sunlight-1-line-31">line 31</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="postUpdate"><span class="type-signature">&lt;internal> </span>postUpdate<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Internal method called by the World postUpdate cycle.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#postUpdate">Phaser.Component.Core#postUpdate</a>
</li></dd>
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-329">line 329</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="preUpdate"><span class="type-signature"></span>preUpdate<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Automatically called by World.preUpdate.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_gameobjects_TileSprite.js.html">gameobjects/TileSprite.js</a>, <a href="src_gameobjects_TileSprite.js.html#sunlight-1-line-122">line 122</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="removeChild"><span class="type-signature"></span>removeChild<span class="signature">(child)</span><span class="type-signature"> &rarr; {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Removes a child from 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 remove</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 removed.</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#removeChild">PIXI.DisplayObjectContainer#removeChild</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-211">line 211</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="removeChildAt"><span class="type-signature"></span>removeChildAt<span class="signature">(index)</span><span class="type-signature"> &rarr; {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Removes a child from the specified index position.</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 that was removed.</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#removeChildAt">PIXI.DisplayObjectContainer#removeChildAt</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-226">line 226</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="removeChildren"><span class="type-signature"></span>removeChildren<span class="signature">(beginIndex, endIndex)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Removes all children from this container that are within the begin and end indexes.</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>beginIndex</code></td>
<td class="type">
<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>
</td>
<td class="description last"><p>The ending position. Default value is size of the container.</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.DisplayObjectContainer.html#removeChildren">PIXI.DisplayObjectContainer#removeChildren</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-244">line 244</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="removeStageReference"><span class="type-signature"></span>removeStageReference<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Removes the current stage reference from the container and all of its children.</p>
</div>
<dl class="details">
<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>
<dt class="tag-source">Source -
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-407">line 407</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="reset"><span class="type-signature"></span>reset<span class="signature">(x, y)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<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>
<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>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>
</td>
<td class="description last"><p>The y coordinate (in world space) to position the Sprite at.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-desc param-desc">
<p>(Phaser.TileSprite) This instance.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_gameobjects_TileSprite.js.html">gameobjects/TileSprite.js</a>, <a href="src_gameobjects_TileSprite.js.html#sunlight-1-line-194">line 194</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="resetFrame"><span class="type-signature"></span>resetFrame<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Resets the texture frame dimensions that the Game Object uses for rendering.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.LoadTexture.html#resetFrame">Phaser.Component.LoadTexture#resetFrame</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_LoadTexture.js.html">gameobjects/components/LoadTexture.js</a>, <a href="src_gameobjects_components_LoadTexture.js.html#sunlight-1-line-196">line 196</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="resizeFrame"><span class="type-signature"></span>resizeFrame<span class="signature">(parent, width, height)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Resizes the Frame dimensions that the Game Object uses for rendering.</p>
<p>You shouldn't normally need to ever call this, but in the case of special texture types such as Video or BitmapData
it can be useful to adjust the dimensions directly in this way.</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>parent</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The parent texture object that caused the resize, i.e. a Phaser.Video object.</p></td>
</tr>
<tr>
<td class="name"><code>width</code></td>
<td class="type">
<span class="param-type">integer</span>
</td>
<td class="description last"><p>The new width of the texture.</p></td>
</tr>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type">integer</span>
</td>
<td class="description last"><p>The new height of the texture.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.LoadTexture.html#resizeFrame">Phaser.Component.LoadTexture#resizeFrame</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_LoadTexture.js.html">gameobjects/components/LoadTexture.js</a>, <a href="src_gameobjects_components_LoadTexture.js.html#sunlight-1-line-184">line 184</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="revive"><span class="type-signature"></span>revive<span class="signature">(<span class="optional">health</span>)</span><span class="type-signature"> &rarr; {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Brings a 'dead' Game Object back to life, optionally resetting its health value in the process.</p>
<p>A resurrected Game Object has its <code>alive</code>, <code>exists</code> and <code>visible</code> properties all set to true.</p>
<p>It will dispatch the <code>onRevived</code> event. Listen to <code>events.onRevived</code> for the signal.</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>health</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
1
</td>
<td class="description last"><p>The health to give the Game Object. Only set if the GameObject has the Health component.</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>This instance.</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.LifeSpan.html#revive">Phaser.Component.LifeSpan#revive</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_LifeSpan.js.html">gameobjects/components/LifeSpan.js</a>, <a href="src_gameobjects_components_LifeSpan.js.html#sunlight-1-line-78">line 78</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="sendToBack"><span class="type-signature"></span>sendToBack<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Sends this Game Object to the bottom of its parents display list.
Visually this means it will render below all other children in the same Group.</p>
<p>If this Game Object hasn't been added to a custom Group then this method will send it to the bottom of the Game World,
because the World is the root Group from which all Game Objects descend.</p>
</div>
<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>This instance.</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.BringToTop.html#sendToBack">Phaser.Component.BringToTop#sendToBack</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_BringToTop.js.html">gameobjects/components/BringToTop.js</a>, <a href="src_gameobjects_components_BringToTop.js.html#sunlight-1-line-45">line 45</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="setChildIndex"><span class="type-signature"></span>setChildIndex<span class="signature">(child, index)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Changes the position of an existing child in the display object 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 child DisplayObject instance for which you want to change the index number</p></td>
</tr>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The resulting index number for the child display object</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<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>
<dt class="tag-source">Source -
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-176">line 176</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="setFrame"><span class="type-signature"></span>setFrame<span class="signature">(frame)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Sets the texture frame the Game Object uses for rendering.</p>
<p>This is primarily an internal method used by <code>loadTexture</code>, but is exposed for the use of plugins and custom classes.</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>frame</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Frame.html">Phaser.Frame</a></span>
</td>
<td class="description last"><p>The Frame to be used by the texture.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.LoadTexture.html#setFrame">Phaser.Component.LoadTexture#setFrame</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_LoadTexture.js.html">gameobjects/components/LoadTexture.js</a>, <a href="src_gameobjects_components_LoadTexture.js.html#sunlight-1-line-119">line 119</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="setStageReference"><span class="type-signature"></span>setStageReference<span class="signature">(stage)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.</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>stage</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.Stage.html">PIXI.Stage</a></span>
</td>
<td class="description last"><p>the stage that the container will have as its current stage reference</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.DisplayObjectContainer.html#setStageReference">PIXI.DisplayObjectContainer#setStageReference</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-391">line 391</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="setTexture"><span class="type-signature"></span>setTexture<span class="signature">(texture)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Sets the texture of 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>texture</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.Texture.html">PIXI.Texture</a></span>
</td>
<td class="description last"><p>The PIXI texture that is displayed by the sprite</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.Sprite.html#setTexture">PIXI.Sprite#setTexture</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_pixi_display_Sprite.js.html">pixi/display/Sprite.js</a>, <a href="src_pixi_display_Sprite.js.html#sunlight-1-line-156">line 156</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="stopScroll"><span class="type-signature"></span>stopScroll<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Stops an automatically scrolling TileSprite.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_gameobjects_TileSprite.js.html">gameobjects/TileSprite.js</a>, <a href="src_gameobjects_TileSprite.js.html#sunlight-1-line-166">line 166</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="swapChildren"><span class="type-signature"></span>swapChildren<span class="signature">(child, child2)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Swaps the position of 2 Display Objects within this 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>-</p></td>
</tr>
<tr>
<td class="name"><code>child2</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
</td>
<td class="description last"><p>-</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<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>
<dt class="tag-source">Source -
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-134">line 134</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="toGlobal"><span class="type-signature"></span>toGlobal<span class="signature">(position)</span><span class="type-signature"> &rarr; {Point}</span></h4>
</dt>
<dd>
<div class="description">
<p>Calculates the global position of the display object</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>position</code></td>
<td class="type">
<span class="param-type">Point</span>
</td>
<td class="description last"><p>The world origin to calculate from</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">Point</span>
-
</div>
<div class="returns-desc param-desc">
<p>A point object representing the position of this 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#toGlobal">PIXI.DisplayObject#toGlobal</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-583">line 583</a>
</dt>
</dl>
</dd>
<dt>
<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"> &rarr; {Point}</span></h4>
</dt>
<dd>
<div class="description">
<p>Calculates the local position of the display object relative to another point</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>position</code></td>
<td class="type">
<span class="param-type">Point</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The world origin to calculate from</p></td>
</tr>
<tr>
<td class="name"><code>from</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The DisplayObject to calculate the global position from</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">Point</span>
-
</div>
<div class="returns-desc param-desc">
<p>A point object representing the position of this 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#toLocal">PIXI.DisplayObject#toLocal</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-597">line 597</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="update"><span class="type-signature"></span>update<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Override this method in your own custom objects to handle any update requirements.
It is called immediately after <code>preUpdate</code> and before <code>postUpdate</code>.
Remember if this Game Object has any children you should call update on those too.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#update">Phaser.Component.Core#update</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-319">line 319</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="updateCache"><span class="type-signature"></span>updateCache<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Generates and updates the cached sprite for this 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#updateCache">PIXI.DisplayObject#updateCache</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-573">line 573</a>
</dt>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
Phaser Copyright © 2012-2015 Photon Storm Ltd.
</span>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha10</a>
on Wed Jul 29 2015 14:58:01 GMT+0100 (GMT Daylight Time) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>
<div class="span3">
<div id="toc"></div>
</div>
<br clear="both">
</div>
</div>
<script src="scripts/sunlight.js"></script>
<script src="scripts/sunlight.javascript.js"></script>
<script src="scripts/sunlight-plugin.doclinks.js"></script>
<script src="scripts/sunlight-plugin.linenumbers.js"></script>
<script src="scripts/sunlight-plugin.menu.js"></script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/jquery.scrollTo.js"></script>
<script src="scripts/jquery.localScroll.js"></script>
<script src="scripts/bootstrap-dropdown.js"></script>
<script src="scripts/toc.js"></script>
<script> Sunlight.highlightAll({lineNumbers:true, showMenu: true, enableDoclinks :true}); </script>
<script>
$( function () {
$( "#toc" ).toc( {
anchorName : function(i, heading, prefix) {
return $(heading).attr("id") || ( prefix + i );
},
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
</script>
</body>
</html>
Reference in a new issue View git blame Copy permalink