<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Phaser Class: Group</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-0"> <a href="Matrix.html">Matrix</a> </li> <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.ArrayList.html">ArrayList</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.Device.html">Device</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.GamepadButton.html">GamepadButton</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.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.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.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.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.BitmapText.html">BitmapText</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.Text.html">Text</a> </li> <li class="class-depth-1"> <a href="PIXI.Texture.html">Texture</a> </li> <li class="class-depth-1"> <a href="PIXI.TilingSprite.html">TilingSprite</a> </li> <li class="class-depth-1"> <a href="PIXI.VideoTexture.html">VideoTexture</a> </li> <li class="class-depth-1"> <a href="PIXI.WebGLBlendModeManager.html">WebGLBlendModeManager</a> </li> <li class="class-depth-1"> <a href="PIXI.WebGLFastSpriteBatch.html">WebGLFastSpriteBatch</a> </li> <li class="class-depth-1"> <a href="PIXI.WebGLFilterManager.html">WebGLFilterManager</a> </li> <li class="class-depth-1"> <a href="PIXI.WebGLRenderer.html">WebGLRenderer</a> </li> <li class="class-depth-0"> <a href="RoundedRectangle.html">RoundedRectangle</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#append">append</a> </li> <li class="class-depth-0"> <a href="global.html#apply">apply</a> </li> <li class="class-depth-0"> <a href="global.html#applyInverse">applyInverse</a> </li> <li class="class-depth-0"> <a href="global.html#blendModes">blendModes</a> </li> <li class="class-depth-0"> <a href="global.html#clone">clone</a> </li> <li class="class-depth-0"> <a href="global.html#contains">contains</a> </li> <li class="class-depth-0"> <a href="global.html#fromArray">fromArray</a> </li> <li class="class-depth-0"> <a href="global.html#identity">identity</a> </li> <li class="class-depth-0"> <a href="global.html#rotate">rotate</a> </li> <li class="class-depth-0"> <a href="global.html#scale">scale</a> </li> <li class="class-depth-0"> <a href="global.html#scaleModes">scaleModes</a> </li> <li class="class-depth-0"> <a href="global.html#sort">sort</a> </li> <li class="class-depth-0"> <a href="global.html#toArray">toArray</a> </li> <li class="class-depth-0"> <a href="global.html#translate">translate</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.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.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.Rectangle.html">Rectangle</a></li> <li class="class-depth-1"><a href="Phaser.Point.html">Point</a></li> <li class="class-depth-1"><a href="Phaser.Line.html">Line</a></li> <li class="class-depth-1"><a href="Phaser.Ellipse.html">Ellipse</a></li> <li class="class-depth-1"><a href="Phaser.Polygon.html">Polygon</a></li> </ul> </li> <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.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">Weekly Coding Tips</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.gittip.com/photonstorm/">Donate to the project</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: Group</h1>--> <section> <header> <h2> <span class="ancestors"><a href="Phaser.html">Phaser</a>.</span> Group </h2> </header> <article> <div class="container-overview"> <dt> <h4 class="name " id="Group"><span class="type-signature"></span>new Group<span class="signature">(game, <span class="optional">parent</span>, <span class="optional">name</span>, <span class="optional">addToStage</span>, <span class="optional">enableBody</span>, <span class="optional">physicsBodyType</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>A Group is a container for <a href="global.html#DisplayObject">display objects</a> including <a href="Phaser.Sprite.html">Sprites</a> and <a href="Phaser.Image.html">Images</a>.</p> <p>Groups form the logical tree structure of the display/scene graph where local transformations are applied to children. For instance, all children are also moved/rotated/scaled when the group is moved/rotated/scaled.</p> <p>In addition, Groups provides support for fast pooling and object recycling.</p> <p>Groups are also display objects and can be nested as children within other Groups.</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>game</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>A reference to the currently running game.</p></td> </tr> <tr> <td class="name"><code>parent</code></td> <td class="type"> <span class="param-type"><a href="global.html#DisplayObject">DisplayObject</a></span> | <span class="param-type">null</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> (game world) </td> <td class="description last"><p>The parent Group (or other <a href="global.html#DisplayObject">DisplayObject</a>) that this group will be added to. If undefined/unspecified the Group will be added to the <a href="Phaser.Game.html#world">Game World</a>; if null the Group will not be added to any parent.</p></td> </tr> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 'group' </td> <td class="description last"><p>A name for this group. Not used internally but useful for debugging.</p></td> </tr> <tr> <td class="name"><code>addToStage</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>If true this group will be added directly to the Game.Stage instead of Game.World.</p></td> </tr> <tr> <td class="name"><code>enableBody</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>If true all Sprites created with #create or {@link #createMulitple} will have a physics body created on them. Change the body type with #physicsBodyType.</p></td> </tr> <tr> <td class="name"><code>physicsBodyType</code></td> <td class="type"> <span class="param-type">integer</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last"><p>The physics body type to use when physics bodies are automatically added. See #physicsBodyType for values.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-27">line 27</a> </dt> </dl> </dd> </div> <h3 class="subsection-title">Extends</h3> <ul> <li><a href="PIXI.DisplayObjectContainer.html">PIXI.DisplayObjectContainer</a></li> </ul> <h3 class="subsection-title">Members</h3> <dl> <dt> <h4 class="name " id="RETURN_CHILD"><span class="type-signature"><static, constant> </span>RETURN_CHILD<span class="type-signature"> :integer</span></h4> </dt> <dd> <div class="description"> <p>A returnType value, as specified in <a href="Phaser.Group.html#iterate">iterate</a> eg.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-226">line 226</a> </dt> </dl> </dd> <dt> <h4 class="name " id="RETURN_NONE"><span class="type-signature"><static, constant> </span>RETURN_NONE<span class="type-signature"> :integer</span></h4> </dt> <dd> <div class="description"> <p>A returnType value, as specified in <a href="Phaser.Group.html#iterate">iterate</a> eg.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-212">line 212</a> </dt> </dl> </dd> <dt> <h4 class="name " id="RETURN_TOTAL"><span class="type-signature"><static, constant> </span>RETURN_TOTAL<span class="type-signature"> :integer</span></h4> </dt> <dd> <div class="description"> <p>A returnType value, as specified in <a href="Phaser.Group.html#iterate">iterate</a> eg.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-219">line 219</a> </dt> </dl> </dd> <dt> <h4 class="name " id="SORT_ASCENDING"><span class="type-signature"><static, constant> </span>SORT_ASCENDING<span class="type-signature"> :integer</span></h4> </dt> <dd> <div class="description"> <p>A sort ordering value, as specified in <a href="Phaser.Group.html#sort">sort</a> eg.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-233">line 233</a> </dt> </dl> </dd> <dt> <h4 class="name " id="SORT_DESCENDING"><span class="type-signature"><static, constant> </span>SORT_DESCENDING<span class="type-signature"> :integer</span></h4> </dt> <dd> <div class="description"> <p>A sort ordering value, as specified in <a href="Phaser.Group.html#sort">sort</a> eg.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-240">line 240</a> </dt> </dl> </dd> <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>The alive property is useful for Groups that are children of other Groups and need to be included/excluded in checks like forEachAlive.</p> </div> <dl class="details"> <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_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-92">line 92</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 alpha value of the group container.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-2100">line 2100</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 of rotation of the group container, in degrees.</p> <p>This adjusts the group itself by modifying its local rotation transform.</p> <p>This has no impact on the rotation/angle properties of the children, but it will update their worldTransform and on-screen orientation and position.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-2032">line 2032</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-336">line 336</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>If this object is <a href="Phaser.Group.html#fixedToCamera">fixedToCamera</a> then this stores the x/y position offset relative to the top-left of the camera view. If the parent of this Group is also <code>fixedToCamera</code> then the offset here is in addition to that and should typically be disabled.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-186">line 186</a> </dt> </dl> </dd> <dt> <h4 class="name " id="children"><span class="type-signature"><readonly> </span>children<span class="type-signature"> :Array.<<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.<<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="classType"><span class="type-signature"></span>classType<span class="type-signature"> :object</span></h4> </dt> <dd> <div class="description"> <p>The type of objects that will be created when using <a href="Phaser.Group.html#create">create</a> or <a href="Phaser.Group.html#createMultiple">createMultiple</a>.</p> <p>Any object may be used but it should extend either Sprite or Image and accept the same constructor arguments: when a new object is created it is passed the following parameters to its constructor: <code>(game, x, y, key, frame)</code>.</p> </div> <dl class="details"> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li><a href="Phaser.Sprite.html">Phaser.Sprite</a></li></ul></dd> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-117">line 117</a> </dt> </dl> </dd> <dt> <h4 class="name " id="cursor"><span class="type-signature"></span>cursor<span class="type-signature"> :<a href="global.html#DisplayObject">DisplayObject</a></span></h4> </dt> <dd> <div class="description"> <p>The current display object that the group cursor is pointing to, if any. (Can be set manually.)</p> <p>The cursor is a way to iterate through the children in a Group using <a href="Phaser.Group.html#next">next</a> and <a href="Phaser.Group.html#previous">previous</a>.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-132">line 132</a> </dt> </dl> </dd> <dt> <h4 class="name " id="cursorIndex"><span class="type-signature"><readonly> </span>cursorIndex<span class="type-signature"> :integer</span></h4> </dt> <dd> <div class="description"> <p>The current index of the Group cursor. Advance it with Group.next.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-169">line 169</a> </dt> </dl> </dd> <dt> <h4 class="name " id="enableBody"><span class="type-signature"></span>enableBody<span class="type-signature"> :boolean</span></h4> </dt> <dd> <div class="description"> <p>If true all Sprites created by, or added to this group, will have a physics body enabled on them.</p> <p>The default body type is controlled with <a href="Phaser.Group.html#physicsBodyType">physicsBodyType</a>.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-140">line 140</a> </dt> </dl> </dd> <dt> <h4 class="name " id="enableBodyDebug"><span class="type-signature"></span>enableBodyDebug<span class="type-signature"> :boolean</span></h4> </dt> <dd> <div class="description"> <p>If true when a physics body is created (via <a href="Phaser.Group.html#enableBody">enableBody</a>) it will create a physics debug object as well.</p> <p>This only works for P2 bodies.</p> </div> <dl class="details"> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-149">line 149</a> </dt> </dl> </dd> <dt> <h4 class="name " id="exists"><span class="type-signature"></span>exists<span class="type-signature"> :boolean</span></h4> </dt> <dd> <div class="description"> <p>If exists is true the group is updated, otherwise it is skipped.</p> </div> <dl class="details"> <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_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-99">line 99</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-153">line 153</a> </dt> </dl> </dd> <dt> <h4 class="name " id="filters"><span class="type-signature"></span>filters<span class="type-signature"> :Array.<Filter></span></h4> </dt> <dd> <div class="description"> <p>Sets the filters for the displayObject. IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer. To remove filters simply set this property to 'null'</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Array.<Filter></span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="PIXI.DisplayObject.html#filters">PIXI.DisplayObject#filters</a> </li></dd> <dt class="tag-source">Source - <a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-298">line 298</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 Group that is fixed to the camera uses its x/y coordinates as offsets from the top left of the camera. These are stored in Group.cameraOffset.</p> <p>Note that the cameraOffset values are in addition to any parent in the display list. So if this Group was in a Group that has x: 200, then this will be added to the cameraOffset.x</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-179">line 179</a> </dt> </dl> </dd> <dt> <h4 class="name " id="game"><span class="type-signature"><internal> </span>game<span class="type-signature"> :<a href="Phaser.Game.html">Phaser.Game</a></span></h4> </dt> <dd> <div class="description"> <p>A reference to the currently running Game.</p> </div> <dl class="details"> <dt class="important tag-deprecated">Internal:</dt> <dd class="tag-deprecated"><ul> <li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li> </ul></dd> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-38">line 38</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 displayObjectContainer, 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.DisplayObjectContainer.html#height">PIXI.DisplayObjectContainer#height</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-62">line 62</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="ignoreDestroy"><span class="type-signature"></span>ignoreDestroy<span class="type-signature"> :boolean</span></h4> </dt> <dd> <div class="description"> <p>A group with <code>ignoreDestroy</code> set to <code>true</code> ignores all calls to its <code>destroy</code> method.</p> </div> <dl class="details"> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-106">line 106</a> </dt> </dl> </dd> <dt> <h4 class="name " id="length"><span class="type-signature"><readonly> </span>length<span class="type-signature"> :integer</span></h4> </dt> <dd> <div class="description"> <p>Total number of children in this group, regardless of exists/alive status.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-2015">line 2015</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-273">line 273</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 name for this group. Not used internally but useful for debugging.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-49">line 49</a> </dt> </dl> </dd> <dt> <h4 class="name " id="onDestroy"><span class="type-signature"></span>onDestroy<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4> </dt> <dd> <div class="description"> <p>This signal is dispatched when the group is destroyed.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-163">line 163</a> </dt> </dl> </dd> <dt> <h4 class="name " id="parent"><span class="type-signature"><readonly> </span>parent<span class="type-signature"> :<a href="PIXI.DisplayObjectContainer.html">PIXI.DisplayObjectContainer</a></span></h4> </dt> <dd> <div class="description"> <p>[read-only] The display object container that contains this display object.</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="PIXI.DisplayObject.html#parent">PIXI.DisplayObject#parent</a> </li></dd> <dt class="tag-source">Source - <a href="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="physicsBodyType"><span class="type-signature"></span>physicsBodyType<span class="type-signature"> :integer</span></h4> </dt> <dd> <div class="description"> <p>If <a href="Phaser.Group.html#enableBody">enableBody</a> is true this is the type of physics body that is created on new Sprites.</p> <p>The valid values are <a href="Phaser.Physics.html#ARCADE">Phaser.Physics.ARCADE</a>, <a href="Phaser.Physics.P2.html">Phaser.Physics.P2</a>, <a href="Phaser.Physics.html#NINJA">Phaser.Physics.NINJA</a>, etc.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-157">line 157</a> </dt> </dl> </dd> <dt> <h4 class="name " id="physicsType"><span class="type-signature"><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_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-85">line 85</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="renderable"><span class="type-signature"></span>renderable<span class="type-signature"> :Boolean</span></h4> </dt> <dd> <div class="description"> <p>Can this object be rendered</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="PIXI.DisplayObject.html#renderable">PIXI.DisplayObject#renderable</a> </li></dd> <dt class="tag-source">Source - <a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-90">line 90</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 angle of rotation of the group container, in radians.</p> <p>This will adjust the group container itself by modifying its rotation. This will have no impact on the rotation value of its children, but it will update their worldTransform and on-screen position.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-2084">line 2084</a> </dt> </dl> </dd> <dt> <h4 class="name " id="scale"><span class="type-signature"></span>scale<span class="type-signature"> :<a href="Phaser.Point.html">Phaser.Point</a></span></h4> </dt> <dd> <div class="description"> <p>The scale of the group container.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-124">line 124</a> </dt> </dl> </dd> <dt> <h4 class="name " id="stage"><span class="type-signature"><readonly> </span>stage<span class="type-signature"> :<a href="PIXI.Stage.html">PIXI.Stage</a></span></h4> </dt> <dd> <div class="description"> <p>[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="PIXI.DisplayObject.html#stage">PIXI.DisplayObject#stage</a> </li></dd> <dt class="tag-source">Source - <a href="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="total"><span class="type-signature"><readonly> </span>total<span class="type-signature"> :integer</span></h4> </dt> <dd> <div class="description"> <p>Total number of existing children in the group.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1998">line 1998</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"><internal> </span>type<span class="type-signature"> :integer</span></h4> </dt> <dd> <div class="description"> <p>Internal Phaser Type value.</p> </div> <dl class="details"> <dt class="important tag-deprecated">Internal:</dt> <dd class="tag-deprecated"><ul> <li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li> </ul></dd> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-79">line 79</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 visible state of the group. Non-visible Groups and all of their children are not rendered.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-2093">line 2093</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 displayObjectContainer, 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.DisplayObjectContainer.html#width">PIXI.DisplayObjectContainer#width</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-32">line 32</a> </dt> </dl> </dd> <dt> <h4 class="name " id="worldAlpha"><span class="type-signature"><readonly> </span>worldAlpha<span class="type-signature"> :Number</span></h4> </dt> <dd> <div class="description"> <p>[read-only] The multiplied alpha of the displayObject</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="PIXI.DisplayObject.html#worldAlpha">PIXI.DisplayObject#worldAlpha</a> </li></dd> <dt class="tag-source">Source - <a href="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="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-249">line 249</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 x coordinate of the group container.</p> <p>You can adjust the group container itself by modifying its coordinates. This will have no impact on the x/y coordinates of its children, but it will update their worldTransform and on-screen position.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-2066">line 2066</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 y coordinate of the group container.</p> <p>You can adjust the group container itself by modifying its coordinates. This will have no impact on the x/y coordinates of its children, but it will update their worldTransform and on-screen position.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-2075">line 2075</a> </dt> </dl> </dd> <dt> <h4 class="name " id="z"><span class="type-signature"></span>z<span class="type-signature"> :integer</span></h4> </dt> <dd> <div class="description"> <p>The z-depth value of this object within its parent container/Group - the World is a Group as well. This value must be unique for each child in a Group.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-56">line 56</a> </dt> </dl> </dd> </dl> <h3 class="subsection-title">Methods</h3> <dl> <dt> <h4 class="name " id="add"><span class="type-signature"></span>add<span class="signature">(child, <span class="optional">silent</span>)</span><span class="type-signature"> → {<a href="global.html#DisplayObject">DisplayObject</a>}</span></h4> </dt> <dd> <div class="description"> <p>Adds an existing object as the top child in this group.</p> <p>The child is automatically added to the top of the group and is displayed on top of every previous child.</p> <p>Use <a href="Phaser.Group.html#addAt">addAt</a> to control where a child is added. Use <a href="Phaser.Group.html#create">create</a> to create and add a new child.</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>child</code></td> <td class="type"> <span class="param-type"><a href="global.html#DisplayObject">DisplayObject</a></span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The display object to add as a child.</p></td> </tr> <tr> <td class="name"><code>silent</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>If true the child will not dispatch the <code>onAddedToGroup</code> event.</p></td> </tr> </tbody> </table> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type"><a href="global.html#DisplayObject">DisplayObject</a></span> - </div> <div class="returns-desc param-desc"> <p>The child that was added to the group.</p> </div> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-242">line 242</a> </dt> </dl> </dd> <dt> <h4 class="name " id="addAll"><span class="type-signature"></span>addAll<span class="signature">(property, amount, checkAlive, checkVisible)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Adds the amount to the given property on all children in this group.</p> <p><code>Group.addAll('x', 10)</code> will add 10 to the child.x value for each child.</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>property</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"><p>The property to increment, for example 'body.velocity.x' or 'angle'.</p></td> </tr> <tr> <td class="name"><code>amount</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The amount to increment the property by. If child.x = 10 then addAll('x', 40) would make child.x = 50.</p></td> </tr> <tr> <td class="name"><code>checkAlive</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>If true the property will only be changed if the child is alive.</p></td> </tr> <tr> <td class="name"><code>checkVisible</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>If true the property will only be changed if the child is visible.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1020">line 1020</a> </dt> </dl> </dd> <dt> <h4 class="name " id="addAt"><span class="type-signature"></span>addAt<span class="signature">(child, <span class="optional">index</span>, <span class="optional">silent</span>)</span><span class="type-signature"> → {<a href="global.html#DisplayObject">DisplayObject</a>}</span></h4> </dt> <dd> <div class="description"> <p>Adds an existing object to this group.</p> <p>The child is added to the group at the location specified by the index value, this allows you to control child ordering.</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>child</code></td> <td class="type"> <span class="param-type"><a href="global.html#DisplayObject">DisplayObject</a></span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The display object to add as a child.</p></td> </tr> <tr> <td class="name"><code>index</code></td> <td class="type"> <span class="param-type">integer</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last"><p>The index within the group to insert the child to.</p></td> </tr> <tr> <td class="name"><code>silent</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>If true the child will not dispatch the <code>onAddedToGroup</code> event.</p></td> </tr> </tbody> </table> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type"><a href="global.html#DisplayObject">DisplayObject</a></span> - </div> <div class="returns-desc param-desc"> <p>The child that was added to the group.</p> </div> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-312">line 312</a> </dt> </dl> </dd> <dt> <h4 class="name " id="addChild"><span class="type-signature"></span>addChild<span class="signature">(child)</span><span class="type-signature"> → {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4> </dt> <dd> <div class="description"> <p>Adds a child to the container.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>child</code></td> <td class="type"> <span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span> </td> <td class="description last"><p>The DisplayObject to add to the container</p></td> </tr> </tbody> </table> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span> - </div> <div class="returns-desc param-desc"> <p>The child that was added.</p> </div> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="PIXI.DisplayObjectContainer.html#addChild">PIXI.DisplayObjectContainer#addChild</a> </li></dd> <dt class="tag-source">Source - <a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-92">line 92</a> </dt> </dl> </dd> <dt> <h4 class="name " id="addChildAt"><span class="type-signature"></span>addChildAt<span class="signature">(child, index)</span><span class="type-signature"> → {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4> </dt> <dd> <div class="description"> <p>Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>child</code></td> <td class="type"> <span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span> </td> <td class="description last"><p>The child to add</p></td> </tr> <tr> <td class="name"><code>index</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>The index to place the child in</p></td> </tr> </tbody> </table> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span> - </div> <div class="returns-desc param-desc"> <p>The child that was added.</p> </div> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="PIXI.DisplayObjectContainer.html#addChildAt">PIXI.DisplayObjectContainer#addChildAt</a> </li></dd> <dt class="tag-source">Source - <a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-104">line 104</a> </dt> </dl> </dd> <dt> <h4 class="name " id="addMultiple"><span class="type-signature"></span>addMultiple<span class="signature">(children, <span class="optional">silent</span>)</span><span class="type-signature"> → {Array.<<a href="global.html#DisplayObject">DisplayObject</a>>}</span></h4> </dt> <dd> <div class="description"> <p>Adds an array of existing display objects to this group.</p> <p>The children are automatically added to the top of the group, so render on-top of everything else within the group.</p> <p>TODO: Add ability to pass the children as parameters rather than having to be an array.</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>children</code></td> <td class="type"> <span class="param-type">Array.<<a href="global.html#DisplayObject">DisplayObject</a>></span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>An array of display objects to add as children.</p></td> </tr> <tr> <td class="name"><code>silent</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>If true the children will not dispatch the <code>onAddedToGroup</code> event.</p></td> </tr> </tbody> </table> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type">Array.<<a href="global.html#DisplayObject">DisplayObject</a>></span> - </div> <div class="returns-desc param-desc"> <p>The array of children that were added to the group.</p> </div> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-286">line 286</a> </dt> </dl> </dd> <dt> <h4 class="name " id="ascendingSortHandler"><span class="type-signature"><internal> </span>ascendingSortHandler<span class="signature">(a, b)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>An internal helper function for the sort process.</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>a</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"><p>The first object being sorted.</p></td> </tr> <tr> <td class="name"><code>b</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"><p>The second object being sorted.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="important tag-deprecated">Internal:</dt> <dd class="tag-deprecated"><ul> <li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li> </ul></dd> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1547">line 1547</a> </dt> </dl> </dd> <dt> <h4 class="name " id="bringToTop"><span class="type-signature"></span>bringToTop<span class="signature">(child)</span><span class="type-signature"> → {any}</span></h4> </dt> <dd> <div class="description"> <p>Brings the given child to the top of this group so it renders above all other children.</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">any</span> </td> <td class="description last"><p>The child to bring to the top of this group.</p></td> </tr> </tbody> </table> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type">any</span> - </div> <div class="returns-desc param-desc"> <p>The child that was moved.</p> </div> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-568">line 568</a> </dt> </dl> </dd> <dt> <h4 class="name " id="callAll"><span class="type-signature"></span>callAll<span class="signature">(method, <span class="optional">context</span>, args)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Calls a function, specified by name, on all on children.</p> <p>The function is called for all children regardless if they are dead or alive (see callAllExists for different options). After the method parameter and context you can add as many extra parameters as you like, which will all be passed to the child.</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>method</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>Name of the function on the child to call. Deep property lookup is supported.</p></td> </tr> <tr> <td class="name"><code>context</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last"><p>A string containing the context under which the method will be executed. Set to null to default to the child.</p></td> </tr> <tr> <td class="name"><code>args</code></td> <td class="type"> <span class="param-type">any</span> </td> <td class="attributes"> <repeatable><br> </td> <td class="default"> </td> <td class="description last"><p>Additional parameters that will be passed to the method.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1175">line 1175</a> </dt> </dl> </dd> <dt> <h4 class="name " id="callAllExists"><span class="type-signature"></span>callAllExists<span class="signature">(callback, existsValue, parameter)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Calls a function, specified by name, on all children in the group who exist (or do not exist).</p> <p>After the existsValue parameter you can add as many parameters as you like, which will all be passed to the child callback.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last"><p>Name of the function on the children to call.</p></td> </tr> <tr> <td class="name"><code>existsValue</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> </td> <td class="description last"><p>Only children with exists=existsValue will be called.</p></td> </tr> <tr> <td class="name"><code>parameter</code></td> <td class="type"> <span class="param-type">any</span> </td> <td class="attributes"> <repeatable><br> </td> <td class="description last"><p>Additional parameters that will be passed to the callback.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1088">line 1088</a> </dt> </dl> </dd> <dt> <h4 class="name " id="callbackFromArray"><span class="type-signature"><internal> </span>callbackFromArray<span class="signature">(child, callback, length)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Returns a reference to a function that exists on a child of the group based on the given callback array.</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">object</span> </td> <td class="description last"><p>The object to inspect.</p></td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">array</span> </td> <td class="description last"><p>The array of function names.</p></td> </tr> <tr> <td class="name"><code>length</code></td> <td class="type"> <span class="param-type">integer</span> </td> <td class="description last"><p>The size of the array (pre-calculated in callAll).</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="important tag-deprecated">Internal:</dt> <dd class="tag-deprecated"><ul> <li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li> </ul></dd> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1122">line 1122</a> </dt> </dl> </dd> <dt> <h4 class="name " id="checkAll"><span class="type-signature"></span>checkAll<span class="signature">(key, value, <span class="optional">checkAlive</span>, <span class="optional">checkVisible</span>, <span class="optional">force</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Quickly check that the same property across all children of this group is equal to the given value.</p> <p>This call doesn't descend down children, so if you have a Group inside of this group, the property will be checked on the group but not its children.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The property, as a string, to be set. For example: 'body.velocity.x'</p></td> </tr> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">any</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The value that will be checked.</p></td> </tr> <tr> <td class="name"><code>checkAlive</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>If set then only children with alive=true will be checked. This includes any Groups that are children.</p></td> </tr> <tr> <td class="name"><code>checkVisible</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>If set then only children with visible=true will be checked. This includes any Groups that are children.</p></td> </tr> <tr> <td class="name"><code>force</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>If <code>force</code> is true then the property will be checked on the child regardless if it already exists or not. If true and the property doesn't exist, false will be returned.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-987">line 987</a> </dt> </dl> </dd> <dt> <h4 class="name " id="checkProperty"><span class="type-signature"></span>checkProperty<span class="signature">(child, key, value, <span class="optional">force</span>)</span><span class="type-signature"> → {boolean}</span></h4> </dt> <dd> <div class="description"> <p>Checks a property for the given value on the child.</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>child</code></td> <td class="type"> <span class="param-type">any</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The child to check the property value on.</p></td> </tr> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">array</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>An array of strings that make up the property that will be set.</p></td> </tr> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">any</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The value that will be checked.</p></td> </tr> <tr> <td class="name"><code>force</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>If <code>force</code> is true then the property will be checked on the child regardless if it already exists or not. If true and the property doesn't exist, false will be returned.</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 property was was equal to value, false if not.</p> </div> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-851">line 851</a> </dt> </dl> </dd> <dt> <h4 class="name " id="countDead"><span class="type-signature"></span>countDead<span class="signature">()</span><span class="type-signature"> → {integer}</span></h4> </dt> <dd> <div class="description"> <p>Get the number of dead children in this group.</p> </div> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type">integer</span> - </div> <div class="returns-desc param-desc"> <p>The number of children flagged as dead.</p> </div> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1769">line 1769</a> </dt> </dl> </dd> <dt> <h4 class="name " id="countLiving"><span class="type-signature"></span>countLiving<span class="signature">()</span><span class="type-signature"> → {integer}</span></h4> </dt> <dd> <div class="description"> <p>Get the number of living children in this group.</p> </div> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type">integer</span> - </div> <div class="returns-desc param-desc"> <p>The number of children flagged as alive.</p> </div> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1757">line 1757</a> </dt> </dl> </dd> <dt> <h4 class="name " id="create"><span class="type-signature"></span>create<span class="signature">(x, y, key, <span class="optional">frame</span>, <span class="optional">exists</span>)</span><span class="type-signature"> → {<a href="global.html#DisplayObject">DisplayObject</a>}</span></h4> </dt> <dd> <div class="description"> <p>Creates a new Phaser.Sprite object and adds it to the top of this group.</p> <p>Use <a href="Phaser.Group.html#classType">classType</a> to change the type of object creaded.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>x</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The x coordinate to display the newly created Sprite at. The value is in relation to the group.x point.</p></td> </tr> <tr> <td class="name"><code>y</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The y coordinate to display the newly created Sprite at. The value is in relation to the group.y point.</p></td> </tr> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The Game.cache key of the image that this Sprite will use.</p></td> </tr> <tr> <td class="name"><code>frame</code></td> <td class="type"> <span class="param-type">integer</span> | <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"><p>If the Sprite image contains multiple frames you can specify which one to use here.</p></td> </tr> <tr> <td class="name"><code>exists</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> true </td> <td class="description last"><p>The default exists state of the Sprite.</p></td> </tr> </tbody> </table> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type"><a href="global.html#DisplayObject">DisplayObject</a></span> - </div> <div class="returns-desc param-desc"> <p>The child that was created: will be a <a href="Phaser.Sprite.html">Phaser.Sprite</a> unless #classType has been changed.</p> </div> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-375">line 375</a> </dt> </dl> </dd> <dt> <h4 class="name " id="createMultiple"><span class="type-signature"></span>createMultiple<span class="signature">(quantity, key, <span class="optional">frame</span>, <span class="optional">exists</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Creates multiple Phaser.Sprite objects and adds them to the top of this group.</p> <p>Useful if you need to quickly generate a pool of identical sprites, such as bullets.</p> <p>By default the sprites will be set to not exist and will be positioned at 0, 0 (relative to the group.x/y). Use <a href="Phaser.Group.html#classType">classType</a> to change the type of object creaded.</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>quantity</code></td> <td class="type"> <span class="param-type">integer</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The number of Sprites to create.</p></td> </tr> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The Game.cache key of the image that this Sprite will use.</p></td> </tr> <tr> <td class="name"><code>frame</code></td> <td class="type"> <span class="param-type">integer</span> | <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"><p>If the Sprite image contains multiple frames you can specify which one to use here.</p></td> </tr> <tr> <td class="name"><code>exists</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>The default exists state of the Sprite.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-423">line 423</a> </dt> </dl> </dd> <dt> <h4 class="name " id="customSort"><span class="type-signature"></span>customSort<span class="signature">(sortHandler, <span class="optional">context</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Sort the children in the group according to custom sort function.</p> <p>The <code>sortHandler</code> is provided the two parameters: the two children involved in the comparison (a and b). It should return -1 if <code>a > b</code>, 1 if <code>a < b</code> or 0 if <code>a === b</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>sortHandler</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The custom sort function.</p></td> </tr> <tr> <td class="name"><code>context</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> undefined </td> <td class="description last"><p>The context in which the sortHandler is called.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1523">line 1523</a> </dt> </dl> </dd> <dt> <h4 class="name " id="descendingSortHandler"><span class="type-signature"><internal> </span>descendingSortHandler<span class="signature">(a, b)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>An internal helper function for the sort process.</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>a</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"><p>The first object being sorted.</p></td> </tr> <tr> <td class="name"><code>b</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"><p>The second object being sorted.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="important tag-deprecated">Internal:</dt> <dd class="tag-deprecated"><ul> <li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li> </ul></dd> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1579">line 1579</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 class="optional">soft</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Destroys this group.</p> <p>Removes all children, then removes this group from its parent and nulls references.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>destroyChildren</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> true </td> <td class="description last"><p>If true <code>destroy</code> will be invoked on each removed child.</p></td> </tr> <tr> <td class="name"><code>soft</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>A 'soft destroy' (set to true) doesn't remove this group from its parent or null the game reference. Set to false and it does.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1962">line 1962</a> </dt> </dl> </dd> <dt> <h4 class="name " id="divideAll"><span class="type-signature"></span>divideAll<span class="signature">(property, amount, checkAlive, checkVisible)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Divides the given property by the amount on all children in this group.</p> <p><code>Group.divideAll('x', 2)</code> will half the child.x value for each child.</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>property</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"><p>The property to divide, for example 'body.velocity.x' or 'angle'.</p></td> </tr> <tr> <td class="name"><code>amount</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The amount to divide the property by. If child.x = 100 then divideAll('x', 2) would make child.x = 50.</p></td> </tr> <tr> <td class="name"><code>checkAlive</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>If true the property will only be changed if the child is alive.</p></td> </tr> <tr> <td class="name"><code>checkVisible</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>If true the property will only be changed if the child is visible.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1071">line 1071</a> </dt> </dl> </dd> <dt> <h4 class="name " id="filter"><span class="type-signature"></span>filter<span class="signature">(predicate, <span class="optional">checkExists</span>)</span><span class="type-signature"> → {<a href="Phaser.ArraySet.html">Phaser.ArraySet</a>}</span></h4> </dt> <dd> <div class="description"> <p>Find children matching a certain predicate.</p> <p>For example:</p> <pre class="prettyprint source"><code>var healthyList = Group.filter(function(child, index, children) { return child.health > 10 ? true : false; }, true); healthyList.callAll('attack');</code></pre><p>Note: Currently this will skip any children which are Groups themselves.</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>predicate</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The function that each child will be evaluated against. Each child of the group will be passed to it as its first parameter, the index as the second, and the entire child array as the third</p></td> </tr> <tr> <td class="name"><code>checkExists</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>If true, only existing can be selected; otherwise all children can be selected and will be passed to the predicate.</p></td> </tr> </tbody> </table> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type"><a href="Phaser.ArraySet.html">Phaser.ArraySet</a></span> - </div> <div class="returns-desc param-desc"> <p>Returns an array list containing all the children that the predicate returned true for</p> </div> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1312">line 1312</a> </dt> </dl> </dd> <dt> <h4 class="name " id="forEach"><span class="type-signature"></span>forEach<span class="signature">(callback, callbackContext, <span class="optional">checkExists</span>, <span class="optional">args</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Call a function on each child in this group.</p> <p>Additional arguments for the callback can be specified after the <code>checkExists</code> parameter. For example,</p> <pre class="prettyprint source"><code>Group.forEach(awardBonusGold, this, true, 100, 500)</code></pre><p>would invoke <code>awardBonusGold</code> function with the parameters <code>(child, 100, 500)</code>.</p> <p>Note: This check will skip any children which are Groups themselves.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The function that will be called for each applicable child. The child will be passed as the first argument.</p></td> </tr> <tr> <td class="name"><code>callbackContext</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The context in which the function should be called (usually 'this').</p></td> </tr> <tr> <td class="name"><code>checkExists</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>If set only children matching for which <code>exists</code> is true will be passed to the callback, otherwise all children will be passed.</p></td> </tr> <tr> <td class="name"><code>args</code></td> <td class="type"> <span class="param-type">any</span> </td> <td class="attributes"> <optional><br> <repeatable><br> </td> <td class="default"> (none) </td> <td class="description last"><p>Additional arguments to pass to the callback function, after the child item.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1352">line 1352</a> </dt> </dl> </dd> <dt> <h4 class="name " id="forEachAlive"><span class="type-signature"></span>forEachAlive<span class="signature">(callback, callbackContext, <span class="optional">args</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Call a function on each alive child in this group.</p> <p>See <a href="Phaser.Group.html#forEach">forEach</a> for details.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The function that will be called for each applicable child. The child will be passed as the first argument.</p></td> </tr> <tr> <td class="name"><code>callbackContext</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The context in which the function should be called (usually 'this').</p></td> </tr> <tr> <td class="name"><code>args</code></td> <td class="type"> <span class="param-type">any</span> </td> <td class="attributes"> <optional><br> <repeatable><br> </td> <td class="default"> (none) </td> <td class="description last"><p>Additional arguments to pass to the callback function, after the child item.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1431">line 1431</a> </dt> </dl> </dd> <dt> <h4 class="name " id="forEachDead"><span class="type-signature"></span>forEachDead<span class="signature">(callback, callbackContext, <span class="optional">args</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Call a function on each dead child in this group.</p> <p>See <a href="Phaser.Group.html#forEach">forEach</a> for details.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The function that will be called for each applicable child. The child will be passed as the first argument.</p></td> </tr> <tr> <td class="name"><code>callbackContext</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The context in which the function should be called (usually 'this').</p></td> </tr> <tr> <td class="name"><code>args</code></td> <td class="type"> <span class="param-type">any</span> </td> <td class="attributes"> <optional><br> <repeatable><br> </td> <td class="default"> (none) </td> <td class="description last"><p>Additional arguments to pass to the callback function, after the child item.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1459">line 1459</a> </dt> </dl> </dd> <dt> <h4 class="name " id="forEachExists"><span class="type-signature"></span>forEachExists<span class="signature">(callback, callbackContext, <span class="optional">args</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Call a function on each existing child in this group.</p> <p>See <a href="Phaser.Group.html#forEach">forEach</a> for details.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The function that will be called for each applicable child. The child will be passed as the first argument.</p></td> </tr> <tr> <td class="name"><code>callbackContext</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The context in which the function should be called (usually 'this').</p></td> </tr> <tr> <td class="name"><code>args</code></td> <td class="type"> <span class="param-type">any</span> </td> <td class="attributes"> <optional><br> <repeatable><br> </td> <td class="default"> (none) </td> <td class="description last"><p>Additional arguments to pass to the callback function, after the child item.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1403">line 1403</a> </dt> </dl> </dd> <dt> <h4 class="name " id="generateTexture"><span class="type-signature"></span>generateTexture<span class="signature">(resolution, scaleMode, renderer)</span><span class="type-signature"> → {<a href="PIXI.Texture.html">PIXI.Texture</a>}</span></h4> </dt> <dd> <div class="description"> <p>Useful function that returns a texture of the displayObject object that can then be used to create sprites This can be quite useful if your displayObject is static / complicated and needs to be reused multiple times.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>resolution</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>The resolution of the texture being generated</p></td> </tr> <tr> <td class="name"><code>scaleMode</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values</p></td> </tr> <tr> <td class="name"><code>renderer</code></td> <td class="type"> <span class="param-type"><a href="PIXI.CanvasRenderer.html">PIXI.CanvasRenderer</a></span> | <span class="param-type"><a href="PIXI.WebGLRenderer.html">PIXI.WebGLRenderer</a></span> </td> <td class="description last"><p>The renderer used to generate the texture.</p></td> </tr> </tbody> </table> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type"><a href="PIXI.Texture.html">PIXI.Texture</a></span> - </div> <div class="returns-desc param-desc"> <p>a texture of the graphics object</p> </div> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="PIXI.DisplayObject.html#generateTexture">PIXI.DisplayObject#generateTexture</a> </li></dd> <dt class="tag-source">Source - <a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-495">line 495</a> </dt> </dl> </dd> <dt> <h4 class="name " id="getAt"><span class="type-signature"></span>getAt<span class="signature">(index)</span><span class="type-signature"> → {<a href="global.html#DisplayObject">DisplayObject</a>}</span></h4> </dt> <dd> <div class="description"> <p>Returns the child found at the given index within this group.</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">integer</span> </td> <td class="description last"><p>The index to return the child from.</p></td> </tr> </tbody> </table> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type"><a href="global.html#DisplayObject">DisplayObject</a></span> - </div> <div class="returns-desc param-desc"> <p>The child that was found at the given index, or -1 for an invalid index.</p> </div> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-355">line 355</a> </dt> </dl> </dd> <dt> <h4 class="name " id="getBottom"><span class="type-signature"></span>getBottom<span class="signature">()</span><span class="type-signature"> → {any}</span></h4> </dt> <dd> <div class="description"> <p>Returns the child at the bottom of this group.</p> <p>The bottom child the child being displayed (rendered) below every other child.</p> </div> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type">any</span> - </div> <div class="returns-desc param-desc"> <p>The child at the bottom of the Group.</p> </div> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1740">line 1740</a> </dt> </dl> </dd> <dt> <h4 class="name " id="getBounds"><span class="type-signature"></span>getBounds<span class="signature">()</span><span class="type-signature"> → {Rectangle}</span></h4> </dt> <dd> <div class="description"> <p>Retrieves the bounds of the displayObjectContainer as a rectangle. The bounds 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#getBounds">PIXI.DisplayObjectContainer#getBounds</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-304">line 304</a> </dt> </dl> </dd> <dt> <h4 class="name " id="getChildAt"><span class="type-signature"></span>getChildAt<span class="signature">(index)</span><span class="type-signature"> → {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4> </dt> <dd> <div class="description"> <p>Returns the child at the specified index</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>index</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>The index to get the child from</p></td> </tr> </tbody> </table> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span> - </div> <div class="returns-desc param-desc"> <p>The child at the given index, if any.</p> </div> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="PIXI.DisplayObjectContainer.html#getChildAt">PIXI.DisplayObjectContainer#getChildAt</a> </li></dd> <dt class="tag-source">Source - <a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-195">line 195</a> </dt> </dl> </dd> <dt> <h4 class="name " id="getChildIndex"><span class="type-signature"></span>getChildIndex<span class="signature">(child)</span><span class="type-signature"> → {Number}</span></h4> </dt> <dd> <div class="description"> <p>Returns the index position of a child DisplayObject instance</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>child</code></td> <td class="type"> <span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span> </td> <td class="description last"><p>The DisplayObject instance to identify</p></td> </tr> </tbody> </table> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type">Number</span> - </div> <div class="returns-desc param-desc"> <p>The index position of the child display object to identify</p> </div> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="PIXI.DisplayObjectContainer.html#getChildIndex">PIXI.DisplayObjectContainer#getChildIndex</a> </li></dd> <dt class="tag-source">Source - <a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-160">line 160</a> </dt> </dl> </dd> <dt> <h4 class="name " id="getFirstAlive"><span class="type-signature"></span>getFirstAlive<span class="signature">()</span><span class="type-signature"> → {any}</span></h4> </dt> <dd> <div class="description"> <p>Get the first child that is alive (<code>child.alive === true</code>).</p> <p>This is handy for checking if everything has been wiped out, or choosing a squad leader, etc.</p> </div> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type">any</span> - </div> <div class="returns-desc param-desc"> <p>The first alive child, or null if none found.</p> </div> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1695">line 1695</a> </dt> </dl> </dd> <dt> <h4 class="name " id="getFirstDead"><span class="type-signature"></span>getFirstDead<span class="signature">()</span><span class="type-signature"> → {any}</span></h4> </dt> <dd> <div class="description"> <p>Get the first child that is dead (<code>child.alive === false</code>).</p> <p>This is handy for checking if everything has been wiped out, or choosing a squad leader, etc.</p> </div> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type">any</span> - </div> <div class="returns-desc param-desc"> <p>The first dead child, or null if none found.</p> </div> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1709">line 1709</a> </dt> </dl> </dd> <dt> <h4 class="name " id="getFirstExists"><span class="type-signature"></span>getFirstExists<span class="signature">(<span class="optional">exists</span>)</span><span class="type-signature"> → {any}</span></h4> </dt> <dd> <div class="description"> <p>Get the first display object that exists, or doesn't exist.</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>exists</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> true </td> <td class="description last"><p>If true, find the first existing child; otherwise find the first non-existing child.</p></td> </tr> </tbody> </table> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type">any</span> - </div> <div class="returns-desc param-desc"> <p>The first child, or null if none found.</p> </div> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1677">line 1677</a> </dt> </dl> </dd> <dt> <h4 class="name " id="getIndex"><span class="type-signature"></span>getIndex<span class="signature">(child)</span><span class="type-signature"> → {integer}</span></h4> </dt> <dd> <div class="description"> <p>Get the index position of the given child in this group, which should match the child's <code>z</code> property.</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">any</span> </td> <td class="description last"><p>The child to get the index for.</p></td> </tr> </tbody> </table> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type">integer</span> - </div> <div class="returns-desc param-desc"> <p>The index of the child or -1 if it's not a member of this group.</p> </div> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-690">line 690</a> </dt> </dl> </dd> <dt> <h4 class="name " id="getLocalBounds"><span class="type-signature"></span>getLocalBounds<span class="signature">()</span><span class="type-signature"> → {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-364">line 364</a> </dt> </dl> </dd> <dt> <h4 class="name " id="getRandom"><span class="type-signature"></span>getRandom<span class="signature">(<span class="optional">startIndex</span>, <span class="optional">length</span>)</span><span class="type-signature"> → {any}</span></h4> </dt> <dd> <div class="description"> <p>Returns a random child from the group.</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>startIndex</code></td> <td class="type"> <span class="param-type">integer</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last"><p>Offset from the front of the front of the group (lowest child).</p></td> </tr> <tr> <td class="name"><code>length</code></td> <td class="type"> <span class="param-type">integer</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> (to top) </td> <td class="description last"><p>Restriction on the number of values you want to randomly select from.</p></td> </tr> </tbody> </table> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type">any</span> - </div> <div class="returns-desc param-desc"> <p>A random child of this Group.</p> </div> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1781">line 1781</a> </dt> </dl> </dd> <dt> <h4 class="name " id="getTop"><span class="type-signature"></span>getTop<span class="signature">()</span><span class="type-signature"> → {any}</span></h4> </dt> <dd> <div class="description"> <p>Return the child at the top of this group.</p> <p>The top child is the child displayed (rendered) above every other child.</p> </div> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type">any</span> - </div> <div class="returns-desc param-desc"> <p>The child at the top of the Group.</p> </div> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1723">line 1723</a> </dt> </dl> </dd> <dt> <h4 class="name " id="hasProperty"><span class="type-signature"></span>hasProperty<span class="signature">(child, key)</span><span class="type-signature"> → {boolean}</span></h4> </dt> <dd> <div class="description"> <p>Checks if the child has the given property.</p> <p>Will scan up to 4 levels deep only.</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">any</span> </td> <td class="description last"><p>The child to check for the existance of the property on.</p></td> </tr> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">Array.<string></span> </td> <td class="description last"><p>An array of strings that make up the property.</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 child has the property, otherwise false.</p> </div> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-738">line 738</a> </dt> </dl> </dd> <dt> <h4 class="name " id="iterate"><span class="type-signature"></span>iterate<span class="signature">(key, value, returnType, <span class="optional">callback</span>, <span class="optional">callbackContext</span>, <span class="optional">args</span>)</span><span class="type-signature"> → {any}</span></h4> </dt> <dd> <div class="description"> <p>Iterates over the children of the group performing one of several actions for matched children.</p> <p>A child is considered a match when it has a property, named <code>key</code>, whose value is equal to <code>value</code> according to a strict equality comparison.</p> <p>The result depends on the <code>returnType</code>:</p> <ul> <li><a href="Phaser.Group.html#RETURN_TOTAL">RETURN_TOTAL</a>: The callback, if any, is applied to all matching children. The number of matched children is returned.</li> <li><a href="Phaser.Group.html#RETURN_NONE">RETURN_NONE</a>: The callback, if any, is applied to all matching children. No value is returned.</li> <li><a href="Phaser.Group.html#RETURN_CHILD">RETURN_CHILD</a>: The callback, if any, is applied to the <em>first</em> matching child and the <em>first</em> matched child is returned. If there is no matching child then null is returned.</li> </ul> <p>If <code>args</code> is specified it must be an array. The matched child will be assigned to the first element and the entire array will be applied to the callback function.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The child property to check, i.e. 'exists', 'alive', 'health'</p></td> </tr> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">any</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>A child matches if <code>child[key] === value</code> is true.</p></td> </tr> <tr> <td class="name"><code>returnType</code></td> <td class="type"> <span class="param-type">integer</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>How to iterate the children and what to return.</p></td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last"><p>Optional function that will be called on each matching child. The matched child is supplied as the first argument.</p></td> </tr> <tr> <td class="name"><code>callbackContext</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"><p>The context in which the function should be called (usually 'this').</p></td> </tr> <tr> <td class="name"><code>args</code></td> <td class="type"> <span class="param-type">Array.<any></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> (none) </td> <td class="description last"><p>The arguments supplied to to the callback; the first array index (argument) will be replaced with the matched child.</p></td> </tr> </tbody> </table> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type">any</span> - </div> <div class="returns-desc param-desc"> <p>Returns either an integer (for RETURN_TOTAL), the first matched child (for RETURN_CHILD), or null.</p> </div> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1604">line 1604</a> </dt> </dl> </dd> <dt> <h4 class="name " id="moveDown"><span class="type-signature"></span>moveDown<span class="signature">(child)</span><span class="type-signature"> → {any}</span></h4> </dt> <dd> <div class="description"> <p>Moves the given child down one place in this group unless it's already at the bottom.</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">any</span> </td> <td class="description last"><p>The child to move down in the group.</p></td> </tr> </tbody> </table> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type">any</span> - </div> <div class="returns-desc param-desc"> <p>The child that was moved.</p> </div> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-630">line 630</a> </dt> </dl> </dd> <dt> <h4 class="name " id="moveUp"><span class="type-signature"></span>moveUp<span class="signature">(child)</span><span class="type-signature"> → {any}</span></h4> </dt> <dd> <div class="description"> <p>Moves the given child up one place in this group unless it's already at the top.</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">any</span> </td> <td class="description last"><p>The child to move up in the group.</p></td> </tr> </tbody> </table> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type">any</span> - </div> <div class="returns-desc param-desc"> <p>The child that was moved.</p> </div> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-606">line 606</a> </dt> </dl> </dd> <dt> <h4 class="name " id="multiplyAll"><span class="type-signature"></span>multiplyAll<span class="signature">(property, amount, checkAlive, checkVisible)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Multiplies the given property by the amount on all children in this group.</p> <p><code>Group.multiplyAll('x', 2)</code> will x2 the child.x value for each child.</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>property</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"><p>The property to multiply, for example 'body.velocity.x' or 'angle'.</p></td> </tr> <tr> <td class="name"><code>amount</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The amount to multiply the property by. If child.x = 10 then multiplyAll('x', 2) would make child.x = 20.</p></td> </tr> <tr> <td class="name"><code>checkAlive</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>If true the property will only be changed if the child is alive.</p></td> </tr> <tr> <td class="name"><code>checkVisible</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>If true the property will only be changed if the child is visible.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1054">line 1054</a> </dt> </dl> </dd> <dt> <h4 class="name " id="next"><span class="type-signature"></span>next<span class="signature">()</span><span class="type-signature"> → {any}</span></h4> </dt> <dd> <div class="description"> <p>Advances the group cursor to the next (higher) object in the group.</p> <p>If the cursor is at the end of the group (top child) it is moved the start of the group (bottom child).</p> </div> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type">any</span> - </div> <div class="returns-desc param-desc"> <p>The child the cursor now points to.</p> </div> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-494">line 494</a> </dt> </dl> </dd> <dt> <h4 class="name " id="postUpdate"><span class="type-signature"><internal> </span>postUpdate<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>The core postUpdate - as called by World.</p> </div> <dl class="details"> <dt class="important tag-deprecated">Internal:</dt> <dd class="tag-deprecated"><ul> <li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li> </ul></dd> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1288">line 1288</a> </dt> </dl> </dd> <dt> <h4 class="name " id="preUpdate"><span class="type-signature"><internal> </span>preUpdate<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>The core preUpdate - as called by World.</p> </div> <dl class="details"> <dt class="important tag-deprecated">Internal:</dt> <dd class="tag-deprecated"><ul> <li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li> </ul></dd> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1248">line 1248</a> </dt> </dl> </dd> <dt> <h4 class="name " id="previous"><span class="type-signature"></span>previous<span class="signature">()</span><span class="type-signature"> → {any}</span></h4> </dt> <dd> <div class="description"> <p>Moves the group cursor to the previous (lower) child in the group.</p> <p>If the cursor is at the start of the group (bottom child) it is moved to the end (top child).</p> </div> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type">any</span> - </div> <div class="returns-desc param-desc"> <p>The child the cursor now points to.</p> </div> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-523">line 523</a> </dt> </dl> </dd> <dt> <h4 class="name " id="remove"><span class="type-signature"></span>remove<span class="signature">(child, <span class="optional">destroy</span>, <span class="optional">silent</span>)</span><span class="type-signature"> → {boolean}</span></h4> </dt> <dd> <div class="description"> <p>Removes the given child from this group.</p> <p>This will dispatch an <code>onRemovedFromGroup</code> event from the child (if it has one), and optionally destroy the child.</p> <p>If the group cursor was referring to the removed child it is updated to refer to the next child.</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>child</code></td> <td class="type"> <span class="param-type">any</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The child to remove.</p></td> </tr> <tr> <td class="name"><code>destroy</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>If true <code>destroy</code> will be invoked on the removed child.</p></td> </tr> <tr> <td class="name"><code>silent</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>If true the the child will not dispatch the <code>onRemovedFromGroup</code> event.</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 child was removed from this group, otherwise false.</p> </div> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1803">line 1803</a> </dt> </dl> </dd> <dt> <h4 class="name " id="removeAll"><span class="type-signature"></span>removeAll<span class="signature">(<span class="optional">destroy</span>, <span class="optional">silent</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Removes all children from this group, but does not remove the group from its parent.</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>destroy</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>If true <code>destroy</code> will be invoked on each removed child.</p></td> </tr> <tr> <td class="name"><code>silent</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>If true the children will not dispatch their <code>onRemovedFromGroup</code> events.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1856">line 1856</a> </dt> </dl> </dd> <dt> <h4 class="name " id="removeBetween"><span class="type-signature"></span>removeBetween<span class="signature">(startIndex, <span class="optional">endIndex</span>, <span class="optional">destroy</span>, <span class="optional">silent</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Removes all children from this group whose index falls beteen the given startIndex and endIndex values.</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>startIndex</code></td> <td class="type"> <span class="param-type">integer</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The index to start removing children from.</p></td> </tr> <tr> <td class="name"><code>endIndex</code></td> <td class="type"> <span class="param-type">integer</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"><p>The index to stop removing children at. Must be higher than startIndex. If undefined this method will remove all children between startIndex and the end of the group.</p></td> </tr> <tr> <td class="name"><code>destroy</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>If true <code>destroy</code> will be invoked on each removed child.</p></td> </tr> <tr> <td class="name"><code>silent</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>If true the children will not dispatch their <code>onRemovedFromGroup</code> events.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1902">line 1902</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"> → {<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-212">line 212</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"> → {<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-227">line 227</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-245">line 245</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-404">line 404</a> </dt> </dl> </dd> <dt> <h4 class="name " id="replace"><span class="type-signature"></span>replace<span class="signature">(oldChild, newChild)</span><span class="type-signature"> → {any}</span></h4> </dt> <dd> <div class="description"> <p>Replaces a child of this group with the given newChild. The newChild cannot be a member of this group.</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>oldChild</code></td> <td class="type"> <span class="param-type">any</span> </td> <td class="description last"><p>The child in this group that will be replaced.</p></td> </tr> <tr> <td class="name"><code>newChild</code></td> <td class="type"> <span class="param-type">any</span> </td> <td class="description last"><p>The child to be inserted into this group.</p></td> </tr> </tbody> </table> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type">any</span> - </div> <div class="returns-desc param-desc"> <p>Returns the oldChild that was replaced within this group.</p> </div> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-703">line 703</a> </dt> </dl> </dd> <dt> <h4 class="name " id="resetCursor"><span class="type-signature"></span>resetCursor<span class="signature">(<span class="optional">index</span>)</span><span class="type-signature"> → {any}</span></h4> </dt> <dd> <div class="description"> <p>Sets the group cursor to the first child in the group.</p> <p>If the optional index parameter is given it sets the cursor to the object at that index instead.</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>index</code></td> <td class="type"> <span class="param-type">integer</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last"><p>Set the cursor to point to a specific index.</p></td> </tr> </tbody> </table> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type">any</span> - </div> <div class="returns-desc param-desc"> <p>The child the cursor now points to.</p> </div> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-467">line 467</a> </dt> </dl> </dd> <dt> <h4 class="name " id="reverse"><span class="type-signature"></span>reverse<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Reverses all children in this group.</p> <p>This operaation applies only to immediate children and does not propagate to subgroups.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-676">line 676</a> </dt> </dl> </dd> <dt> <h4 class="name " id="sendToBack"><span class="type-signature"></span>sendToBack<span class="signature">(child)</span><span class="type-signature"> → {any}</span></h4> </dt> <dd> <div class="description"> <p>Sends the given child to the bottom of this group so it renders below all other children.</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">any</span> </td> <td class="description last"><p>The child to send to the bottom of this group.</p></td> </tr> </tbody> </table> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type">any</span> - </div> <div class="returns-desc param-desc"> <p>The child that was moved.</p> </div> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-587">line 587</a> </dt> </dl> </dd> <dt> <h4 class="name " id="set"><span class="type-signature"></span>set<span class="signature">(child, key, value, <span class="optional">checkAlive</span>, <span class="optional">checkVisible</span>, <span class="optional">operation</span>, <span class="optional">force</span>)</span><span class="type-signature"> → {boolean}</span></h4> </dt> <dd> <div class="description"> <p>Quickly set a property on a single child of this group to a new value.</p> <p>The operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.</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>child</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The child to set the property on.</p></td> </tr> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The property, as a string, to be set. For example: 'body.velocity.x'</p></td> </tr> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">any</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The value that will be set.</p></td> </tr> <tr> <td class="name"><code>checkAlive</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>If set then the child will only be updated if alive=true.</p></td> </tr> <tr> <td class="name"><code>checkVisible</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>If set then the child will only be updated if visible=true.</p></td> </tr> <tr> <td class="name"><code>operation</code></td> <td class="type"> <span class="param-type">integer</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last"><p>Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.</p></td> </tr> <tr> <td class="name"><code>force</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>If <code>force</code> is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.</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 property was set, false if not.</p> </div> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-880">line 880</a> </dt> </dl> </dd> <dt> <h4 class="name " id="setAll"><span class="type-signature"></span>setAll<span class="signature">(key, value, <span class="optional">checkAlive</span>, <span class="optional">checkVisible</span>, <span class="optional">operation</span>, <span class="optional">force</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Quickly set the same property across all children of this group to a new value.</p> <p>This call doesn't descend down children, so if you have a Group inside of this group, the property will be set on the group but not its children. If you need that ability please see <code>Group.setAllChildren</code>.</p> <p>The operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The property, as a string, to be set. For example: 'body.velocity.x'</p></td> </tr> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">any</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The value that will be set.</p></td> </tr> <tr> <td class="name"><code>checkAlive</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>If set then only children with alive=true will be updated. This includes any Groups that are children.</p></td> </tr> <tr> <td class="name"><code>checkVisible</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>If set then only children with visible=true will be updated. This includes any Groups that are children.</p></td> </tr> <tr> <td class="name"><code>operation</code></td> <td class="type"> <span class="param-type">integer</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last"><p>Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.</p></td> </tr> <tr> <td class="name"><code>force</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>If <code>force</code> is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-911">line 911</a> </dt> </dl> </dd> <dt> <h4 class="name " id="setAllChildren"><span class="type-signature"></span>setAllChildren<span class="signature">(key, value, <span class="optional">checkAlive</span>, <span class="optional">checkVisible</span>, <span class="optional">operation</span>, <span class="optional">force</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Quickly set the same property across all children of this group, and any child Groups, to a new value.</p> <p>If this group contains other Groups then the same property is set across their children as well, iterating down until it reaches the bottom. Unlike with <code>setAll</code> the property is NOT set on child Groups itself.</p> <p>The operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The property, as a string, to be set. For example: 'body.velocity.x'</p></td> </tr> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">any</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The value that will be set.</p></td> </tr> <tr> <td class="name"><code>checkAlive</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>If set then only children with alive=true will be updated. This includes any Groups that are children.</p></td> </tr> <tr> <td class="name"><code>checkVisible</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>If set then only children with visible=true will be updated. This includes any Groups that are children.</p></td> </tr> <tr> <td class="name"><code>operation</code></td> <td class="type"> <span class="param-type">integer</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last"><p>Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.</p></td> </tr> <tr> <td class="name"><code>force</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>If <code>force</code> is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-946">line 946</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-177">line 177</a> </dt> </dl> </dd> <dt> <h4 class="name " id="setProperty"><span class="type-signature"></span>setProperty<span class="signature">(child, key, value, <span class="optional">operation</span>, <span class="optional">force</span>)</span><span class="type-signature"> → {boolean}</span></h4> </dt> <dd> <div class="description"> <p>Sets a property to the given value on the child. The operation parameter controls how the value is set.</p> <p>The operations are:</p> <ul> <li>0: set the existing value to the given value; if force is <code>true</code> a new property will be created if needed</li> <li>1: will add the given value to the value already present.</li> <li>2: will subtract the given value from the value already present.</li> <li>3: will multiply the value already present by the given value.</li> <li>4: will divide the value already present by the given value.</li> </ul> </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>child</code></td> <td class="type"> <span class="param-type">any</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The child to set the property value on.</p></td> </tr> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">array</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>An array of strings that make up the property that will be set.</p></td> </tr> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">any</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The value that will be set.</p></td> </tr> <tr> <td class="name"><code>operation</code></td> <td class="type"> <span class="param-type">integer</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last"><p>Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.</p></td> </tr> <tr> <td class="name"><code>force</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>If <code>force</code> is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.</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 property was set, false if not.</p> </div> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-773">line 773</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-388">line 388</a> </dt> </dl> </dd> <dt> <h4 class="name " id="sort"><span class="type-signature"></span>sort<span class="signature">(<span class="optional">key</span>, <span class="optional">order</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Sort the children in the group according to a particular key and ordering.</p> <p>Call this function to sort the group according to a particular key value and order. For example to depth sort Sprites for Zelda-style game you might call <code>group.sort('y', Phaser.Group.SORT_ASCENDING)</code> at the bottom of your <code>State.update()</code>.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 'z' </td> <td class="description last"><p>The name of the property to sort on. Defaults to the objects z-depth value.</p></td> </tr> <tr> <td class="name"><code>order</code></td> <td class="type"> <span class="param-type">integer</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> Phaser.Group.SORT_ASCENDING </td> <td class="description last"><p>Order ascending (<a href="Phaser.Group.html#SORT_ASCENDING">SORT_ASCENDING</a>) or descending (<a href="Phaser.Group.html#SORT_DESCENDING">SORT_DESCENDING</a>).</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1487">line 1487</a> </dt> </dl> </dd> <dt> <h4 class="name " id="subAll"><span class="type-signature"></span>subAll<span class="signature">(property, amount, checkAlive, checkVisible)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Subtracts the amount from the given property on all children in this group.</p> <p><code>Group.subAll('x', 10)</code> will minus 10 from the child.x value for each child.</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>property</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"><p>The property to decrement, for example 'body.velocity.x' or 'angle'.</p></td> </tr> <tr> <td class="name"><code>amount</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The amount to subtract from the property. If child.x = 50 then subAll('x', 40) would make child.x = 10.</p></td> </tr> <tr> <td class="name"><code>checkAlive</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>If true the property will only be changed if the child is alive.</p></td> </tr> <tr> <td class="name"><code>checkVisible</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>If true the property will only be changed if the child is visible.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1037">line 1037</a> </dt> </dl> </dd> <dt> <h4 class="name " id="swap"><span class="type-signature"></span>swap<span class="signature">(child1, child2)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Swaps the position of two children in this group.</p> <p>Both children must be in this group, a child cannot be swapped with itself, and unparented children cannot be swapped.</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>child1</code></td> <td class="type"> <span class="param-type">any</span> </td> <td class="description last"><p>The first child to swap.</p></td> </tr> <tr> <td class="name"><code>child2</code></td> <td class="type"> <span class="param-type">any</span> </td> <td class="description last"><p>The second child to swap.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-552">line 552</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-135">line 135</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"> → {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-529">line 529</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"> → {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"> <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-543">line 543</a> </dt> </dl> </dd> <dt> <h4 class="name " id="update"><span class="type-signature"><internal> </span>update<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>The core update - as called by World.</p> </div> <dl class="details"> <dt class="important tag-deprecated">Internal:</dt> <dd class="tag-deprecated"><ul> <li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li> </ul></dd> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-1272">line 1272</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-519">line 519</a> </dt> </dl> </dd> <dt> <h4 class="name " id="updateZ"><span class="type-signature"><internal> </span>updateZ<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Internal method that re-applies all of the childrens Z values.</p> <p>This must be called whenever children ordering is altered so that their <code>z</code> indices are correctly updated.</p> </div> <dl class="details"> <dt class="important tag-deprecated">Internal:</dt> <dd class="tag-deprecated"><ul> <li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li> </ul></dd> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-448">line 448</a> </dt> </dl> </dd> <dt> <h4 class="name " id="xy"><span class="type-signature"></span>xy<span class="signature">(index, x, y)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Positions the child found at the given index within this group to the given x and y coordinates.</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">integer</span> </td> <td class="description last"><p>The index of the child in the group to set the position of.</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 new x position of the child.</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 new y position of the child.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_core_Group.js.html">core/Group.js</a>, <a href="src_core_Group.js.html#sunlight-1-line-654">line 654</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 Thu Mar 26 2015 02:53:52 GMT+0000 (GMT Standard 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>