2013-10-02 19:18:24 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > Phaser Class: Emitter< / title >
<!-- [if lt IE 9]>
< script src = "//html5shiv.googlecode.com/svn/trunk/html5.js" > < / script >
<![endif]-->
2014-11-15 20:01:46 +00:00
< link type = "text/css" rel = "stylesheet" href = "styles/default.css" >
2013-10-02 19:18:24 +00:00
< link type = "text/css" rel = "stylesheet" href = "styles/sunlight.default.css" >
< link type = "text/css" rel = "stylesheet" href = "styles/site.cerulean.css" >
< / head >
< body >
2014-11-25 00:23:44 +00:00
2013-10-02 19:18:24 +00:00
< div class = "container-fluid" >
< div class = "navbar navbar-fixed-top navbar-inverse" >
2014-11-25 00:23:44 +00:00
< div style = "position: absolute; width: 143px; height: 31px; right: 10px; top: 10px; z-index: 1050" > < a href = "http://phaser.io" > < img src = "img/phaser.png" border = "0" / > < / a > < / div >
2013-10-02 19:18:24 +00:00
< div class = "navbar-inner" >
2014-11-25 00:23:44 +00:00
< a class = "brand" href = "index.html" > Phaser API< / a >
2013-10-02 19:18:24 +00:00
< ul class = "nav" >
2014-11-25 00:23:44 +00:00
2013-10-02 19:18:24 +00:00
< li class = "dropdown" >
2013-10-03 01:38:35 +00:00
< a href = "namespaces.list.html" class = "dropdown-toggle" data-toggle = "dropdown" > Namespaces< b
2013-10-02 19:18:24 +00:00
class="caret">< / b > < / a >
< ul class = "dropdown-menu " >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-0" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.html" > Phaser< / a >
2013-10-02 19:18:24 +00:00
< / li >
2014-11-15 20:01:46 +00:00
< li class = "class-depth-0" >
< a href = "PIXI.html" > PIXI< / a >
< / li >
2013-10-02 19:18:24 +00:00
< / ul >
< / li >
< li class = "dropdown" >
< a href = "classes.list.html" class = "dropdown-toggle" data-toggle = "dropdown" > Classes< b
class="caret">< / b > < / a >
< ul class = "dropdown-menu " >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 19:18:24 +00:00
< a href = "Phaser.Animation.html" > Animation< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.AnimationManager.html" > AnimationManager< / a >
2013-10-02 19:18:24 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.AnimationParser.html" > AnimationParser< / a >
2013-10-02 19:18:24 +00:00
< / li >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.ArraySet.html" > ArraySet< / a >
< / li >
2014-11-15 20:01:46 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.ArrayUtils.html" > ArrayUtils< / a >
< / li >
2014-10-09 15:12:53 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.AudioSprite.html" > AudioSprite< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.BitmapData.html" > BitmapData< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.BitmapText.html" > BitmapText< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Button.html" > Button< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Cache.html" > Cache< / a >
2013-10-02 19:18:24 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Camera.html" > Camera< / a >
2013-10-02 19:18:24 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Canvas.html" > Canvas< / a >
2013-10-02 19:18:24 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Circle.html" > Circle< / a >
2013-10-02 19:18:24 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Color.html" > Color< / a >
2013-10-03 00:21:08 +00:00
< / li >
2015-03-23 23:46:30 +00:00
< 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 >
2015-07-22 14:31:30 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.Create.html" > Create< / a >
< / li >
< li class = "class-depth-1" >
< a href = "Phaser.Creature.html" > Creature< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Device.html" > Device< / a >
2013-10-02 19:18:24 +00:00
< / li >
2015-07-22 14:31:30 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.DeviceButton.html" > DeviceButton< / a >
< / li >
2014-11-15 20:01:46 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.DOM.html" > DOM< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.html" > Easing< / a >
< / li >
2015-03-23 23:46:30 +00:00
< 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 >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-18 03:01:51 +00:00
< a href = "Phaser.Ellipse.html" > Ellipse< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Events.html" > Events< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Filter.html" > Filter< / a >
< / li >
2014-09-09 14:36:56 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.FlexGrid.html" > FlexGrid< / a >
< / li >
< li class = "class-depth-1" >
< a href = "Phaser.FlexLayer.html" > FlexLayer< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Frame.html" > Frame< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.FrameData.html" > FrameData< / a >
2013-10-03 00:21:08 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 19:18:24 +00:00
< a href = "Phaser.Game.html" > Game< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-21 15:37:26 +00:00
< a href = "Phaser.GameObjectCreator.html" > GameObjectCreator< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.GameObjectFactory.html" > GameObjectFactory< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-05 06:29:17 +00:00
< a href = "Phaser.Gamepad.html" > Gamepad< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Graphics.html" > Graphics< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 19:18:24 +00:00
< a href = "Phaser.Group.html" > Group< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-08 07:24:22 +00:00
< a href = "Phaser.Image.html" > Image< / a >
< / li >
2015-07-22 14:31:30 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.ImageCollection.html" > ImageCollection< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 19:18:24 +00:00
< a href = "Phaser.Input.html" > Input< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 19:18:24 +00:00
< a href = "Phaser.InputHandler.html" > InputHandler< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 19:18:24 +00:00
< a href = "Phaser.Key.html" > Key< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 19:18:24 +00:00
< a href = "Phaser.Keyboard.html" > Keyboard< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-05 06:29:17 +00:00
< a href = "Phaser.Line.html" > Line< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 19:18:24 +00:00
< a href = "Phaser.LinkedList.html" > LinkedList< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 19:18:24 +00:00
< a href = "Phaser.Loader.html" > Loader< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.LoaderParser.html" > LoaderParser< / a >
2013-10-02 19:18:24 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 19:18:24 +00:00
< a href = "Phaser.Math.html" > Math< / a >
< / li >
2015-07-22 14:31:30 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.Matrix.html" > Matrix< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 19:18:24 +00:00
< a href = "Phaser.Mouse.html" > Mouse< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 19:18:24 +00:00
< a href = "Phaser.MSPointer.html" > MSPointer< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 19:18:24 +00:00
< a href = "Phaser.Net.html" > Net< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.Particle.html" > Particle< / a >
< / li >
< li class = "class-depth-1" >
2013-10-02 19:18:24 +00:00
< a href = "Phaser.Particles.html" > Particles< / a >
< / li >
2014-10-09 15:12:53 +00:00
< li class = "class-depth-2" >
< a href = "Phaser.Particles.Arcade.html" > Arcade< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2013-10-02 19:18:24 +00:00
< a href = "Phaser.Particles.Arcade.Emitter.html" > Emitter< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Physics.html" > Physics< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Physics.Arcade.html" > Arcade< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Arcade.Body.html" > Body< / a >
< / li >
2015-03-23 23:46:30 +00:00
< li class = "class-depth-3" >
< a href = "Phaser.Physics.Arcade.html#TilemapCollision" > TilemapCollision< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Ninja.html" > Ninja< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Ninja.AABB.html" > AABB< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Ninja.Body.html" > Body< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Ninja.Circle.html" > Circle< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Ninja.Tile.html" > Tile< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.html" > P2< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.Body.html" > Body< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.BodyDebug.html" > BodyDebug< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.CollisionGroup.html" > CollisionGroup< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.ContactMaterial.html" > ContactMaterial< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.DistanceConstraint.html" > DistanceConstraint< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-11 12:09:28 +00:00
< li class = "class-depth-3" >
< a href = "Phaser.Physics.P2.FixtureList.html" > FixtureList< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.GearConstraint.html" > GearConstraint< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.InversePointProxy.html" > InversePointProxy< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.LockConstraint.html" > LockConstraint< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.Material.html" > Material< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.PointProxy.html" > PointProxy< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.PrismaticConstraint.html" > PrismaticConstraint< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.RevoluteConstraint.html" > RevoluteConstraint< / a >
< / li >
2014-09-09 14:36:56 +00:00
< li class = "class-depth-3" >
< a href = "Phaser.Physics.P2.RotationalSpring.html" > RotationalSpring< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-3" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.Spring.html" > Spring< / a >
2014-02-21 15:37:26 +00:00
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 19:18:24 +00:00
< a href = "Phaser.Plugin.html" > Plugin< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 19:18:24 +00:00
< a href = "Phaser.PluginManager.html" > PluginManager< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 19:18:24 +00:00
< a href = "Phaser.Point.html" > Point< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 19:18:24 +00:00
< a href = "Phaser.Pointer.html" > Pointer< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-07 06:10:15 +00:00
< a href = "Phaser.Polygon.html" > Polygon< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.QuadTree.html" > QuadTree< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 19:18:24 +00:00
< a href = "Phaser.RandomDataGenerator.html" > RandomDataGenerator< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 19:18:24 +00:00
< a href = "Phaser.Rectangle.html" > Rectangle< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.RenderTexture.html" > RenderTexture< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.RequestAnimationFrame.html" > RequestAnimationFrame< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.RetroFont.html" > RetroFont< / a >
< / li >
2014-09-09 14:36:56 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.Rope.html" > Rope< / a >
< / li >
2015-07-22 14:31:30 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.RoundedRectangle.html" > RoundedRectangle< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.ScaleManager.html" > ScaleManager< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 19:18:24 +00:00
< a href = "Phaser.Signal.html" > Signal< / a >
< / li >
2014-04-11 12:09:28 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.SignalBinding.html" > SignalBinding< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-05 06:29:17 +00:00
< a href = "Phaser.SinglePad.html" > SinglePad< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.Sound.html" > Sound< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 00:21:08 +00:00
< a href = "Phaser.SoundManager.html" > SoundManager< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Sprite.html" > Sprite< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-18 03:01:51 +00:00
< a href = "Phaser.SpriteBatch.html" > SpriteBatch< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 19:18:24 +00:00
< a href = "Phaser.Stage.html" > Stage< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 19:18:24 +00:00
< a href = "Phaser.State.html" > State< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 19:18:24 +00:00
< a href = "Phaser.StateManager.html" > StateManager< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Text.html" > Text< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Tile.html" > Tile< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Tilemap.html" > Tilemap< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.TilemapLayer.html" > TilemapLayer< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.TilemapParser.html" > TilemapParser< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Tileset.html" > Tileset< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.TileSprite.html" > TileSprite< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Time.html" > Time< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Timer.html" > Timer< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-05 06:29:17 +00:00
< a href = "Phaser.TimerEvent.html" > TimerEvent< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-02 19:18:24 +00:00
< a href = "Phaser.Touch.html" > Touch< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Tween.html" > Tween< / a >
< / li >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.TweenData.html" > TweenData< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.TweenManager.html" > TweenManager< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Utils.html" > Utils< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Utils.Debug.html" > Debug< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2015-07-22 14:31:30 +00:00
< a href = "Phaser.Video.html" > Video< / a >
2013-10-02 19:18:24 +00:00
< / li >
2014-11-15 20:01:46 +00:00
< li class = "class-depth-1" >
2015-07-22 14:31:30 +00:00
< a href = "Phaser.World.html" > World< / a >
2014-11-15 20:01:46 +00:00
< / li >
< li class = "class-depth-1" >
2015-07-22 14:31:30 +00:00
< a href = "PIXI.AbstractFilter.html" > AbstractFilter< / a >
2014-11-15 20:01:46 +00:00
< / li >
< li class = "class-depth-1" >
2015-07-22 14:31:30 +00:00
< a href = "PIXI.BaseTexture.html" > BaseTexture< / a >
2014-11-15 20:01:46 +00:00
< / 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" >
2015-03-23 23:46:30 +00:00
< a href = "PIXI.PolyK.html" > PolyK< / a >
2014-11-15 20:01:46 +00:00
< / li >
< li class = "class-depth-1" >
2015-03-23 23:46:30 +00:00
< a href = "PIXI.PrimitiveShader.html" > PrimitiveShader< / a >
2014-11-15 20:01:46 +00:00
< / li >
< li class = "class-depth-1" >
2015-03-23 23:46:30 +00:00
< a href = "PIXI.RenderTexture.html" > RenderTexture< / a >
2014-11-15 20:01:46 +00:00
< / li >
< li class = "class-depth-1" >
2015-03-23 23:46:30 +00:00
< a href = "PIXI.Rope.html" > Rope< / a >
2014-11-15 20:01:46 +00:00
< / li >
< li class = "class-depth-1" >
2015-03-23 23:46:30 +00:00
< a href = "PIXI.Sprite.html" > Sprite< / a >
2014-11-15 20:01:46 +00:00
< / li >
< li class = "class-depth-1" >
2015-03-23 23:46:30 +00:00
< a href = "PIXI.SpriteBatch.html" > SpriteBatch< / a >
2014-11-15 20:01:46 +00:00
< / li >
< li class = "class-depth-1" >
2015-03-23 23:46:30 +00:00
< a href = "PIXI.Stage.html" > Stage< / a >
2014-11-15 20:01:46 +00:00
< / li >
< li class = "class-depth-1" >
2015-03-23 23:46:30 +00:00
< a href = "PIXI.Strip.html" > Strip< / a >
2014-11-15 20:01:46 +00:00
< / li >
< li class = "class-depth-1" >
2015-03-23 23:46:30 +00:00
< a href = "PIXI.StripShader.html" > StripShader< / a >
2014-11-15 20:01:46 +00:00
< / li >
< li class = "class-depth-1" >
2015-03-23 23:46:30 +00:00
< a href = "PIXI.Texture.html" > Texture< / a >
2014-11-15 20:01:46 +00:00
< / li >
< li class = "class-depth-1" >
2015-03-23 23:46:30 +00:00
< a href = "PIXI.TilingSprite.html" > TilingSprite< / a >
2014-11-15 20:01:46 +00:00
< / li >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" >
2015-03-23 23:46:30 +00:00
< a href = "PIXI.WebGLBlendModeManager.html" > WebGLBlendModeManager< / a >
2014-11-25 00:23:44 +00:00
< / li >
2014-11-15 20:01:46 +00:00
< li class = "class-depth-1" >
2015-03-23 23:46:30 +00:00
< a href = "PIXI.WebGLFastSpriteBatch.html" > WebGLFastSpriteBatch< / a >
2014-11-15 20:01:46 +00:00
< / li >
< li class = "class-depth-1" >
2015-03-23 23:46:30 +00:00
< a href = "PIXI.WebGLFilterManager.html" > WebGLFilterManager< / a >
2014-11-15 20:01:46 +00:00
< / li >
< li class = "class-depth-1" >
2015-03-23 23:46:30 +00:00
< a href = "PIXI.WebGLRenderer.html" > WebGLRenderer< / a >
2014-11-15 20:01:46 +00:00
< / li >
2015-03-23 23:46:30 +00:00
< / 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" >
2015-07-22 14:31:30 +00:00
< a href = "global.html#AUTO" > AUTO< / a >
2014-11-15 20:01:46 +00:00
< / li >
2015-03-23 23:46:30 +00:00
< li class = "class-depth-0" >
2015-07-22 14:31:30 +00:00
< a href = "global.html#BITMAPDATA" > BITMAPDATA< / a >
2014-11-15 20:01:46 +00:00
< / li >
2015-03-23 23:46:30 +00:00
< li class = "class-depth-0" >
2015-07-22 14:31:30 +00:00
< a href = "global.html#BITMAPTEXT" > BITMAPTEXT< / a >
2014-11-15 20:01:46 +00:00
< / li >
2015-03-23 23:46:30 +00:00
< li class = "class-depth-0" >
< a href = "global.html#blendModes" > blendModes< / a >
2014-11-15 20:01:46 +00:00
< / li >
2015-03-23 23:46:30 +00:00
< li class = "class-depth-0" >
2015-07-22 14:31:30 +00:00
< a href = "global.html#BUTTON" > BUTTON< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#CANVAS" > CANVAS< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#CANVAS_FILTER" > CANVAS_FILTER< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#CIRCLE" > CIRCLE< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#CREATURE" > CREATURE< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#DOWN" > DOWN< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#ELLIPSE" > ELLIPSE< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#EMITTER" > EMITTER< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#GAMES" > GAMES< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#GRAPHICS" > GRAPHICS< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#GROUP" > GROUP< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#HEADLESS" > HEADLESS< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#IMAGE" > IMAGE< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#LEFT" > LEFT< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#LINE" > LINE< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#MATRIX" > MATRIX< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#NONE" > NONE< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#POINT" > POINT< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#POINTER" > POINTER< / a >
2014-11-15 20:01:46 +00:00
< / li >
2015-03-23 23:46:30 +00:00
< li class = "class-depth-0" >
2015-07-22 14:31:30 +00:00
< a href = "global.html#POLYGON" > POLYGON< / a >
2014-11-15 20:01:46 +00:00
< / li >
2015-03-23 23:46:30 +00:00
< li class = "class-depth-0" >
2015-07-22 14:31:30 +00:00
< a href = "global.html#RECTANGLE" > RECTANGLE< / a >
2014-11-15 20:01:46 +00:00
< / li >
2015-03-23 23:46:30 +00:00
< li class = "class-depth-0" >
2015-07-22 14:31:30 +00:00
< a href = "global.html#RENDERTEXTURE" > RENDERTEXTURE< / a >
2014-11-15 20:01:46 +00:00
< / li >
2015-03-23 23:46:30 +00:00
< li class = "class-depth-0" >
2015-07-22 14:31:30 +00:00
< a href = "global.html#RETROFONT" > RETROFONT< / a >
2014-11-15 20:01:46 +00:00
< / li >
2015-03-23 23:46:30 +00:00
< li class = "class-depth-0" >
2015-07-22 14:31:30 +00:00
< a href = "global.html#RIGHT" > RIGHT< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#ROPE" > ROPE< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#ROUNDEDRECTANGLE" > ROUNDEDRECTANGLE< / a >
2014-11-15 20:01:46 +00:00
< / li >
2015-03-23 23:46:30 +00:00
< li class = "class-depth-0" >
< a href = "global.html#scaleModes" > scaleModes< / a >
2014-11-15 20:01:46 +00:00
< / li >
2015-03-23 23:46:30 +00:00
< li class = "class-depth-0" >
2015-07-22 14:31:30 +00:00
< a href = "global.html#SPRITE" > SPRITE< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#SPRITEBATCH" > SPRITEBATCH< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#TEXT" > TEXT< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#TILEMAP" > TILEMAP< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#TILEMAPLAYER" > TILEMAPLAYER< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#TILESPRITE" > TILESPRITE< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#UP" > UP< / a >
2014-11-15 20:01:46 +00:00
< / li >
2015-03-23 23:46:30 +00:00
< li class = "class-depth-0" >
2015-07-22 14:31:30 +00:00
< a href = "global.html#VERSION" > VERSION< / a >
2014-11-15 20:01:46 +00:00
< / li >
2015-03-23 23:46:30 +00:00
< li class = "class-depth-0" >
2015-07-22 14:31:30 +00:00
< a href = "global.html#VIDEO" > VIDEO< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#WEBGL" > WEBGL< / a >
< / li >
< li class = "class-depth-0" >
< a href = "global.html#WEBGL_FILTER" > WEBGL_FILTER< / a >
2014-11-15 20:01:46 +00:00
< / li >
2013-10-02 19:18:24 +00:00
< / ul >
< / li >
2014-11-25 00:23:44 +00:00
2014-11-15 20:01:46 +00:00
< li class = "dropdown" >
2014-11-25 00:23:44 +00:00
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Core< b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu " >
2014-12-03 10:39:11 +00:00
< li class = "class-depth-1" > < a href = "Phaser.Game.html" > Game< / a > < / li >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" > < a href = "Phaser.Group.html" > Group< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.World.html" > World< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Loader.html" > Loader< / a > < / li >
2015-07-22 14:31:30 +00:00
< li class = "class-depth-1" > < a href = "Phaser.Cache.html" > Cache< / a > < / li >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" > < a href = "Phaser.Time.html" > Time< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Camera.html" > Camera< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.StateManager.html" > State Manager< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.TweenManager.html" > Tween Manager< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.SoundManager.html" > Sound Manager< / a > < / li >
2015-01-06 06:57:25 +00:00
< li class = "class-depth-1" > < a href = "Phaser.Input.html" > Input Manager< / a > < / li >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" > < a href = "Phaser.ScaleManager.html" > Scale Manager< / a > < / li >
< / ul >
< / li >
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Game Objects< b class = "caret" > < / b > < / a >
2014-11-15 20:01:46 +00:00
< ul class = "dropdown-menu " >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" > < a href = "Phaser.GameObjectFactory.html" > Factory (game.add)< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.GameObjectCreator.html" > Creator (game.make)< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Sprite.html" > Sprite< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Image.html" > Image< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Sound.html" > Sound< / a > < / li >
2015-07-22 14:31:30 +00:00
< li class = "class-depth-1" > < a href = "Phaser.Video.html" > Video< / a > < / li >
2015-01-06 06:57:25 +00:00
< li class = "class-depth-1" > < a href = "Phaser.Particles.Arcade.Emitter.html" > Particle Emitter< / a > < / li >
2014-12-03 10:39:11 +00:00
< li class = "class-depth-1" > < a href = "Phaser.Particle.html" > Particle< / a > < / li >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" > < a href = "Phaser.Text.html" > Text< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Tween.html" > Tween< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.BitmapText.html" > BitmapText< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Tilemap.html" > Tilemap< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.BitmapData.html" > BitmapData< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.RetroFont.html" > RetroFont< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Button.html" > Button< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Animation.html" > Animation< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Graphics.html" > Graphics< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.RenderTexture.html" > RenderTexture< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.TileSprite.html" > TileSprite< / a > < / li >
< / ul >
< / li >
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Geometry< b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu " >
< li class = "class-depth-1" > < a href = "Phaser.Circle.html" > Circle< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Ellipse.html" > Ellipse< / a > < / li >
2015-07-22 14:31:30 +00:00
< li class = "class-depth-1" > < a href = "Phaser.Line.html" > Line< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Matrix.html" > Matrix< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Point.html" > Point< / a > < / li >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" > < a href = "Phaser.Polygon.html" > Polygon< / a > < / li >
2015-07-22 14:31:30 +00:00
< li class = "class-depth-1" > < a href = "Phaser.Rectangle.html" > Rectangle< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.RoundedRectangle.html" > Rounded Rectangle< / a > < / li >
2014-11-15 20:01:46 +00:00
< / ul >
< / li >
2014-11-25 00:23:44 +00:00
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > 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 >
2015-07-22 14:31:30 +00:00
< li class = "class-depth-1" > < a href = "Phaser.DeviceButton.html" > Device Button< / a > < / li >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" > < a href = "Phaser.Mouse.html" > Mouse< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Keyboard.html" > Keyboard< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Key.html" > Key< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Gamepad.html" > Gamepad< / a > < / li >
< / ul >
< / li >
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Community< b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu " >
2015-03-26 02:55:18 +00:00
< li class = "class-depth-1" > < a href = "http://phaser.io" > Phaser Web Site< / a > < / li >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" > < a href = "https://github.com/photonstorm/phaser" > Phaser Github< / a > < / li >
2015-03-26 02:55:18 +00:00
< li class = "class-depth-1" > < a href = "http://phaser.io/examples" > Phaser Examples< / a > < / li >
2014-11-25 00:23:44 +00:00
< 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 >
2015-07-22 14:31:30 +00:00
< li class = "class-depth-1" > < a href = "http://phaser.io/learn" > Tutorials< / a > < / li >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" > < a href = "https://confirmsubscription.com/h/r/369DE48E3E86AF1E" > Newsletter< / a > < / li >
2015-03-26 02:55:18 +00:00
< 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 >
2015-03-23 23:46:30 +00:00
< li class = "class-depth-1" > < a href = "https://www.codeandweb.com/texturepacker/phaser" > Texture Packer< / a > < / li >
2014-11-25 00:23:44 +00:00
< / ul >
< / li >
2014-11-15 20:01:46 +00:00
< / ul >
< / div >
< / div >
< div class = "row-fluid" >
2013-10-02 19:18:24 +00:00
< div class = "span8" >
< div id = "main" >
2014-11-25 00:23:44 +00:00
<!-- <h1 class="page - title">Class: Emitter</h1> -->
2013-10-02 19:18:24 +00:00
< section >
< header >
< h2 >
2014-10-09 15:12:53 +00:00
< span class = "ancestors" > < a href = "Phaser.html" > Phaser< / a > < a href = "Phaser.Particles.html" > .Particles< / a > < a href = "Phaser.Particles.Arcade.html" > .Arcade< / a > .< / span >
2013-10-02 19:18:24 +00:00
Emitter
< / h2 >
< / header >
< article >
< div class = "container-overview" >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="Emitter">< span class = "type-signature" > < / span > new Emitter< span class = "signature" > (game, < span class = "optional" > x< / span > , < span class = "optional" > y< / span > , < span class = "optional" > maxParticles< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-10-09 15:12:53 +00:00
< div class = "description" >
< p > Emitter is a lightweight particle emitter that uses Arcade Physics.
It can be used for one-time explosions or for continuous effects like rain and fire.
All it really does is launch Particle objects out at set intervals, and fixes their positions and velocities accordingly.< / p >
< / div >
2013-10-02 19:18:24 +00:00
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2013-10-03 00:21:08 +00:00
< th > Argument< / th >
2013-10-02 19:18:24 +00:00
2013-10-03 00:21:08 +00:00
< th > Default< / th >
2013-10-02 19:18:24 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > game< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Game.html" > Phaser.Game< / a > < / span >
< / td >
2013-10-03 00:21:08 +00:00
< td class = "attributes" >
< / td >
2013-10-02 19:18:24 +00:00
2013-10-03 00:21:08 +00:00
< td class = "default" >
< / td >
2013-10-02 19:18:24 +00:00
< td class = "description last" > < p > Current game instance.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2013-10-03 00:21:08 +00:00
< td class = "attributes" >
< optional>< br >
2013-10-02 19:18:24 +00:00
2013-10-03 00:21:08 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2013-10-03 00:21:08 +00:00
< td class = "default" >
0
< / td >
< td class = "description last" > < p > The x coordinate within the Emitter that the particles are emitted from.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2013-10-03 00:21:08 +00:00
< td class = "attributes" >
< optional>< br >
2013-10-02 19:18:24 +00:00
2013-10-03 00:21:08 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2013-10-03 00:21:08 +00:00
< td class = "default" >
0
< / td >
< td class = "description last" > < p > The y coordinate within the Emitter that the particles are emitted from.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< tr >
< td class = "name" > < code > maxParticles< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2013-10-03 00:21:08 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2013-10-02 19:18:24 +00:00
2013-10-03 00:21:08 +00:00
< td class = "default" >
50
< / td >
2013-10-02 19:18:24 +00:00
2014-07-10 19:31:11 +00:00
< td class = "description last" > < p > The total number of particles in this emitter.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-20" > line 20< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< / dd >
< / div >
< h3 class = "subsection-title" > Extends< / h3 >
< ul >
< li > < a href = "Phaser.Group.html" > Phaser.Group< / a > < / li >
< / ul >
< h3 class = "subsection-title" > Members< / h3 >
< dl >
2014-02-05 06:29:17 +00:00
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="alive">< span class = "type-signature" > < / span > alive< span class = "type-signature" > :boolean< / span > < / h4 >
2014-02-05 06:29:17 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< 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 >
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2014-02-05 06:29:17 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#alive" > Phaser.Group#alive< / a >
< / li > < / dd >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > true< / li > < / ul > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / dt >
2014-02-05 06:29:17 +00:00
< / dl >
< / dd >
2013-10-02 19:18:24 +00:00
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="alpha">< span class = "type-signature" > < / span > alpha< span class = "type-signature" > :number< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > The alpha value of the group container.< / p >
2014-11-15 20:01:46 +00:00
< / div >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-03-24 12:41:45 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#alpha" > Phaser.Group#alpha< / a >
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-2212" > line 2212< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="alphaData">< span class = "type-signature" > < / span > alphaData< span class = "type-signature" > :array< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > An array of the calculated alpha easing data applied to particles with alphaRates > 0.< / p >
< / div >
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-109" > line 109< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="angle">< span class = "type-signature" > < / span > angle< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / div >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#angle" > Phaser.Group#angle< / a >
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-2144" > line 2144< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="angularDrag">< span class = "type-signature" > < / span > angularDrag< span class = "type-signature" > :number< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > The angular drag component of particles launched from the emitter if they are rotating.< / p >
2014-04-10 22:13:43 +00:00
< / div >
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > 0< / li > < / ul > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-132" > line 132< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="area">< span class = "type-signature" > < / span > area< span class = "type-signature" > :< a href = "Phaser.Rectangle.html" > Phaser.Rectangle< / a > < / span > < / h4 >
< / dt >
< dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The area of the emitter. Particles can be randomly generated from anywhere within this rectangle.< / p >
< / div >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-51" > line 51< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="autoAlpha">< span class = "type-signature" > < / span > autoAlpha< span class = "type-signature" > :boolean< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > When a new Particle is emitted this controls if it will automatically change alpha. Use Emitter.setAlpha to configure.< / p >
< / div >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-193" > line 193< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-07-10 19:31:11 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="autoScale">< span class = "type-signature" > < / span > autoScale< span class = "type-signature" > :boolean< / span > < / h4 >
2014-07-10 19:31:11 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > When a new Particle is emitted this controls if it will automatically scale in size. Use Emitter.setScale to configure.< / p >
< / div >
2014-07-10 19:31:11 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2014-07-10 19:31:11 +00:00
2014-11-15 20:01:46 +00:00
2014-07-10 19:31:11 +00:00
2014-11-15 20:01:46 +00:00
2014-07-10 19:31:11 +00:00
2014-11-15 20:01:46 +00:00
2014-07-10 19:31:11 +00:00
2014-11-15 20:01:46 +00:00
2014-07-10 19:31:11 +00:00
2014-11-15 20:01:46 +00:00
2014-07-10 19:31:11 +00:00
2014-11-15 20:01:46 +00:00
2014-07-10 19:31:11 +00:00
2014-11-15 20:01:46 +00:00
2014-07-10 19:31:11 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-188" > line 188< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-07-10 19:31:11 +00:00
2014-11-15 20:01:46 +00:00
2014-07-10 19:31:11 +00:00
2014-11-15 20:01:46 +00:00
2014-07-10 19:31:11 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2014-07-10 19:31:11 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2014-07-10 19:31:11 +00:00
2014-11-15 20:01:46 +00:00
2014-07-10 19:31:11 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="blendMode">< span class = "type-signature" > < / span > blendMode< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
2014-07-10 19:31:11 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The blendMode as set on the particle when emitted from the Emitter. Defaults to NORMAL. Needs browser capable of supporting canvas blend-modes (most not available in WebGL)< / p >
< / div >
2014-07-10 19:31:11 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2014-07-10 19:31:11 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-167" > line 167< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="bottom">< span class = "type-signature" > < readonly> < / span > bottom< span class = "type-signature" > :number< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Gets the bottom position of the Emitter.< / p >
< / div >
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-26 02:38:46 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-916" > line 916< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="bounce">< span class = "type-signature" > < / span > bounce< span class = "type-signature" > :< a href = "Phaser.Point.html" > Phaser.Point< / a > < / span > < / h4 >
< / dt >
< dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > How much each particle should bounce on each axis. 1 = full bounce, 0 = no bounce.< / p >
< / div >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-149" > line 149< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
2014-02-18 03:01:51 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2015-03-23 23:46:30 +00:00
id="cacheAsBitmap">< span class = "type-signature" > < / span > cacheAsBitmap< span class = "type-signature" > :Boolean< / span > < / h4 >
2014-02-18 03:01:51 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
2015-03-23 23:46:30 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / div >
2014-02-18 03:01:51 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2014-02-18 03:01:51 +00:00
2014-11-15 20:01:46 +00:00
2014-02-18 03:01:51 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2015-03-23 23:46:30 +00:00
< a href = "PIXI.DisplayObject.html#cacheAsBitmap" > PIXI.DisplayObject#cacheAsBitmap< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
2014-02-18 03:01:51 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_pixi_display_DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "src_pixi_display_DisplayObject.js.html#sunlight-1-line-366" > line 366< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-02-18 03:01:51 +00:00
2013-11-01 18:16:52 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2015-03-23 23:46:30 +00:00
id="cameraOffset">< span class = "type-signature" > < / span > cameraOffset< span class = "type-signature" > :< a href = "Phaser.Point.html" > Phaser.Point< / a > < / span > < / h4 >
2013-11-01 18:16:52 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
2015-03-23 23:46:30 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / div >
2013-11-01 18:16:52 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-11-01 18:16:52 +00:00
2014-11-15 20:01:46 +00:00
2013-11-01 18:16:52 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2015-03-23 23:46:30 +00:00
< a href = "Phaser.Group.html#cameraOffset" > Phaser.Group#cameraOffset< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
2013-11-01 18:16:52 +00:00
2014-11-15 20:01:46 +00:00
2013-11-01 18:16:52 +00:00
2014-11-15 20:01:46 +00:00
2013-11-01 18:16:52 +00:00
2014-11-15 20:01:46 +00:00
2013-11-01 18:16:52 +00:00
2014-11-15 20:01:46 +00:00
2013-11-01 18:16:52 +00:00
2014-11-15 20:01:46 +00:00
2013-11-01 18:16:52 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-209" > line 209< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-11-01 18:16:52 +00:00
2014-11-15 20:01:46 +00:00
2013-11-01 18:16:52 +00:00
2014-11-15 20:01:46 +00:00
2013-11-01 18:16:52 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-11-01 18:16:52 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-11-01 18:16:52 +00:00
2014-11-15 20:01:46 +00:00
2013-11-01 18:16:52 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
2015-03-23 23:46:30 +00:00
id="children">< span class = "type-signature" > < readonly> < / span > children< span class = "type-signature" > :Array.< < a href = "global.html#DisplayObject" > DisplayObject< / a > >< / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
2013-11-01 18:16:52 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
2015-03-23 23:46:30 +00:00
< p > [read-only] The array of children of this container.< / p >
2014-11-15 20:01:46 +00:00
< / div >
2015-03-23 23:46:30 +00:00
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > Array.< < a href = "global.html#DisplayObject" > DisplayObject< / a > >< / span >
< / li >
< / ul >
2013-11-01 18:16:52 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-11-01 18:16:52 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2015-03-23 23:46:30 +00:00
< a href = "PIXI.DisplayObjectContainer.html#children" > PIXI.DisplayObjectContainer#children< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
2013-11-01 18:16:52 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / dt >
2013-11-01 18:16:52 +00:00
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2015-03-23 23:46:30 +00:00
id="classType">< span class = "type-signature" > < / span > classType< span class = "type-signature" > :object< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
2015-03-23 23:46:30 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / div >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2015-03-23 23:46:30 +00:00
< a href = "Phaser.Group.html#classType" > Phaser.Group#classType< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2015-03-23 23:46:30 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-129" > line 129< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2015-03-23 23:46:30 +00:00
id="cursor">< span class = "type-signature" > < / span > cursor< span class = "type-signature" > :< a href = "global.html#DisplayObject" > DisplayObject< / a > < / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
2015-03-23 23:46:30 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / div >
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2015-03-23 23:46:30 +00:00
< a href = "Phaser.Group.html#cursor" > Phaser.Group#cursor< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-137" > line 137< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2015-03-23 23:46:30 +00:00
id="cursorIndex">< span class = "type-signature" > < readonly> < / span > cursorIndex< span class = "type-signature" > :integer< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
2015-03-23 23:46:30 +00:00
< p > The current index of the Group cursor. Advance it with Group.next.< / p >
2014-11-15 20:01:46 +00:00
< / div >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-03-14 06:36:05 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2015-03-23 23:46:30 +00:00
< a href = "Phaser.Group.html#cursorIndex" > Phaser.Group#cursorIndex< / a >
2014-03-14 06:36:05 +00:00
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-192" > line 192< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-04-29 14:39:02 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="emitX">< span class = "type-signature" > < / span > emitX< span class = "type-signature" > :number< / span > < / h4 >
2014-04-29 14:39:02 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > The point the particles are emitted from.
Emitter.x and Emitter.y control the containers location, which updates all current particles
Emitter.emitX and Emitter.emitY control the emission location relative to the x/y position.< / p >
2014-04-29 14:39:02 +00:00
< / div >
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-175" > line 175< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
2014-02-18 03:01:51 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="emitY">< span class = "type-signature" > < / span > emitY< span class = "type-signature" > :number< / span > < / h4 >
2014-02-18 03:01:51 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > The point the particles are emitted from.
Emitter.x and Emitter.y control the containers location, which updates all current particles
Emitter.emitX and Emitter.emitY control the emission location relative to the x/y position.< / p >
2014-04-10 22:13:43 +00:00
< / div >
2014-02-18 03:01:51 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2014-02-18 03:01:51 +00:00
2014-11-15 20:01:46 +00:00
2014-02-18 03:01:51 +00:00
2014-11-15 20:01:46 +00:00
2014-02-18 03:01:51 +00:00
2014-11-15 20:01:46 +00:00
2014-02-18 03:01:51 +00:00
2014-11-15 20:01:46 +00:00
2014-02-18 03:01:51 +00:00
2014-11-15 20:01:46 +00:00
2014-02-18 03:01:51 +00:00
2014-11-15 20:01:46 +00:00
2014-02-18 03:01:51 +00:00
2014-11-15 20:01:46 +00:00
2014-02-18 03:01:51 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-183" > line 183< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-02-18 03:01:51 +00:00
2014-11-15 20:01:46 +00:00
2014-02-18 03:01:51 +00:00
2014-11-15 20:01:46 +00:00
2014-02-18 03:01:51 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2014-02-18 03:01:51 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2014-02-18 03:01:51 +00:00
2014-11-15 20:01:46 +00:00
2014-02-18 03:01:51 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="enableBody">< span class = "type-signature" > < / span > enableBody< span class = "type-signature" > :boolean< / span > < / h4 >
< / dt >
< dd >
2014-02-18 03:01:51 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / div >
2014-02-18 03:01:51 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2014-02-18 03:01:51 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-11-15 20:01:46 +00:00
< a href = "Phaser.Group.html#enableBody" > Phaser.Group#enableBody< / a >
2014-02-18 03:01:51 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-145" > line 145< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-02-18 03:01:51 +00:00
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="enableBodyDebug">< span class = "type-signature" > < / span > enableBodyDebug< span class = "type-signature" > :boolean< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< 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 >
2014-04-10 22:13:43 +00:00
< / div >
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#enableBodyDebug" > Phaser.Group#enableBodyDebug< / a >
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > false< / li > < / ul > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-154" > line 154< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="exists">< span class = "type-signature" > < / span > exists< span class = "type-signature" > :boolean< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > If exists is true the group is updated, otherwise it is skipped.< / p >
2014-03-14 06:36:05 +00:00
< / div >
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#exists" > Phaser.Group#exists< / a >
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > true< / li > < / ul > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2015-03-23 23:46:30 +00:00
id="filterArea">< span class = "type-signature" > < / span > filterArea< span class = "type-signature" > :Rectangle< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The area the filter is applied to like the hitArea this is used as more of an optimisation
rather than figuring out the dimensions of the displayObject each frame you can set this rectangle< / p >
< / div >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-11-15 20:01:46 +00:00
< a href = "PIXI.DisplayObject.html#filterArea" > PIXI.DisplayObject#filterArea< / a >
2014-04-10 22:13:43 +00:00
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_pixi_display_DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "src_pixi_display_DisplayObject.js.html#sunlight-1-line-183" > line 183< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="filters">< span class = "type-signature" > < / span > filters< span class = "type-signature" > :Array.< Filter>< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Sets the filters for the displayObject.
IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.
To remove filters simply set this property to 'null'< / p >
< / div >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< h5 > Type:< / h5 >
< ul >
< li >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< span class = "param-type" > Array.< Filter>< / span >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / li >
< / ul >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-03-14 06:36:05 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-11-15 20:01:46 +00:00
< a href = "PIXI.DisplayObject.html#filters" > PIXI.DisplayObject#filters< / a >
2014-03-14 06:36:05 +00:00
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-03-14 06:36:05 +00:00
2014-02-05 06:29:17 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_pixi_display_DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "src_pixi_display_DisplayObject.js.html#sunlight-1-line-328" > line 328< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="fixedToCamera">< span class = "type-signature" > < / span > fixedToCamera< span class = "type-signature" > :boolean< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
2015-03-23 23:46:30 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / div >
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#fixedToCamera" > Phaser.Group#fixedToCamera< / a >
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-202" > line 202< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
2015-01-06 06:57:25 +00:00
id="frequency">< span class = "type-signature" > < / span > frequency< span class = "type-signature" > :number< / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > How often a particle is emitted in ms (if emitter is started with Explode === false).< / p >
< / div >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-03-14 06:36:05 +00:00
< dt class = "tag-default" > Default Value:< / dt >
2014-11-15 20:01:46 +00:00
< dd class = "tag-default" > < ul class = "dummy" > < li > 100< / li > < / ul > < / dd >
2014-03-14 06:36:05 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-138" > line 138< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="game">< span class = "type-signature" > < internal> < / span > game< span class = "type-signature" > :< a href = "Phaser.Game.html" > Phaser.Game< / a > < / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > A reference to the currently running Game.< / p >
2014-04-10 22:13:43 +00:00
< / div >
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-11-15 20:01:46 +00:00
< a href = "Phaser.Group.html#game" > Phaser.Group#game< / a >
2014-04-10 22:13:43 +00:00
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< dt class = "important tag-deprecated" > Internal:< / dt >
< dd class = "tag-deprecated" > < ul >
< li > This member is < em > internal (protected)< / em > and may be modified or removed in the future.< / li >
< / ul > < / dd >
2013-10-02 19:18:24 +00:00
2014-02-05 06:29:17 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2014-03-14 06:36:05 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="gravity">< span class = "type-signature" > < / span > gravity< span class = "type-signature" > :number< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Sets the < code > body.gravity.y< / code > of each particle sprite to this value on launch.< / p >
< / div >
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > 100< / li > < / ul > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-115" > line 115< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2015-07-22 14:31:30 +00:00
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="hash">< span class = "type-signature" > < / span > hash< span class = "type-signature" > :array< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The hash array is an array belonging to this Group into which you can add any of its children via Group.addToHash and Group.removeFromHash.< / p >
< p > Only children of this Group can be added to and removed from the hash.< / p >
< p > This hash is used automatically by Phaser Arcade Physics in order to perform non z-index based destructive sorting.
However if you don't use Arcade Physics, or this isn't a physics enabled Group, then you can use the hash to perform your own
sorting and filtering of Group children without touching their z-index (and therefore display draw order)< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#hash" > Phaser.Group#hash< / a >
< / li > < / 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-222" > line 222< / a >
< / dt >
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="height">< span class = "type-signature" > < / span > height< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Gets or sets the height of the Emitter. This is the region in which a particle can be emitted.< / p >
< / div >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-26 02:38:46 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-829" > line 829< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2015-03-23 23:46:30 +00:00
id="hitArea">< span class = "type-signature" > < / span > hitArea< span class = "type-signature" > :Rectangle|Circle|Ellipse|Polygon< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< h5 > Type:< / h5 >
< ul >
< li >
2013-10-02 19:18:24 +00:00
2015-03-23 23:46:30 +00:00
< span class = "param-type" > Rectangle< / span >
2014-11-15 20:01:46 +00:00
|
2013-10-02 19:18:24 +00:00
2015-03-23 23:46:30 +00:00
< span class = "param-type" > Circle< / span >
2014-11-15 20:01:46 +00:00
|
2013-10-02 19:18:24 +00:00
2015-03-23 23:46:30 +00:00
< span class = "param-type" > Ellipse< / span >
2014-11-15 20:01:46 +00:00
|
2013-10-02 19:18:24 +00:00
2015-03-23 23:46:30 +00:00
< span class = "param-type" > Polygon< / span >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / li >
< / ul >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-03-14 06:36:05 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-11-15 20:01:46 +00:00
< a href = "PIXI.DisplayObject.html#hitArea" > PIXI.DisplayObject#hitArea< / a >
2014-03-14 06:36:05 +00:00
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="ignoreDestroy">< span class = "type-signature" > < / span > ignoreDestroy< span class = "type-signature" > :boolean< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > A group with < code > ignoreDestroy< / code > set to < code > true< / code > ignores all calls to its < code > destroy< / code > method.< / p >
2014-11-15 20:01:46 +00:00
< / div >
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#ignoreDestroy" > Phaser.Group#ignoreDestroy< / a >
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > false< / li > < / ul > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="left">< span class = "type-signature" > < readonly> < / span > left< span class = "type-signature" > :number< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Gets the left position of the Emitter.< / p >
< / div >
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-26 02:38:46 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-877" > line 877< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-10-09 15:12:53 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="length">< span class = "type-signature" > < readonly> < / span > length< span class = "type-signature" > :integer< / span > < / h4 >
2014-10-09 15:12:53 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-10-09 15:12:53 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Total number of children in this group, regardless of exists/alive status.< / p >
2014-11-15 20:01:46 +00:00
< / div >
2014-10-09 15:12:53 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2014-10-09 15:12:53 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-11-15 20:01:46 +00:00
< a href = "Phaser.Group.html#length" > Phaser.Group#length< / a >
2014-10-09 15:12:53 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-2127" > line 2127< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-02-05 06:29:17 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="lifespan">< span class = "type-signature" > < / span > lifespan< span class = "type-signature" > :number< / span > < / h4 >
2014-02-05 06:29:17 +00:00
< / dt >
< dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > How long each particle lives once it is emitted in ms. Default is 2 seconds. Set lifespan to 'zero' for particles to live forever.< / p >
< / div >
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > 2000< / li > < / ul > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-144" > line 144< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#mask" > PIXI.DisplayObject#mask< / a >
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_pixi_display_DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "src_pixi_display_DisplayObject.js.html#sunlight-1-line-303" > line 303< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="maxParticleAlpha">< span class = "type-signature" > < / span > maxParticleAlpha< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The maximum possible alpha value of a particle.< / p >
< / div >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > 1< / li > < / ul > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-104" > line 104< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="maxParticles">< span class = "type-signature" > < / span > maxParticles< span class = "type-signature" > :number< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The total number of particles in this emitter.< / p >
< / div >
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-26" > line 26< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="maxParticleScale">< span class = "type-signature" > < / span > maxParticleScale< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The maximum possible scale of a particle. This is applied to the X and Y axis. If you need to control each axis see maxParticleScaleX.< / p >
< / div >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-03-14 06:36:05 +00:00
< dt class = "tag-default" > Default Value:< / dt >
2014-11-15 20:01:46 +00:00
< dd class = "tag-default" > < ul class = "dummy" > < li > 1< / li > < / ul > < / dd >
2014-03-14 06:36:05 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-75" > line 75< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="maxParticleSpeed">< span class = "type-signature" > < / span > maxParticleSpeed< span class = "type-signature" > :< a href = "Phaser.Point.html" > Phaser.Point< / a > < / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The maximum possible velocity of a particle.< / p >
< / div >
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-63" > line 63< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="maxRotation">< span class = "type-signature" > < / span > maxRotation< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The maximum possible angular velocity of a particle.< / p >
< / div >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-03-14 06:36:05 +00:00
< dt class = "tag-default" > Default Value:< / dt >
2014-11-15 20:01:46 +00:00
< dd class = "tag-default" > < ul class = "dummy" > < li > 360< / li > < / ul > < / dd >
2014-03-14 06:36:05 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-92" > line 92< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="minParticleAlpha">< span class = "type-signature" > < / span > minParticleAlpha< span class = "type-signature" > :number< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The minimum possible alpha value of a particle.< / p >
< / div >
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > 1< / li > < / ul > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-98" > line 98< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="minParticleScale">< span class = "type-signature" > < / span > minParticleScale< span class = "type-signature" > :number< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The minimum possible scale of a particle. This is applied to the X and Y axis. If you need to control each axis see minParticleScaleX.< / p >
< / div >
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > 1< / li > < / ul > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-69" > line 69< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="minParticleSpeed">< span class = "type-signature" > < / span > minParticleSpeed< span class = "type-signature" > :< a href = "Phaser.Point.html" > Phaser.Point< / a > < / span > < / h4 >
< / dt >
< dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The minimum possible velocity of a particle.< / p >
< / div >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-57" > line 57< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="minRotation">< span class = "type-signature" > < / span > minRotation< span class = "type-signature" > :number< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The minimum possible angular velocity of a particle.< / p >
< / div >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-86" > line 86< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="name">< span class = "type-signature" > < / span > name< span class = "type-signature" > :string< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > A handy string name for this emitter. Can be set to anything.< / p >
< / div >
2014-02-05 06:29:17 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-33" > line 33< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="on">< span class = "type-signature" > < / span > on< span class = "type-signature" > :boolean< / span > < / h4 >
< / dt >
< dd >
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Determines whether the emitter is currently emitting particles. It is totally safe to directly toggle this.< / p >
< / div >
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2014-02-05 06:29:17 +00:00
< dt class = "tag-default" > Default Value:< / dt >
2014-11-15 20:01:46 +00:00
< dd class = "tag-default" > < ul class = "dummy" > < li > false< / li > < / ul > < / dd >
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-155" > line 155< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-02-05 06:29:17 +00:00
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > This signal is dispatched when the group is destroyed.< / p >
2014-11-15 20:01:46 +00:00
< / div >
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#onDestroy" > Phaser.Group#onDestroy< / a >
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > [read-only] The display object container that contains this display object.< / p >
< / div >
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#parent" > PIXI.DisplayObject#parent< / a >
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="particleAnchor">< span class = "type-signature" > < / span > particleAnchor< span class = "type-signature" > :< a href = "Phaser.Point.html" > Phaser.Point< / a > < / span > < / h4 >
< / dt >
< dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > When a particle is created its anchor will be set to match this Point object (defaults to x/y: 0.5 to aid in rotation)< / p >
< / div >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-161" > line 161< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-23 13:00:28 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="particleBringToTop">< span class = "type-signature" > < / span > particleBringToTop< span class = "type-signature" > :boolean< / span > < / h4 >
2013-10-23 13:00:28 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > If this is < code > true< / code > then when the Particle is emitted it will be bought to the top of the Emitters display list.< / p >
< / div >
2013-10-23 13:00:28 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-23 13:00:28 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > false< / li > < / ul > < / dd >
2013-10-23 13:00:28 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-199" > line 199< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="particleClass">< span class = "type-signature" > < / span > particleClass< span class = "type-signature" > :any< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > For emitting your own particle class types. They must extend Phaser.Particle.< / p >
< / div >
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-121" > line 121< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="particleDrag">< span class = "type-signature" > < / span > particleDrag< span class = "type-signature" > :< a href = "Phaser.Point.html" > Phaser.Point< / a > < / span > < / h4 >
< / dt >
< dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The X and Y drag component of particles launched from the emitter.< / p >
< / div >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-126" > line 126< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
2013-10-23 13:00:28 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="particleSendToBack">< span class = "type-signature" > < / span > particleSendToBack< span class = "type-signature" > :boolean< / span > < / h4 >
2013-10-23 13:00:28 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > If this is < code > true< / code > then when the Particle is emitted it will be sent to the back of the Emitters display list.< / p >
< / div >
2013-10-23 13:00:28 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > false< / li > < / ul > < / dd >
2013-10-23 13:00:28 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-205" > line 205< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-23 13:00:28 +00:00
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2015-07-22 14:31:30 +00:00
id="pendingDestroy">< span class = "type-signature" > < / span > pendingDestroy< span class = "type-signature" > :boolean< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
2015-07-22 14:31:30 +00:00
< p > A Group is that has < code > pendingDestroy< / code > set to < code > true< / code > is flagged to have its destroy method
called on the next logic update.
You can set it directly to flag the Group to be destroyed on its next update.< / p >
< p > This is extremely useful if you wish to destroy a Group from within one of its own callbacks
or a callback of one of its children.< / p >
2014-11-15 20:01:46 +00:00
< / div >
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2015-07-22 14:31:30 +00:00
< a href = "Phaser.Group.html#pendingDestroy" > Phaser.Group#pendingDestroy< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-118" > line 118< / a >
2015-03-23 23:46:30 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2015-07-22 14:31:30 +00:00
id="physicsBodyType">< span class = "type-signature" > < / span > physicsBodyType< span class = "type-signature" > :integer< / span > < / h4 >
2015-03-23 23:46:30 +00:00
< / dt >
< dd >
< div class = "description" >
2015-07-22 14:31:30 +00:00
< 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 >
2015-03-23 23:46:30 +00:00
< / div >
< dl class = "details" >
2015-07-22 14:31:30 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#physicsBodyType" > Phaser.Group#physicsBodyType< / a >
< / li > < / dd >
2015-03-23 23:46:30 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-162" > line 162< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
2015-07-22 14:31:30 +00:00
id="physicsSortDirection">< span class = "type-signature" > < / span > physicsSortDirection< span class = "type-signature" > :integer< / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
2015-07-22 14:31:30 +00:00
< p > If this Group contains Arcade Physics Sprites you can set a custom sort direction via this property.< / p >
< p > It should be set to one of the Phaser.Physics.Arcade sort direction constants: < / p >
< p > Phaser.Physics.Arcade.SORT_NONE
Phaser.Physics.Arcade.LEFT_RIGHT
Phaser.Physics.Arcade.RIGHT_LEFT
Phaser.Physics.Arcade.TOP_BOTTOM
Phaser.Physics.Arcade.BOTTOM_TOP< / p >
< p > If set to < code > null< / code > the Group will use whatever Phaser.Physics.Arcade.sortDirection is set to. This is the default behavior.< / p >
2014-11-15 20:01:46 +00:00
< / div >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2015-07-22 14:31:30 +00:00
< a href = "Phaser.Group.html#physicsSortDirection" > Phaser.Group#physicsSortDirection< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
2015-07-22 14:31:30 +00:00
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > null< / li > < / ul > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-180" > line 180< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
2014-09-09 14:36:56 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2015-07-22 14:31:30 +00:00
id="physicsType">< span class = "type-signature" > < readonly> < / span > physicsType< span class = "type-signature" > :number< / span > < / h4 >
2014-09-09 14:36:56 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
2015-07-22 14:31:30 +00:00
< p > The const physics body type of this object.< / p >
2014-11-15 20:01:46 +00:00
< / div >
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-45" > line 45< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-09-09 14:36:56 +00:00
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2015-07-22 14:31:30 +00:00
id="pivot">< span class = "type-signature" > < / span > pivot< span class = "type-signature" > :Point< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
2015-07-22 14:31:30 +00:00
< p > The pivot point of the displayObject that it rotates around< / p >
2014-11-15 20:01:46 +00:00
< / div >
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2015-07-22 14:31:30 +00:00
< a href = "PIXI.DisplayObject.html#pivot" > PIXI.DisplayObject#pivot< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2015-07-22 14:31:30 +00:00
id="position">< span class = "type-signature" > < / span > position< span class = "type-signature" > :Point< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
2015-07-22 14:31:30 +00:00
< p > The coordinate of the object relative to the local coordinates of the parent.< / p >
2014-11-15 20:01:46 +00:00
< / div >
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2015-07-22 14:31:30 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
2015-07-22 14:31:30 +00:00
id="renderable">< span class = "type-signature" > < / span > renderable< span class = "type-signature" > :Boolean< / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
2015-07-22 14:31:30 +00:00
< p > Can this object be rendered< / p >
2014-11-15 20:01:46 +00:00
< / div >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2015-07-22 14:31:30 +00:00
< a href = "PIXI.DisplayObject.html#renderable" > PIXI.DisplayObject#renderable< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-03-14 06:36:05 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2015-07-22 14:31:30 +00:00
id="right">< span class = "type-signature" > < readonly> < / span > right< span class = "type-signature" > :number< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
2015-07-22 14:31:30 +00:00
< p > Gets the right position of the Emitter.< / p >
2014-11-15 20:01:46 +00:00
< / div >
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2015-07-22 14:31:30 +00:00
< dt class = "tag-source" > Source -
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-890" > line 890< / 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 = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#rotation" > Phaser.Group#rotation< / a >
< / li > < / dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-2196" > line 2196< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="scale">< span class = "type-signature" > < / span > scale< span class = "type-signature" > :Point< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The scale factor of the object.< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#scale" > PIXI.DisplayObject#scale< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "src_pixi_display_DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "src_pixi_display_DisplayObject.js.html#sunlight-1-line-22" > line 22< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="scaleData">< span class = "type-signature" > < / span > scaleData< span class = "type-signature" > :array< / span > < / h4 >
< / dt >
< dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > An array of the calculated scale easing data applied to particles with scaleRates > 0.< / p >
< / div >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-80" > line 80< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#stage" > PIXI.DisplayObject#stage< / a >
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="top">< span class = "type-signature" > < readonly> < / span > top< span class = "type-signature" > :number< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Gets the top position of the Emitter.< / p >
< / div >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-26 02:38:46 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-903" > line 903< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="total">< span class = "type-signature" > < readonly> < / span > total< span class = "type-signature" > :integer< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Total number of existing children in the group.< / p >
2014-11-15 20:01:46 +00:00
< / div >
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#total" > Phaser.Group#total< / a >
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-2110" > line 2110< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="transformCallback">< span class = "type-signature" > < / span > transformCallback< span class = "type-signature" > :function< / span > < / h4 >
< / dt >
< dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-11-15 20:01:46 +00:00
< a href = "PIXI.DisplayObject.html#transformCallback" > PIXI.DisplayObject#transformCallback< / a >
2014-04-10 22:13:43 +00:00
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
2014-03-14 06:36:05 +00:00
2013-10-02 19:18:24 +00:00
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="transformCallbackContext">< span class = "type-signature" > < / span > transformCallbackContext< span class = "type-signature" > :Object< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The context under which the transformCallback is invoked.< / p >
< / div >
2013-10-02 19:18:24 +00:00
2014-03-14 06:36:05 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-03-14 06:36:05 +00:00
2013-10-02 19:18:24 +00:00
2014-03-14 06:36:05 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#transformCallbackContext" > PIXI.DisplayObject#transformCallbackContext< / a >
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / dt >
2014-03-14 06:36:05 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="type">< span class = "type-signature" > < internal> < / span > type< span class = "type-signature" > :number< / span > < / h4 >
2014-03-14 06:36:05 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > Internal Phaser Type value.< / p >
2014-04-10 22:13:43 +00:00
< / div >
2014-03-14 06:36:05 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "important tag-deprecated" > Internal:< / dt >
< dd class = "tag-deprecated" > < ul >
< li > This member is < em > internal (protected)< / em > and may be modified or removed in the future.< / li >
< / ul > < / dd >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-39" > line 39< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="visible">< span class = "type-signature" > < / span > visible< span class = "type-signature" > :boolean< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > The visible state of the group. Non-visible Groups and all of their children are not rendered.< / p >
2014-11-15 20:01:46 +00:00
< / div >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2014-03-14 06:36:05 +00:00
2014-04-10 22:13:43 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-11-15 20:01:46 +00:00
< a href = "Phaser.Group.html#visible" > Phaser.Group#visible< / a >
2014-04-10 22:13:43 +00:00
< / li > < / dd >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-2205" > line 2205< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-03-14 06:36:05 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="width">< span class = "type-signature" > < / span > width< span class = "type-signature" > :number< / span > < / h4 >
2014-03-14 06:36:05 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Gets or sets the width of the Emitter. This is the region in which a particle can be emitted.< / p >
< / div >
2014-03-14 06:36:05 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-26 02:38:46 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-813" > line 813< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="worldAlpha">< span class = "type-signature" > < readonly> < / span > worldAlpha< span class = "type-signature" > :Number< / span > < / h4 >
< / dt >
< dd >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > [read-only] The multiplied alpha of the displayObject< / p >
< / div >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2014-03-14 06:36:05 +00:00
2014-04-10 22:13:43 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-11-15 20:01:46 +00:00
< a href = "PIXI.DisplayObject.html#worldAlpha" > PIXI.DisplayObject#worldAlpha< / a >
2014-04-10 22:13:43 +00:00
< / li > < / dd >
2014-03-14 06:36:05 +00:00
2014-04-10 22:13:43 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / dt >
2014-03-14 06:36:05 +00:00
2015-07-22 14:31:30 +00:00
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="worldPosition">< span class = "type-signature" > < readonly> < / span > worldPosition< span class = "type-signature" > :Point< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The position of the Display Object based on the world transform.
This value is updated at the end of updateTransform and takes all parent transforms into account.< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#worldPosition" > PIXI.DisplayObject#worldPosition< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "src_pixi_display_DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "src_pixi_display_DisplayObject.js.html#sunlight-1-line-135" > line 135< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="worldRotation">< span class = "type-signature" > < readonly> < / span > worldRotation< span class = "type-signature" > :Number< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The rotation of the Display Object, in radians, based on the world transform.
This value is updated at the end of updateTransform and takes all parent transforms into account.< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#worldRotation" > PIXI.DisplayObject#worldRotation< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "src_pixi_display_DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "src_pixi_display_DisplayObject.js.html#sunlight-1-line-155" > line 155< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="worldScale">< span class = "type-signature" > < readonly> < / span > worldScale< span class = "type-signature" > :Point< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The scale of the Display Object based on the world transform.
This value is updated at the end of updateTransform and takes all parent transforms into account.< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#worldScale" > PIXI.DisplayObject#worldScale< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "src_pixi_display_DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "src_pixi_display_DisplayObject.js.html#sunlight-1-line-145" > line 145< / a >
< / dt >
2014-03-14 06:36:05 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="worldVisible">< span class = "type-signature" > < / span > worldVisible< span class = "type-signature" > :Boolean< / span > < / h4 >
2014-03-14 06:36:05 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > [read-only] Indicates if the sprite is globally visible.< / p >
< / div >
2014-03-14 06:36:05 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#worldVisible" > PIXI.DisplayObject#worldVisible< / a >
< / li > < / dd >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_pixi_display_DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "src_pixi_display_DisplayObject.js.html#sunlight-1-line-279" > line 279< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-03-14 06:36:05 +00:00
< / dl >
< / dd >
2014-04-10 22:13:43 +00:00
2014-03-14 06:36:05 +00:00
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="x">< span class = "type-signature" > < / span > x< span class = "type-signature" > :number< / span > < / h4 >
2014-03-14 06:36:05 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Gets or sets the x position of the Emitter.< / p >
< / div >
2014-03-14 06:36:05 +00:00
2014-04-10 22:13:43 +00:00
< dl class = "details" >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-26 02:38:46 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-845" > line 845< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
id="y">< span class = "type-signature" > < / span > y< span class = "type-signature" > :number< / span > < / h4 >
< / dt >
< dd >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Gets or sets the y position of the Emitter.< / p >
< / div >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2014-03-14 06:36:05 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-26 02:38:46 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-861" > line 861< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="z">< span class = "type-signature" > < / span > z< span class = "type-signature" > :integer< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / div >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-11-15 20:01:46 +00:00
< a href = "Phaser.Group.html#z" > Phaser.Group#z< / a >
2013-10-02 19:18:24 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
2014-11-15 20:01:46 +00:00
< / dl >
< h3 class = "subsection-title" > Methods< / h3 >
< dl >
2013-10-02 19:18:24 +00:00
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
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 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< 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 >
2015-07-22 14:31:30 +00:00
< p > If Group.enableBody is set then a physics body will be created on the object, so long as one does not already exist.< / p >
2014-12-03 10:39:11 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / div >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< h5 > Parameters:< / h5 >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< table class = "params table table-striped" >
2013-10-02 19:18:24 +00:00
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-11-15 20:01:46 +00:00
< th > Argument< / th >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< th > Default< / th >
2013-10-02 19:18:24 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > child< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > < a href = "global.html#DisplayObject" > DisplayObject< / a > < / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "attributes" >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< / td >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< td class = "default" >
< / td >
2014-03-14 06:36:05 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The display object to add as a child.< / p > < / td >
2014-11-15 20:01:46 +00:00
< / tr >
2014-03-14 06:36:05 +00:00
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > silent< / code > < / td >
2014-03-14 06:36:05 +00:00
< td class = "type" >
2014-04-10 22:13:43 +00:00
< span class = "param-type" > boolean< / span >
2014-03-14 06:36:05 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< td class = "default" >
false
< / td >
2014-03-14 06:36:05 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > If true the child will not dispatch the < code > onAddedToGroup< / code > event.< / p > < / td >
2014-03-14 06:36:05 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > < a href = "global.html#DisplayObject" > DisplayObject< / a > < / span >
2014-11-15 20:01:46 +00:00
-
< / div >
< div class = "returns-desc param-desc" >
2014-12-03 10:39:11 +00:00
< p > The child that was added to the group.< / p >
2014-11-15 20:01:46 +00:00
< / div >
< / div >
< dl class = "details" >
2014-03-14 06:36:05 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-11-15 20:01:46 +00:00
< a href = "Phaser.Group.html#add" > Phaser.Group#add< / a >
2014-03-14 06:36:05 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-271" > line 271< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-03-14 06:36:05 +00:00
2013-10-02 19:18:24 +00:00
2014-03-14 06:36:05 +00:00
2013-10-02 19:18:24 +00:00
2014-03-14 06:36:05 +00:00
2013-10-02 19:18:24 +00:00
< / dl >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / div >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< h5 > Parameters:< / h5 >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< table class = "params table table-striped" >
2013-10-02 19:18:24 +00:00
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > property< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > string< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The property to increment, for example 'body.velocity.x' or 'angle'.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
2014-11-15 20:01:46 +00:00
< tr >
< td class = "name" > < code > amount< / code > < / td >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< tr >
< td class = "name" > < code > checkAlive< / code > < / td >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< td class = "type" >
< span class = "param-type" > boolean< / span >
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > If true the property will only be changed if the child is alive.< / p > < / td >
< / tr >
2013-10-02 19:18:24 +00:00
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > checkVisible< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > boolean< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > If true the property will only be changed if the child is visible.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#addAll" > Phaser.Group#addAll< / a >
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1108" > line 1108< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
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 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / div >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< h5 > Parameters:< / h5 >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< table class = "params table table-striped" >
2013-10-02 19:18:24 +00:00
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-11-15 20:01:46 +00:00
< th > Argument< / th >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< th > Default< / th >
2013-10-02 19:18:24 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > child< / code > < / td >
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > < a href = "global.html#DisplayObject" > DisplayObject< / a > < / span >
2014-11-15 20:01:46 +00:00
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The display object to add as a child.< / p > < / td >
2014-11-15 20:01:46 +00:00
< / tr >
< tr >
< td class = "name" > < code > index< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > integer< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "attributes" >
2014-12-03 10:39:11 +00:00
< optional>< br >
2014-11-15 20:01:46 +00:00
< / td >
< td class = "default" >
2014-12-03 10:39:11 +00:00
0
2014-11-15 20:01:46 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The index within the group to insert the child to.< / p > < / td >
2014-11-15 20:01:46 +00:00
< / 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 >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< td class = "default" >
false
< / td >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > If true the child will not dispatch the < code > onAddedToGroup< / code > event.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > < a href = "global.html#DisplayObject" > DisplayObject< / a > < / span >
2014-11-15 20:01:46 +00:00
-
< / div >
< div class = "returns-desc param-desc" >
2014-12-03 10:39:11 +00:00
< p > The child that was added to the group.< / p >
2014-11-15 20:01:46 +00:00
< / div >
< / div >
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#addAt" > Phaser.Group#addAt< / a >
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-400" > line 400< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Adds a child to the container.< / p >
< / div >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< h5 > Parameters:< / h5 >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< table class = "params table table-striped" >
2013-10-02 19:18:24 +00:00
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > child< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The DisplayObject to add to the container< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< div class = "returns-type" >
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
-
< / div >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_pixi_display_DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-91" > line 91< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-11-01 18:16:52 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
< / dd >
2013-11-01 18:16:52 +00:00
2014-11-15 20:01:46 +00:00
2013-11-01 18:16:52 +00:00
< dt >
2014-11-15 20:01:46 +00:00
< 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 >
2013-11-01 18:16:52 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-11-01 18:16:52 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown< / p >
2013-11-01 18:16:52 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > child< / code > < / td >
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
2013-11-01 18:16:52 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The child to add< / p > < / td >
2013-11-01 18:16:52 +00:00
< / tr >
2014-07-10 19:31:11 +00:00
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > index< / code > < / td >
2014-07-10 19:31:11 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > Number< / span >
2014-07-10 19:31:11 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The index to place the child in< / p > < / td >
2014-07-10 19:31:11 +00:00
< / tr >
2014-04-10 22:13:43 +00:00
< / tbody >
< / table >
2013-11-01 18:16:52 +00:00
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
-
< / div >
< div class = "returns-desc param-desc" >
2015-07-22 14:31:30 +00:00
< p > The child that was added.< / p >
< / div >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObjectContainer.html#addChildAt" > PIXI.DisplayObjectContainer#addChildAt< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "src_pixi_display_DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-103" > line 103< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="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 > >|< a href = "Phaser.Group.html" > Phaser.Group< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Adds an array of existing Display Objects to this Group.< / p >
< p > The Display Objects are automatically added to the top of this Group, and will render on-top of everything already in this Group.< / p >
< p > As well as an array you can also pass another Group as the first argument. In this case all of the children from that
Group will be removed from it and added into this 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 > children< / code > < / td >
< td class = "type" >
< span class = "param-type" > Array.< < a href = "global.html#DisplayObject" > DisplayObject< / a > >< / span >
|
< span class = "param-type" > < a href = "Phaser.Group.html" > Phaser.Group< / a > < / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > An array of display objects or a Phaser.Group. If a Group is given then < em > all< / em > children will be moved from it.< / 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 >
|
< span class = "param-type" > < a href = "Phaser.Group.html" > Phaser.Group< / a > < / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The array of children or Group of children that were added to this Group.< / p >
2014-11-15 20:01:46 +00:00
< / div >
< / div >
2014-04-10 22:13:43 +00:00
< dl class = "details" >
2013-11-01 18:16:52 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2015-07-22 14:31:30 +00:00
< a href = "Phaser.Group.html#addMultiple" > Phaser.Group#addMultiple< / a >
2013-11-01 18:16:52 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-369" > line 369< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-02-05 06:29:17 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2015-07-22 14:31:30 +00:00
id="addToHash">< span class = "type-signature" > < / span > addToHash< span class = "signature" > (child)< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
2014-02-05 06:29:17 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
< div class = "description" >
2015-07-22 14:31:30 +00:00
< p > Adds a child of this Group into the hash array.
This call will return false if the child is not a child of this Group, or is already in the hash.< / p >
2014-02-05 06:29:17 +00:00
< / div >
2014-04-10 22:13:43 +00:00
< h5 > Parameters:< / h5 >
2014-02-05 06:29:17 +00:00
2014-04-10 22:13:43 +00:00
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
2014-02-05 06:29:17 +00:00
2014-04-10 22:13:43 +00:00
< th > Type< / th >
2014-02-05 06:29:17 +00:00
2014-04-10 22:13:43 +00:00
2014-02-05 06:29:17 +00:00
2014-04-10 22:13:43 +00:00
2014-02-05 06:29:17 +00:00
2014-04-10 22:13:43 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2014-02-05 06:29:17 +00:00
2014-04-10 22:13:43 +00:00
< tbody >
2014-02-05 06:29:17 +00:00
2014-04-10 22:13:43 +00:00
< tr >
2015-07-22 14:31:30 +00:00
< td class = "name" > < code > child< / code > < / td >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< td class = "type" >
2015-07-22 14:31:30 +00:00
< span class = "param-type" > < a href = "global.html#DisplayObject" > DisplayObject< / a > < / span >
2014-04-10 22:13:43 +00:00
< / td >
2015-07-22 14:31:30 +00:00
< td class = "description last" > < p > The display object to add to this Groups hash. Must be a member of this Group already and not present in the hash.< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
< / tbody >
< / table >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
2015-07-22 14:31:30 +00:00
< span class = "param-type" > boolean< / span >
2014-11-15 20:01:46 +00:00
-
< / div >
< div class = "returns-desc param-desc" >
2015-07-22 14:31:30 +00:00
< p > True if the child was successfully added to the hash, otherwise false.< / p >
2014-11-15 20:01:46 +00:00
< / div >
< / div >
2013-10-02 19:18:24 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2015-07-22 14:31:30 +00:00
< a href = "Phaser.Group.html#addToHash" > Phaser.Group#addToHash< / a >
2013-10-02 19:18:24 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-319" > line 319< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< / dd >
2013-10-02 19:18:24 +00:00
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="ascendingSortHandler">< span class = "type-signature" > < internal> < / span > ascendingSortHandler< span class = "signature" > (a, b)< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > An internal helper function for the sort process.< / p >
2013-10-02 19:18:24 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > a< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > object< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The first object being sorted.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > b< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > object< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The second object being sorted.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
2014-11-15 20:01:46 +00:00
< / tbody >
< / table >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2014-07-10 19:31:11 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-11-15 20:01:46 +00:00
< a href = "Phaser.Group.html#ascendingSortHandler" > Phaser.Group#ascendingSortHandler< / a >
2014-07-10 19:31:11 +00:00
< / li > < / dd >
2014-12-03 10:39:11 +00:00
< dt class = "important tag-deprecated" > Internal:< / dt >
< dd class = "tag-deprecated" > < ul >
< li > This member is < em > internal (protected)< / em > and may be modified or removed in the future.< / li >
< / ul > < / dd >
2014-07-10 19:31:11 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1644" > line 1644< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-09-09 14:36:56 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="at">< span class = "type-signature" > < / span > at< span class = "signature" > (object)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-09-09 14:36:56 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-09-09 14:36:56 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > Change the emitters center to match the center of any object with a < code > center< / code > property, such as a Sprite.
If the object doesn't have a center property it will be set to object.x + object.width / 2< / p >
2014-09-09 14:36:56 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > object< / code > < / td >
2014-09-09 14:36:56 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > object< / span >
|
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
< span class = "param-type" > < a href = "Phaser.Sprite.html" > Phaser.Sprite< / a > < / span >
|
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
< span class = "param-type" > < a href = "Phaser.Image.html" > Phaser.Image< / a > < / span >
|
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
< span class = "param-type" > < a href = "Phaser.TileSprite.html" > Phaser.TileSprite< / a > < / span >
|
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
< span class = "param-type" > < a href = "Phaser.Text.html" > Phaser.Text< / a > < / span >
|
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
2014-09-09 14:36:56 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The object that you wish to match the center with.< / p > < / td >
2014-09-09 14:36:56 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2014-09-09 14:36:56 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-26 02:38:46 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-791" > line 791< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-09-09 14:36:56 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-09-09 14:36:56 +00:00
2013-10-23 13:00:28 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="bringToTop">< span class = "type-signature" > < / span > bringToTop< span class = "signature" > (child)< / span > < span class = "type-signature" > → {any}< / span > < / h4 >
2013-10-23 13:00:28 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-23 13:00:28 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Brings the given child to the top of this group so it renders above all other children.< / p >
2013-10-23 13:00:28 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > child< / code > < / td >
2013-10-23 13:00:28 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > any< / span >
2013-10-23 13:00:28 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The child to bring to the top of this group.< / p > < / td >
2013-10-23 13:00:28 +00:00
< / tr >
2014-11-15 20:01:46 +00:00
< / tbody >
< / table >
2013-10-23 13:00:28 +00:00
2014-11-15 20:01:46 +00:00
2013-10-23 13:00:28 +00:00
2014-11-15 20:01:46 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
2013-10-23 13:00:28 +00:00
2014-11-15 20:01:46 +00:00
< div class = "returns-type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > any< / span >
2013-10-23 13:00:28 +00:00
2014-11-15 20:01:46 +00:00
-
< / div >
< div class = "returns-desc param-desc" >
< p > The child that was moved.< / p >
< / div >
2013-10-23 13:00:28 +00:00
2014-11-15 20:01:46 +00:00
< / div >
2014-04-10 22:13:43 +00:00
< dl class = "details" >
2013-10-23 13:00:28 +00:00
2014-04-10 22:13:43 +00:00
2013-10-23 13:00:28 +00:00
2014-04-10 22:13:43 +00:00
2013-10-23 13:00:28 +00:00
2014-04-10 22:13:43 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-11-15 20:01:46 +00:00
< a href = "Phaser.Group.html#bringToTop" > Phaser.Group#bringToTop< / a >
2014-04-10 22:13:43 +00:00
< / li > < / dd >
2013-10-23 13:00:28 +00:00
2014-04-10 22:13:43 +00:00
2013-10-23 13:00:28 +00:00
2014-04-10 22:13:43 +00:00
2013-10-23 13:00:28 +00:00
2014-04-10 22:13:43 +00:00
2013-10-23 13:00:28 +00:00
2014-04-10 22:13:43 +00:00
2013-10-23 13:00:28 +00:00
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-656" > line 656< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-04-10 22:13:43 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< / dd >
2013-10-23 13:00:28 +00:00
2014-04-10 22:13:43 +00:00
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
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 >
2014-04-10 22:13:43 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< 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).
2014-11-15 20:01:46 +00:00
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 >
2014-04-10 22:13:43 +00:00
< / div >
2013-10-23 13:00:28 +00:00
2014-04-10 22:13:43 +00:00
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-11-15 20:01:46 +00:00
< th > Argument< / th >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< th > Default< / th >
2013-10-23 13:00:28 +00:00
2014-04-10 22:13:43 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
2013-10-23 13:00:28 +00:00
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > method< / code > < / td >
2013-10-23 13:00:28 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > string< / span >
2013-10-23 13:00:28 +00:00
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< / td >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< td class = "attributes" >
2013-10-23 13:00:28 +00:00
2014-11-15 20:01:46 +00:00
2013-10-23 13:00:28 +00:00
2014-11-15 20:01:46 +00:00
< / td >
2013-10-23 13:00:28 +00:00
2014-11-15 20:01:46 +00:00
< td class = "default" >
< / td >
2013-10-23 13:00:28 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > Name of the function on the child to call. Deep property lookup is supported.< / p > < / td >
2013-10-23 13:00:28 +00:00
< / tr >
2014-11-15 20:01:46 +00:00
< tr >
< td class = "name" > < code > context< / code > < / td >
2013-10-23 13:00:28 +00:00
2014-11-15 20:01:46 +00:00
< td class = "type" >
< span class = "param-type" > string< / span >
2013-10-23 13:00:28 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< / td >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< td class = "attributes" >
< optional>< br >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< / td >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< td class = "default" >
null
< / td >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< 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 >
2014-03-14 06:36:05 +00:00
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > args< / code > < / td >
2014-03-14 06:36:05 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > any< / span >
2014-03-14 06:36:05 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "attributes" >
< repeatable>< br >
< / td >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< td class = "default" >
< / td >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > Additional parameters that will be passed to the method.< / p > < / td >
2014-03-14 06:36:05 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-11-15 20:01:46 +00:00
< a href = "Phaser.Group.html#callAll" > Phaser.Group#callAll< / a >
2014-03-14 06:36:05 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1263" > line 1263< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-23 13:00:28 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-23 13:00:28 +00:00
2013-10-02 19:18:24 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="callAllExists">< span class = "type-signature" > < / span > callAllExists< span class = "signature" > (callback, existsValue, parameter)< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< / div >
2014-02-05 06:29:17 +00:00
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > callback< / code > < / td >
2014-02-05 06:29:17 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > string< / span >
2014-02-05 06:29:17 +00:00
< / td >
< td class = "attributes" >
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > Name of the function on the children to call.< / p > < / td >
2014-02-05 06:29:17 +00:00
< / tr >
2014-03-24 12:41:45 +00:00
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > existsValue< / code > < / td >
2014-03-24 12:41:45 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > boolean< / span >
2014-03-24 12:41:45 +00:00
< / td >
< td class = "attributes" >
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > Only children with exists=existsValue will be called.< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
< tr >
< td class = "name" > < code > parameter< / code > < / td >
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > any< / span >
2014-04-10 22:13:43 +00:00
< / td >
< td class = "attributes" >
< repeatable>< br >
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > Additional parameters that will be passed to the callback.< / p > < / td >
2014-03-24 12:41:45 +00:00
< / tr >
2014-02-05 06:29:17 +00:00
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-11-15 20:01:46 +00:00
< a href = "Phaser.Group.html#callAllExists" > Phaser.Group#callAllExists< / a >
2013-10-02 19:18:24 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1176" > line 1176< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Returns a reference to a function that exists on a child of the group based on the given callback array.< / p >
2013-10-02 19:18:24 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > child< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > object< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The object to inspect.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > callback< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > array< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The array of function names.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > length< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > integer< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The size of the array (pre-calculated in callAll).< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-11-15 20:01:46 +00:00
< a href = "Phaser.Group.html#callbackFromArray" > Phaser.Group#callbackFromArray< / a >
2013-10-02 19:18:24 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "important tag-deprecated" > Internal:< / dt >
< dd class = "tag-deprecated" > < ul >
< li > This member is < em > internal (protected)< / em > and may be modified or removed in the future.< / li >
< / ul > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1210" > line 1210< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< / div >
2014-02-05 06:29:17 +00:00
< h5 > Parameters:< / h5 >
2013-10-02 19:18:24 +00:00
2014-02-05 06:29:17 +00:00
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
2013-10-02 19:18:24 +00:00
2014-02-05 06:29:17 +00:00
< th > Type< / th >
2013-10-02 19:18:24 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< th > Argument< / th >
2013-10-02 19:18:24 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< th > Default< / th >
2013-10-02 19:18:24 +00:00
2014-02-05 06:29:17 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2013-10-02 19:18:24 +00:00
< tbody >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > key< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > string< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "attributes" >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< td class = "default" >
< / td >
< td class = "description last" > < p > The property, as a string, to be set. For example: 'body.velocity.x'< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< tr >
2014-07-18 11:45:51 +00:00
< td class = "name" > < code > value< / code > < / td >
2014-04-10 22:13:43 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > any< / span >
2014-04-10 22:13:43 +00:00
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
2014-07-18 11:45:51 +00:00
< td class = "description last" > < p > The value that will be checked.< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
< tr >
2014-07-18 11:45:51 +00:00
< td class = "name" > < code > checkAlive< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-07-18 11:45:51 +00:00
< span class = "param-type" > boolean< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-04-10 22:13:43 +00:00
< td class = "attributes" >
2014-07-18 11:45:51 +00:00
< optional>< br >
2014-04-10 22:13:43 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< td class = "default" >
2014-07-18 11:45:51 +00:00
false
2014-04-10 22:13:43 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2014-07-18 11:45:51 +00:00
< 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 >
2014-04-10 22:13:43 +00:00
< / tr >
< tr >
2014-07-18 11:45:51 +00:00
< td class = "name" > < code > checkVisible< / code > < / td >
2014-04-10 22:13:43 +00:00
< td class = "type" >
2014-07-18 11:45:51 +00:00
< span class = "param-type" > boolean< / span >
2014-04-10 22:13:43 +00:00
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
2014-07-18 11:45:51 +00:00
false
2014-04-10 22:13:43 +00:00
< / td >
2014-07-18 11:45:51 +00:00
< 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 >
2014-04-10 22:13:43 +00:00
< / tr >
< tr >
2014-07-18 11:45:51 +00:00
< td class = "name" > < code > force< / code > < / td >
2014-04-10 22:13:43 +00:00
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
2014-07-18 11:45:51 +00:00
false
2014-04-10 22:13:43 +00:00
< / td >
2014-07-18 11:45:51 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-07-18 11:45:51 +00:00
< a href = "Phaser.Group.html#checkAll" > Phaser.Group#checkAll< / a >
2013-10-02 19:18:24 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1075" > line 1075< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-07-18 11:45:51 +00:00
< / dd >
2014-04-10 22:13:43 +00:00
2014-07-18 11:45:51 +00:00
< dt >
2014-11-15 20:01:46 +00:00
< 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 >
2014-07-18 11:45:51 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-07-18 11:45:51 +00:00
< div class = "description" >
< p > Checks a property for the given value on the child.< / p >
< / div >
2014-04-10 22:13:43 +00:00
2014-07-18 11:45:51 +00:00
< 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" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > any< / span >
2014-07-18 11:45:51 +00:00
< / 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" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > any< / span >
2014-07-18 11:45:51 +00:00
< / 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 >
2014-11-15 20:01:46 +00:00
< 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 >
2014-07-18 11:45:51 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#checkProperty" > Phaser.Group#checkProperty< / a >
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-939" > line 939< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-07-18 11:45:51 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-07-18 11:45:51 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="countDead">< span class = "type-signature" > < / span > countDead< span class = "signature" > ()< / span > < span class = "type-signature" > → {integer}< / span > < / h4 >
2014-07-18 11:45:51 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-07-18 11:45:51 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Get the number of dead children in this group.< / p >
2014-07-18 11:45:51 +00:00
< / div >
2014-12-03 10:39:11 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< span class = "param-type" > integer< / span >
2014-07-18 11:45:51 +00:00
2014-12-03 10:39:11 +00:00
-
< / div >
< div class = "returns-desc param-desc" >
< p > The number of children flagged as dead.< / p >
< / div >
2014-07-18 11:45:51 +00:00
2014-12-03 10:39:11 +00:00
< / div >
< dl class = "details" >
2014-07-18 11:45:51 +00:00
2014-12-03 10:39:11 +00:00
2014-07-18 11:45:51 +00:00
2014-12-03 10:39:11 +00:00
2014-07-18 11:45:51 +00:00
2014-12-03 10:39:11 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#countDead" > Phaser.Group#countDead< / a >
< / li > < / dd >
2014-07-18 11:45:51 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-07-18 11:45:51 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1866" > line 1866< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-07-18 11:45:51 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-07-18 11:45:51 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="countLiving">< span class = "type-signature" > < / span > countLiving< span class = "signature" > ()< / span > < span class = "type-signature" > → {integer}< / span > < / h4 >
2014-07-18 11:45:51 +00:00
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
2014-07-18 11:45:51 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Get the number of living children in this group.< / p >
2014-11-15 20:01:46 +00:00
< / div >
2014-07-18 11:45:51 +00:00
2014-11-15 20:01:46 +00:00
2014-07-18 11:45:51 +00:00
2014-11-15 20:01:46 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > integer< / span >
2014-07-18 11:45:51 +00:00
2014-11-15 20:01:46 +00:00
-
< / div >
< div class = "returns-desc param-desc" >
< p > The number of children flagged as alive.< / p >
< / div >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#countLiving" > Phaser.Group#countLiving< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1854" > line 1854< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-07-18 11:45:51 +00:00
2014-11-15 20:01:46 +00:00
2014-07-18 11:45:51 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-07-18 11:45:51 +00:00
2014-11-15 20:01:46 +00:00
2014-07-18 11:45:51 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
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 >
2014-07-18 11:45:51 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-07-18 11:45:51 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< 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 >
2014-07-18 11:45:51 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< 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 >
2014-12-03 10:39:11 +00:00
< 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 >
2014-07-18 11:45:51 +00:00
< / tr >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
2014-12-03 10:39:11 +00:00
< 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 >
2014-07-18 11:45:51 +00:00
< / 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" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > integer< / span >
2014-07-18 11:45:51 +00:00
|
< 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 >
2014-11-15 20:01:46 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > < a href = "global.html#DisplayObject" > DisplayObject< / a > < / span >
2014-11-15 20:01:46 +00:00
-
< / div >
< div class = "returns-desc param-desc" >
2014-12-03 10:39:11 +00:00
< p > The child that was created: will be a < a href = "Phaser.Sprite.html" > Phaser.Sprite< / a > unless #classType has been changed.< / p >
2014-11-15 20:01:46 +00:00
< / div >
< / div >
2014-07-18 11:45:51 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#create" > Phaser.Group#create< / a >
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-465" > line 465< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-07-18 11:45:51 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< / dd >
2013-10-02 19:18:24 +00:00
< dt >
2014-11-15 20:01:46 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< 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).
2015-07-22 14:31:30 +00:00
Use < a href = "Phaser.Group.html#classType" > classType< / a > to change the type of object created.< / p >
2013-10-02 19:18:24 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-04-10 22:13:43 +00:00
< th > Argument< / th >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< th > Default< / th >
2013-10-02 19:18:24 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-04-10 22:13:43 +00:00
< td class = "name" > < code > quantity< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > integer< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-04-10 22:13:43 +00:00
< td class = "attributes" >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< td class = "default" >
< / td >
< td class = "description last" > < p > The number of Sprites to create.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< tr >
2014-04-10 22:13:43 +00:00
< td class = "name" > < code > key< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-04-10 22:13:43 +00:00
< span class = "param-type" > string< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-04-10 22:13:43 +00:00
< td class = "attributes" >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< 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" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > integer< / span >
2014-04-10 22:13:43 +00:00
|
< 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 >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-04-10 22:13:43 +00:00
< a href = "Phaser.Group.html#createMultiple" > Phaser.Group#createMultiple< / a >
2013-10-02 19:18:24 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-511" > line 511< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="customSort">< span class = "type-signature" > < / span > customSort< span class = "signature" > (sortHandler, < span class = "optional" > context< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-12-03 10:39:11 +00:00
< th > Argument< / th >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< th > Default< / th >
2013-10-02 19:18:24 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-04-10 22:13:43 +00:00
< td class = "name" > < code > sortHandler< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-04-10 22:13:43 +00:00
< span class = "param-type" > function< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< / td >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< td class = "default" >
< / td >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The custom sort function.< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
< tr >
< td class = "name" > < code > context< / code > < / td >
< td class = "type" >
< span class = "param-type" > object< / span >
< / td >
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2014-04-10 22:13:43 +00:00
2014-12-03 10:39:11 +00:00
< td class = "default" >
undefined
< / td >
2014-04-10 22:13:43 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The context in which the sortHandler is called.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-04-10 22:13:43 +00:00
< a href = "Phaser.Group.html#customSort" > Phaser.Group#customSort< / a >
2014-03-14 06:36:05 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1620" > line 1620< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-03-14 06:36:05 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="descendingSortHandler">< span class = "type-signature" > < internal> < / span > descendingSortHandler< span class = "signature" > (a, b)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-03-14 06:36:05 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
< div class = "description" >
2014-04-10 22:13:43 +00:00
< p > An internal helper function for the sort process.< / p >
2014-03-14 06:36:05 +00:00
< / div >
2014-04-10 22:13:43 +00:00
< h5 > Parameters:< / h5 >
2014-03-14 06:36:05 +00:00
2014-04-10 22:13:43 +00:00
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
2014-03-14 06:36:05 +00:00
2014-04-10 22:13:43 +00:00
< th > Type< / th >
2014-03-14 06:36:05 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< tbody >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< tr >
< td class = "name" > < code > a< / code > < / td >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< td class = "type" >
< span class = "param-type" > object< / span >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< td class = "description last" > < p > The first object being sorted.< / p > < / td >
< / tr >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< tr >
< td class = "name" > < code > b< / code > < / td >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< td class = "type" >
< span class = "param-type" > object< / span >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< td class = "description last" > < p > The second object being sorted.< / p > < / td >
< / tr >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< / tbody >
< / table >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-04-10 22:13:43 +00:00
< a href = "Phaser.Group.html#descendingSortHandler" > Phaser.Group#descendingSortHandler< / a >
2013-10-02 19:18:24 +00:00
< / li > < / dd >
2014-12-03 10:39:11 +00:00
< dt class = "important tag-deprecated" > Internal:< / dt >
< dd class = "tag-deprecated" > < ul >
< li > This member is < em > internal (protected)< / em > and may be modified or removed in the future.< / li >
< / ul > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1676" > line 1676< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2015-03-26 02:38:46 +00:00
id="destroy">< span class = "type-signature" > < / span > destroy< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< div class = "description" >
2015-03-26 02:38:46 +00:00
< p > Destroys this Emitter, all associated child Particles and then removes itself from the Particle Manager.< / p >
2013-10-02 19:18:24 +00:00
< / div >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-26 02:38:46 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-628" > line 628< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-04-10 22:13:43 +00:00
< td class = "name" > < code > property< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-04-10 22:13:43 +00:00
< span class = "param-type" > string< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-04-10 22:13:43 +00:00
< td class = "description last" > < p > The property to divide, for example 'body.velocity.x' or 'angle'.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
2014-04-10 22:13:43 +00:00
< 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" >
2014-07-10 19:31:11 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
2014-07-10 19:31:11 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#divideAll" > Phaser.Group#divideAll< / a >
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1159" > line 1159< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-07-10 19:31:11 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-07-10 19:31:11 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2015-01-06 06:57:25 +00:00
id="emitParticle">< span class = "type-signature" > < / span > emitParticle< span class = "signature" > ()< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
2014-07-10 19:31:11 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-07-10 19:31:11 +00:00
< div class = "description" >
< p > This function can be used both internally and externally to emit the next particle in the queue.< / p >
< / div >
2014-11-15 20:01:46 +00:00
2015-01-06 06:57:25 +00:00
< 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 a particle was emitted, otherwise false.< / p >
< / div >
< / div >
2014-07-10 19:31:11 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-538" > line 538< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-07-10 19:31:11 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-07-10 19:31:11 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="explode">< span class = "type-signature" > < / span > explode< span class = "signature" > (< span class = "optional" > lifespan< / span > , < span class = "optional" > quantity< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2014-07-10 19:31:11 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-07-10 19:31:11 +00:00
< div class = "description" >
< p > Call this function to emit the given quantity of particles at all once (an explosion)< / 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 > lifespan< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
0
< / td >
< td class = "description last" > < p > How long each particle lives once emitted in ms. 0 = forever.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > quantity< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
0
< / td >
< td class = "description last" > < p > How many particles to launch.< / p > < / td >
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2014-07-10 19:31:11 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-432" > line 432< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-07-10 19:31:11 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-07-10 19:31:11 +00:00
2014-10-09 15:12:53 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-11-25 00:23:44 +00:00
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 >
2014-10-09 15:12:53 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-10-09 15:12:53 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Find children matching a certain predicate.< / p >
< p > For example:< / p >
2015-03-23 23:46:30 +00:00
< pre class = "prettyprint source" > < code > var healthyList = Group.filter(function(child, index, children) {
return child.health > 10 ? true : false;
2014-11-25 00:23:44 +00:00
}, true);
2015-03-23 23:46:30 +00:00
healthyList.callAll('attack');< / code > < / pre > < p > Note: Currently this will skip any children which are Groups themselves.< / p >
2014-10-09 15:12:53 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< 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 >
2014-12-03 10:39:11 +00:00
< 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 >
2014-10-09 15:12:53 +00:00
< / 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 >
2014-12-03 10:39:11 +00:00
< 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 >
2014-10-09 15:12:53 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
2014-11-25 00:23:44 +00:00
< span class = "param-type" > < a href = "Phaser.ArraySet.html" > Phaser.ArraySet< / a > < / span >
2014-11-15 20:01:46 +00:00
-
< / 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 >
2014-10-09 15:12:53 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#filter" > Phaser.Group#filter< / a >
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1406" > line 1406< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-10-09 15:12:53 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-10-09 15:12:53 +00:00
2014-07-10 19:31:11 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2015-03-23 23:46:30 +00:00
id="flow">< span class = "type-signature" > < / span > flow< span class = "signature" > (< span class = "optional" > lifespan< / span > , < span class = "optional" > frequency< / span > , < span class = "optional" > quantity< / span > , < span class = "optional" > total< / span > , < span class = "optional" > immediate< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2014-07-10 19:31:11 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-07-10 19:31:11 +00:00
< div class = "description" >
2015-03-23 23:46:30 +00:00
< p > Call this function to start emitting a flow of particles at the given frequency.
It will carry on going until the total given is reached.
Each time the flow is run the quantity number of particles will be emitted together.
If you set the total to be 20 and quantity to be 5 then flow will emit 4 times in total (4 x 5 = 20 total)
If you set the total to be -1 then no quantity cap is used and it will keep emitting.< / p >
2014-07-10 19:31:11 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > lifespan< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
0
< / td >
< td class = "description last" > < p > How long each particle lives once emitted in ms. 0 = forever.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > frequency< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
2014-04-10 22:13:43 +00:00
2014-07-10 19:31:11 +00:00
2014-04-10 22:13:43 +00:00
2014-07-10 19:31:11 +00:00
< / td >
2014-04-10 22:13:43 +00:00
2014-07-10 19:31:11 +00:00
< td class = "default" >
250
< / td >
2014-04-10 22:13:43 +00:00
2015-03-23 23:46:30 +00:00
< td class = "description last" > < p > Frequency is how often to emit the particles, given in ms.< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
< tr >
2014-07-10 19:31:11 +00:00
< td class = "name" > < code > quantity< / code > < / td >
2014-04-10 22:13:43 +00:00
< td class = "type" >
2014-07-10 19:31:11 +00:00
< span class = "param-type" > number< / span >
2014-04-10 22:13:43 +00:00
< / td >
2014-07-10 19:31:11 +00:00
< td class = "attributes" >
< optional>< br >
2014-04-10 22:13:43 +00:00
2014-07-10 19:31:11 +00:00
< / td >
2014-04-10 22:13:43 +00:00
2014-07-10 19:31:11 +00:00
< td class = "default" >
2015-03-23 23:46:30 +00:00
1
2014-07-10 19:31:11 +00:00
< / td >
2015-03-23 23:46:30 +00:00
< td class = "description last" > < p > How many particles to launch each time the frequency is met. Can never be > Emitter.maxParticles.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > total< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
-1
< / td >
< td class = "description last" > < p > How many particles to launch in total. If -1 it will carry on indefinitely.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > immediate< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
true
< / td >
< td class = "description last" > < p > Should the flow start immediately (true) or wait until the first frequency event? (false)< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-447" > line 447< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-03-14 06:36:05 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="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 >
2014-03-14 06:36:05 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > 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 >
2015-03-23 23:46:30 +00:00
< 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 >
2014-03-14 06:36:05 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-04-10 22:13:43 +00:00
< th > Argument< / th >
2014-03-14 06:36:05 +00:00
2014-04-10 22:13:43 +00:00
< th > Default< / th >
2014-03-14 06:36:05 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-04-10 22:13:43 +00:00
< td class = "name" > < code > callback< / code > < / td >
2014-03-14 06:36:05 +00:00
< td class = "type" >
2014-04-10 22:13:43 +00:00
< span class = "param-type" > function< / span >
2014-03-14 06:36:05 +00:00
< / td >
2014-04-10 22:13:43 +00:00
< td class = "attributes" >
2014-03-14 06:36:05 +00:00
2014-04-10 22:13:43 +00:00
< / td >
2014-03-14 06:36:05 +00:00
2014-04-10 22:13:43 +00:00
< td class = "default" >
< / td >
2014-12-03 10:39:11 +00:00
< 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 >
2014-03-14 06:36:05 +00:00
< / tr >
< tr >
2014-04-10 22:13:43 +00:00
< td class = "name" > < code > callbackContext< / code > < / td >
2014-03-14 06:36:05 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > object< / span >
2014-03-14 06:36:05 +00:00
< / td >
2014-04-10 22:13:43 +00:00
< td class = "attributes" >
2014-03-14 06:36:05 +00:00
2014-04-10 22:13:43 +00:00
< / td >
2014-03-14 06:36:05 +00:00
2014-04-10 22:13:43 +00:00
< td class = "default" >
< / td >
< td class = "description last" > < p > The context in which the function should be called (usually 'this').< / p > < / td >
2014-03-14 06:36:05 +00:00
< / tr >
2014-04-10 22:13:43 +00:00
< tr >
< td class = "name" > < code > checkExists< / code > < / td >
2014-03-14 06:36:05 +00:00
2014-04-10 22:13:43 +00:00
< td class = "type" >
< span class = "param-type" > boolean< / span >
2014-03-14 06:36:05 +00:00
2014-04-10 22:13:43 +00:00
< / td >
2014-03-14 06:36:05 +00:00
2014-04-10 22:13:43 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
false
< / td >
2014-12-03 10:39:11 +00:00
< 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 >
2014-04-10 22:13:43 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#forEach" > Phaser.Group#forEach< / a >
< / li > < / dd >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1446" > line 1446< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-03-14 06:36:05 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="forEachAlive">< span class = "type-signature" > < / span > forEachAlive< span class = "signature" > (callback, callbackContext, < span class = "optional" > args< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2014-03-14 06:36:05 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Call a function on each alive child in this group.< / p >
< p > See < a href = "Phaser.Group.html#forEach" > forEach< / a > for details.< / p >
2014-03-14 06:36:05 +00:00
< / div >
2014-04-10 22:13:43 +00:00
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-12-03 10:39:11 +00:00
< th > Argument< / th >
2014-04-10 22:13:43 +00:00
2014-12-03 10:39:11 +00:00
< th > Default< / th >
2014-04-10 22:13:43 +00:00
< 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 >
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< / td >
2014-04-10 22:13:43 +00:00
2014-12-03 10:39:11 +00:00
< td class = "default" >
< / td >
2014-04-10 22:13:43 +00:00
2014-12-03 10:39:11 +00:00
< 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 >
2014-04-10 22:13:43 +00:00
< / tr >
< tr >
< td class = "name" > < code > callbackContext< / code > < / td >
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > object< / span >
2014-04-10 22:13:43 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< / td >
2014-04-10 22:13:43 +00:00
2014-12-03 10:39:11 +00:00
< td class = "default" >
< / td >
2014-04-10 22:13:43 +00:00
< td class = "description last" > < p > The context in which the function should be called (usually 'this').< / p > < / td >
< / tr >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< 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" >
2014-03-14 06:36:05 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-04-10 22:13:43 +00:00
< a href = "Phaser.Group.html#forEachAlive" > Phaser.Group#forEachAlive< / a >
2013-10-02 19:18:24 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1528" > line 1528< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
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 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-12-03 10:39:11 +00:00
< th > Argument< / th >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< th > Default< / th >
2013-10-02 19:18:24 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-04-10 22:13:43 +00:00
< td class = "name" > < code > callback< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-04-10 22:13:43 +00:00
< span class = "param-type" > function< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< / td >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< td class = "default" >
< / td >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< / tr >
< tr >
2014-04-10 22:13:43 +00:00
< td class = "name" > < code > callbackContext< / code > < / td >
2014-03-14 06:36:05 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > object< / span >
2014-03-14 06:36:05 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< / td >
2014-03-14 06:36:05 +00:00
2014-12-03 10:39:11 +00:00
< td class = "default" >
< / td >
2014-03-14 06:36:05 +00:00
2014-04-10 22:13:43 +00:00
< td class = "description last" > < p > The context in which the function should be called (usually 'this').< / p > < / td >
2014-03-14 06:36:05 +00:00
< / tr >
2014-12-03 10:39:11 +00:00
< 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 >
2014-04-10 22:13:43 +00:00
< / tbody >
< / table >
2014-03-14 06:36:05 +00:00
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#forEachDead" > Phaser.Group#forEachDead< / a >
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2014-03-14 06:36:05 +00:00
2014-04-10 22:13:43 +00:00
2014-03-14 06:36:05 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1556" > line 1556< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-04-10 22:13:43 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< / dd >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
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 >
2014-04-10 22:13:43 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< 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 >
2014-04-10 22:13:43 +00:00
< / div >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
2014-03-14 06:36:05 +00:00
2014-04-10 22:13:43 +00:00
< th > Type< / th >
2014-12-03 10:39:11 +00:00
< th > Argument< / th >
2014-04-10 22:13:43 +00:00
2014-12-03 10:39:11 +00:00
< th > Default< / th >
2014-04-10 22:13:43 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
2014-03-14 06:36:05 +00:00
< tr >
< td class = "name" > < code > callback< / code > < / td >
< td class = "type" >
< span class = "param-type" > function< / span >
< / td >
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< / td >
2014-03-14 06:36:05 +00:00
2014-12-03 10:39:11 +00:00
< td class = "default" >
< / td >
2014-03-14 06:36:05 +00:00
2014-12-03 10:39:11 +00:00
< 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 >
2014-03-14 06:36:05 +00:00
< / tr >
< tr >
< td class = "name" > < code > callbackContext< / code > < / td >
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > object< / span >
2014-03-14 06:36:05 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< / td >
2014-03-14 06:36:05 +00:00
2014-12-03 10:39:11 +00:00
< td class = "default" >
< / td >
2014-03-14 06:36:05 +00:00
< td class = "description last" > < p > The context in which the function should be called (usually 'this').< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
2014-12-03 10:39:11 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-04-10 22:13:43 +00:00
< a href = "Phaser.Group.html#forEachExists" > Phaser.Group#forEachExists< / a >
2013-10-02 19:18:24 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1500" > line 1500< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< 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 >
2014-03-14 06:36:05 +00:00
< / div >
2014-04-10 22:13:43 +00:00
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > resolution< / code > < / td >
2014-04-10 22:13:43 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > Number< / span >
2014-04-10 22:13:43 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< 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 >
2014-04-10 22:13:43 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > < a href = "PIXI.Texture.html" > PIXI.Texture< / a > < / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > a texture of the graphics object< / p >
< / div >
< / div >
2014-03-14 06:36:05 +00:00
< dl class = "details" >
2014-04-10 22:13:43 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-11-15 20:01:46 +00:00
< a href = "PIXI.DisplayObject.html#generateTexture" > PIXI.DisplayObject#generateTexture< / a >
2014-04-10 22:13:43 +00:00
< / li > < / dd >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_pixi_display_DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "src_pixi_display_DisplayObject.js.html#sunlight-1-line-549" > line 549< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-03-14 06:36:05 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2015-07-22 14:31:30 +00:00
id="getAt">< span class = "type-signature" > < / span > getAt< span class = "signature" > (index)< / span > < span class = "type-signature" > → {< a href = "global.html#DisplayObject" > DisplayObject< / a > |integer}< / span > < / h4 >
2014-03-14 06:36:05 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Returns the child found at the given index within this group.< / p >
2013-10-02 19:18:24 +00:00
< / div >
2014-11-15 20:01:46 +00:00
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > index< / code > < / td >
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > integer< / span >
2014-11-15 20:01:46 +00:00
< / 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" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > < a href = "global.html#DisplayObject" > DisplayObject< / a > < / span >
2015-07-22 14:31:30 +00:00
|
< span class = "param-type" > integer< / span >
2014-11-15 20:01:46 +00:00
-
< / div >
< div class = "returns-desc param-desc" >
2014-12-03 10:39:11 +00:00
< p > The child that was found at the given index, or -1 for an invalid index.< / p >
2014-11-15 20:01:46 +00:00
< / div >
< / div >
2014-04-10 22:13:43 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-11-15 20:01:46 +00:00
< a href = "Phaser.Group.html#getAt" > Phaser.Group#getAt< / a >
2014-04-10 22:13:43 +00:00
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-445" > line 445< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-04-10 22:13:43 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="getBottom">< span class = "type-signature" > < / span > getBottom< span class = "signature" > ()< / span > < span class = "type-signature" > → {any}< / span > < / h4 >
2014-04-10 22:13:43 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< 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 >
2014-04-10 22:13:43 +00:00
< / div >
2014-11-15 20:01:46 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > any< / span >
2014-11-15 20:01:46 +00:00
-
< / div >
< div class = "returns-desc param-desc" >
< p > The child at the bottom of the Group.< / p >
< / div >
< / div >
2014-04-10 22:13:43 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-11-15 20:01:46 +00:00
< a href = "Phaser.Group.html#getBottom" > Phaser.Group#getBottom< / a >
2014-04-10 22:13:43 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1837" > line 1837< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-04-10 22:13:43 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2015-03-23 23:46:30 +00:00
id="getBounds">< span class = "type-signature" > < / span > getBounds< span class = "signature" > ()< / span > < span class = "type-signature" > → {Rectangle}< / span > < / h4 >
2014-04-10 22:13:43 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > Retrieves the bounds of the displayObjectContainer as a rectangle. The bounds calculation takes all visible children into consideration.< / p >
2014-04-10 22:13:43 +00:00
< / div >
2014-11-15 20:01:46 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
2015-03-23 23:46:30 +00:00
< span class = "param-type" > Rectangle< / span >
2014-11-15 20:01:46 +00:00
-
< / div >
< div class = "returns-desc param-desc" >
< p > The rectangular bounding area< / p >
< / div >
< / div >
2014-04-10 22:13:43 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-11-15 20:01:46 +00:00
< a href = "PIXI.DisplayObjectContainer.html#getBounds" > PIXI.DisplayObjectContainer#getBounds< / a >
2014-04-10 22:13:43 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_pixi_display_DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-307" > line 307< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-04-10 22:13:43 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< 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 >
2014-04-10 22:13:43 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > Returns the child at the specified index< / p >
2014-04-10 22:13:43 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > index< / code > < / td >
2014-04-10 22:13:43 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > Number< / span >
2014-04-10 22:13:43 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The index to get the child from< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The child at the given index, if any.< / p >
< / div >
< / div >
2014-04-10 22:13:43 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-11-15 20:01:46 +00:00
< a href = "PIXI.DisplayObjectContainer.html#getChildAt" > PIXI.DisplayObjectContainer#getChildAt< / a >
2014-04-10 22:13:43 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_pixi_display_DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-194" > line 194< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-04-10 22:13:43 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="getChildIndex">< span class = "type-signature" > < / span > getChildIndex< span class = "signature" > (child)< / span > < span class = "type-signature" > → {Number}< / span > < / h4 >
2014-04-10 22:13:43 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > Returns the index position of a child DisplayObject instance< / p >
2014-04-10 22:13:43 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > child< / code > < / td >
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
2014-04-10 22:13:43 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The DisplayObject instance to identify< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > Number< / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The index position of the child display object to identify< / p >
< / div >
< / div >
2014-04-10 22:13:43 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-11-15 20:01:46 +00:00
< a href = "PIXI.DisplayObjectContainer.html#getChildIndex" > PIXI.DisplayObjectContainer#getChildIndex< / a >
2014-04-10 22:13:43 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_pixi_display_DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-159" > line 159< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-04-10 22:13:43 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="getFirstAlive">< span class = "type-signature" > < / span > getFirstAlive< span class = "signature" > ()< / span > < span class = "type-signature" > → {any}< / span > < / h4 >
2014-04-10 22:13:43 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< 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 >
2014-04-10 22:13:43 +00:00
< / div >
2014-11-15 20:01:46 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< div class = "returns-type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > any< / span >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
-
< / div >
< div class = "returns-desc param-desc" >
< p > The first alive child, or null if none found.< / p >
< / div >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< / div >
2014-04-10 22:13:43 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-11-15 20:01:46 +00:00
< a href = "Phaser.Group.html#getFirstAlive" > Phaser.Group#getFirstAlive< / a >
2014-04-10 22:13:43 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1792" > line 1792< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-04-10 22:13:43 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="getFirstDead">< span class = "type-signature" > < / span > getFirstDead< span class = "signature" > ()< / span > < span class = "type-signature" > → {any}< / span > < / h4 >
2014-04-10 22:13:43 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< 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 >
2014-04-10 22:13:43 +00:00
< / div >
2014-11-15 20:01:46 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > any< / span >
2014-11-15 20:01:46 +00:00
-
< / div >
< div class = "returns-desc param-desc" >
< p > The first dead child, or null if none found.< / p >
< / div >
< / div >
2014-04-10 22:13:43 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-11-15 20:01:46 +00:00
< a href = "Phaser.Group.html#getFirstDead" > Phaser.Group#getFirstDead< / a >
2014-04-10 22:13:43 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1806" > line 1806< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-04-10 22:13:43 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
2014-05-20 09:12:48 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="getFirstExists">< span class = "type-signature" > < / span > getFirstExists< span class = "signature" > (< span class = "optional" > exists< / span > )< / span > < span class = "type-signature" > → {any}< / span > < / h4 >
2014-05-20 09:12:48 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-05-20 09:12:48 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Get the first display object that exists, or doesn't exist.< / p >
2014-05-20 09:12:48 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-12-03 10:39:11 +00:00
< th > Argument< / th >
2014-05-20 09:12:48 +00:00
2014-12-03 10:39:11 +00:00
< th > Default< / th >
2014-05-20 09:12:48 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > exists< / code > < / td >
2014-05-20 09:12:48 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > boolean< / span >
2014-05-20 09:12:48 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2014-05-20 09:12:48 +00:00
2014-12-03 10:39:11 +00:00
< td class = "default" >
true
< / td >
2014-05-20 09:12:48 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > If true, find the first existing child; otherwise find the first non-existing child.< / p > < / td >
2014-05-20 09:12:48 +00:00
< / tr >
2014-11-15 20:01:46 +00:00
< / tbody >
< / table >
2014-05-20 09:12:48 +00:00
2014-11-15 20:01:46 +00:00
2014-05-20 09:12:48 +00:00
2014-11-15 20:01:46 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
2014-05-20 09:12:48 +00:00
2014-11-15 20:01:46 +00:00
< div class = "returns-type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > any< / span >
2014-05-20 09:12:48 +00:00
2014-11-15 20:01:46 +00:00
-
< / div >
< div class = "returns-desc param-desc" >
< p > The first child, or null if none found.< / p >
< / div >
2014-05-20 09:12:48 +00:00
2014-11-15 20:01:46 +00:00
< / div >
2014-05-20 09:12:48 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-11-15 20:01:46 +00:00
< a href = "Phaser.Group.html#getFirstExists" > Phaser.Group#getFirstExists< / a >
2014-05-20 09:12:48 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1774" > line 1774< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-05-20 09:12:48 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-05-20 09:12:48 +00:00
2014-04-10 22:13:43 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="getIndex">< span class = "type-signature" > < / span > getIndex< span class = "signature" > (child)< / span > < span class = "type-signature" > → {integer}< / span > < / h4 >
2014-04-10 22:13:43 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Get the index position of the given child in this group, which should match the child's < code > z< / code > property.< / p >
2014-04-10 22:13:43 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > child< / code > < / td >
2014-04-10 22:13:43 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > any< / span >
2014-04-10 22:13:43 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The child to get the index for.< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
2014-11-15 20:01:46 +00:00
< / tbody >
< / table >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< div class = "returns-type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > integer< / span >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
-
< / div >
< div class = "returns-desc param-desc" >
2014-12-03 10:39:11 +00:00
< p > The index of the child or -1 if it's not a member of this group.< / p >
2014-11-15 20:01:46 +00:00
< / div >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< / div >
2014-04-10 22:13:43 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-11-15 20:01:46 +00:00
< a href = "Phaser.Group.html#getIndex" > Phaser.Group#getIndex< / a >
2014-04-10 22:13:43 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-778" > line 778< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-04-10 22:13:43 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2015-03-23 23:46:30 +00:00
id="getLocalBounds">< span class = "type-signature" > < / span > getLocalBounds< span class = "signature" > ()< / span > < span class = "type-signature" > → {Rectangle}< / span > < / h4 >
2014-04-10 22:13:43 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.< / p >
2014-04-10 22:13:43 +00:00
< / div >
2014-11-15 20:01:46 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
2015-03-23 23:46:30 +00:00
< span class = "param-type" > Rectangle< / span >
2014-11-15 20:01:46 +00:00
-
< / div >
< div class = "returns-desc param-desc" >
< p > The rectangular bounding area< / p >
< / div >
< / div >
2014-04-10 22:13:43 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObjectContainer.html#getLocalBounds" > PIXI.DisplayObjectContainer#getLocalBounds< / a >
< / li > < / dd >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_pixi_display_DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-367" > line 367< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-04-10 22:13:43 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
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 >
2014-04-10 22:13:43 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Returns a random child from the group.< / p >
2014-04-10 22:13:43 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-12-03 10:39:11 +00:00
< th > Argument< / th >
2014-04-10 22:13:43 +00:00
2014-12-03 10:39:11 +00:00
< th > Default< / th >
2014-04-10 22:13:43 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > startIndex< / code > < / td >
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > integer< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2013-10-02 19:18:24 +00:00
2013-11-07 06:10:15 +00:00
2014-12-03 10:39:11 +00:00
< td class = "default" >
0
< / td >
2013-11-07 06:10:15 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > Offset from the front of the front of the group (lowest child).< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > length< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > integer< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2013-11-07 06:10:15 +00:00
2014-12-03 10:39:11 +00:00
< td class = "default" >
(to top)
< / td >
2013-11-07 06:10:15 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > Restriction on the number of values you want to randomly select from.< / p > < / td >
2013-11-07 06:10:15 +00:00
< / tr >
2014-11-15 20:01:46 +00:00
< / tbody >
< / table >
2013-11-07 06:10:15 +00:00
2014-11-15 20:01:46 +00:00
2013-11-07 06:10:15 +00:00
2014-11-15 20:01:46 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
2013-11-07 06:10:15 +00:00
2014-11-15 20:01:46 +00:00
< div class = "returns-type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > any< / span >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
-
< / div >
< div class = "returns-desc param-desc" >
< p > A random child of this Group.< / p >
< / div >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< / div >
< dl class = "details" >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#getRandom" > Phaser.Group#getRandom< / a >
< / li > < / dd >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1878" > line 1878< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="getTop">< span class = "type-signature" > < / span > getTop< span class = "signature" > ()< / span > < span class = "type-signature" > → {any}< / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
2013-11-07 06:10:15 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / div >
2013-11-07 06:10:15 +00:00
2014-11-15 20:01:46 +00:00
2013-11-07 06:10:15 +00:00
2014-11-15 20:01:46 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
2013-11-07 06:10:15 +00:00
2014-11-15 20:01:46 +00:00
< div class = "returns-type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > any< / span >
2013-11-07 06:10:15 +00:00
2014-11-15 20:01:46 +00:00
-
< / div >
< div class = "returns-desc param-desc" >
< p > The child at the top of the Group.< / p >
< / div >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< / div >
2014-04-10 22:13:43 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#getTop" > Phaser.Group#getTop< / a >
< / li > < / dd >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1820" > line 1820< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-04-10 22:13:43 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< / dd >
2013-11-07 06:10:15 +00:00
2014-04-10 22:13:43 +00:00
2013-11-07 06:10:15 +00:00
2014-04-10 22:13:43 +00:00
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="hasProperty">< span class = "type-signature" > < / span > hasProperty< span class = "signature" > (child, key)< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
2014-04-10 22:13:43 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Checks if the child has the given property.< / p >
< p > Will scan up to 4 levels deep only.< / p >
2014-04-10 22:13:43 +00:00
< / div >
2013-11-07 06:10:15 +00:00
2014-04-10 22:13:43 +00:00
< h5 > Parameters:< / h5 >
2013-11-07 06:10:15 +00:00
2014-04-10 22:13:43 +00:00
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
2013-11-07 06:10:15 +00:00
2014-04-10 22:13:43 +00:00
< th > Type< / th >
2013-11-07 06:10:15 +00:00
2014-04-10 22:13:43 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2013-11-07 06:10:15 +00:00
2014-04-10 22:13:43 +00:00
< tbody >
2013-11-07 06:10:15 +00:00
< tr >
2014-04-10 22:13:43 +00:00
< td class = "name" > < code > child< / code > < / td >
2013-11-07 06:10:15 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > any< / span >
2013-11-07 06:10:15 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The child to check for the existance of the property on.< / p > < / td >
2013-11-07 06:10:15 +00:00
< / tr >
2014-11-15 20:01:46 +00:00
< tr >
< td class = "name" > < code > key< / code > < / td >
2013-11-07 06:10:15 +00:00
< td class = "type" >
2015-03-23 23:46:30 +00:00
< span class = "param-type" > Array.< string>< / span >
2013-11-07 06:10:15 +00:00
< / td >
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > An array of strings that make up the property.< / p > < / td >
2013-11-07 06:10:15 +00:00
< / tr >
2014-03-14 06:36:05 +00:00
< / tbody >
< / table >
2013-11-07 06:10:15 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< 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 >
2014-03-14 06:36:05 +00:00
< dl class = "details" >
2013-11-07 06:10:15 +00:00
2014-03-14 06:36:05 +00:00
2014-02-05 06:29:17 +00:00
2014-03-14 06:36:05 +00:00
2013-11-07 06:10:15 +00:00
2014-03-14 06:36:05 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-11-15 20:01:46 +00:00
< a href = "Phaser.Group.html#hasProperty" > Phaser.Group#hasProperty< / a >
2014-03-14 06:36:05 +00:00
< / li > < / dd >
2013-11-07 06:10:15 +00:00
2014-03-14 06:36:05 +00:00
2013-11-07 06:10:15 +00:00
2014-03-14 06:36:05 +00:00
2014-02-05 06:29:17 +00:00
2014-03-14 06:36:05 +00:00
2013-11-07 06:10:15 +00:00
2014-03-14 06:36:05 +00:00
2013-11-07 06:10:15 +00:00
2014-03-14 06:36:05 +00:00
2014-02-05 06:29:17 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-826" > line 826< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-03-14 06:36:05 +00:00
2013-10-02 19:18:24 +00:00
2014-03-14 06:36:05 +00:00
2013-10-02 19:18:24 +00:00
2014-03-14 06:36:05 +00:00
2013-10-02 19:18:24 +00:00
2014-03-14 06:36:05 +00:00
< / dl >
2013-10-02 19:18:24 +00:00
2014-03-14 06:36:05 +00:00
2013-10-02 19:18:24 +00:00
2014-03-14 06:36:05 +00:00
2013-10-02 19:18:24 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
< / dd >
2013-10-02 19:18:24 +00:00
2014-03-14 06:36:05 +00:00
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
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 >
2014-03-14 06:36:05 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > 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 >
2014-03-14 06:36:05 +00:00
< / div >
2013-10-02 19:18:24 +00:00
2014-03-14 06:36:05 +00:00
< h5 > Parameters:< / h5 >
2013-10-02 19:18:24 +00:00
2014-03-14 06:36:05 +00:00
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
2014-02-05 06:29:17 +00:00
2014-03-14 06:36:05 +00:00
< th > Type< / th >
2013-10-02 19:18:24 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< th > Argument< / th >
2013-10-02 19:18:24 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< th > Default< / th >
2014-02-05 06:29:17 +00:00
2014-03-14 06:36:05 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2013-10-02 19:18:24 +00:00
2014-03-14 06:36:05 +00:00
< tbody >
2013-10-02 19:18:24 +00:00
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > key< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-04-10 22:13:43 +00:00
< span class = "param-type" > string< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "attributes" >
< / td >
2013-10-02 19:18:24 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< td class = "default" >
< / td >
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The child property to check, i.e. 'exists', 'alive', 'health'< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > value< / code > < / td >
2014-04-10 22:13:43 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > any< / span >
2014-04-10 22:13:43 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "attributes" >
< / td >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< td class = "default" >
< / td >
2014-04-10 22:13:43 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > A child matches if < code > child[key] === value< / code > is true.< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > returnType< / code > < / td >
2014-04-10 22:13:43 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > integer< / span >
2014-04-10 22:13:43 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "attributes" >
< / td >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< td class = "default" >
< / td >
2014-04-10 22:13:43 +00:00
2015-03-23 23:46:30 +00:00
< td class = "description last" > < p > How to iterate the children and what to return.< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > callback< / code > < / td >
2014-04-10 22:13:43 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > function< / span >
2014-04-10 22:13:43 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "attributes" >
< optional>< br >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< / td >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< td class = "default" >
null
< / td >
2014-12-03 10:39:11 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< / tr >
2014-11-15 20:01:46 +00:00
< tr >
< td class = "name" > < code > callbackContext< / code > < / td >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > object< / span >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< / td >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< td class = "attributes" >
< optional>< br >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< / td >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< td class = "default" >
< / td >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The context in which the function should be called (usually 'this').< / p > < / td >
< / tr >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< tr >
< td class = "name" > < code > args< / code > < / td >
< td class = "type" >
2015-03-23 23:46:30 +00:00
< span class = "param-type" > Array.< any>< / span >
2014-12-03 10:39:11 +00:00
< / 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 >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< div class = "returns-type" >
< span class = "param-type" > any< / span >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
-
< / div >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< div class = "returns-desc param-desc" >
2014-12-03 10:39:11 +00:00
< p > Returns either an integer (for RETURN_TOTAL), the first matched child (for RETURN_CHILD), or null.< / p >
2014-11-15 20:01:46 +00:00
< / div >
2014-04-10 22:13:43 +00:00
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-11-15 20:01:46 +00:00
< a href = "Phaser.Group.html#iterate" > Phaser.Group#iterate< / a >
2014-03-14 06:36:05 +00:00
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1701" > line 1701< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="kill">< span class = "type-signature" > < / span > kill< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > Call this function to turn off all the particles and the emitter.< / p >
2013-10-02 19:18:24 +00:00
< / div >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-407" > line 407< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< / dl >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< / dd >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="makeParticles">< span class = "type-signature" > < / span > makeParticles< span class = "signature" > (keys, < span class = "optional" > frames< / span > , < span class = "optional" > quantity< / span > , < span class = "optional" > collide< / span > , < span class = "optional" > collideWorldBounds< / span > )< / span > < span class = "type-signature" > → {< a href = "Phaser.Particles.Arcade.Emitter.html" > Phaser.Particles.Arcade.Emitter< / a > }< / span > < / h4 >
2014-04-10 22:13:43 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > This function generates a new set of particles for use by this emitter.
The particles are stored internally waiting to be emitted via Emitter.start.< / p >
2014-04-10 22:13:43 +00:00
< / div >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< h5 > Parameters:< / h5 >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< th > Type< / th >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< th > Argument< / th >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< th > Default< / th >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > keys< / code > < / td >
< td class = "type" >
< span class = "param-type" > array< / span >
|
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > A string or an array of strings that the particle sprites will use as their texture. If an array one is picked at random.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > frames< / code > < / td >
< td class = "type" >
< span class = "param-type" > array< / span >
|
< span class = "param-type" > number< / span >
2015-07-22 14:31:30 +00:00
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
0
< / td >
< td class = "description last" > < p > A frame number, or array of frames that the sprite will use. If an array one is picked at random.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > quantity< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > The number of particles to generate. If not given it will use the value of Emitter.maxParticles. If the value is greater than Emitter.maxParticles it will use Emitter.maxParticles as the quantity.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > collide< / 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 you want the particles to be able to collide with other Arcade Physics bodies then set this to true.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > collideWorldBounds< / 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 particle can be set to collide against the World bounds automatically and rebound back into the World if this is set to true. Otherwise it will leave the World.< / p > < / td >
< / tr >
< / tbody >
< / table >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > < a href = "Phaser.Particles.Arcade.Emitter.html" > Phaser.Particles.Arcade.Emitter< / a > < / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > This Emitter instance.< / p >
< / div >
< / div >
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2015-07-22 14:31:30 +00:00
< dt class = "tag-source" > Source -
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-335" > line 335< / a >
< / dt >
2014-11-15 20:01:46 +00:00
2015-07-22 14:31:30 +00:00
2014-11-15 20:01:46 +00:00
2015-07-22 14:31:30 +00:00
2014-11-15 20:01:46 +00:00
2015-07-22 14:31:30 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2015-07-22 14:31:30 +00:00
2014-11-15 20:01:46 +00:00
2015-07-22 14:31:30 +00:00
2014-11-15 20:01:46 +00:00
2015-07-22 14:31:30 +00:00
< / dd >
2014-11-15 20:01:46 +00:00
2015-07-22 14:31:30 +00:00
2014-11-15 20:01:46 +00:00
2015-07-22 14:31:30 +00:00
< dt >
< h4 class = "name "
id="moveAll">< span class = "type-signature" > < / span > moveAll< span class = "signature" > (group, < span class = "optional" > silent< / span > )< / span > < span class = "type-signature" > → {< a href = "Phaser.Group.html" > Phaser.Group< / a > }< / span > < / h4 >
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2015-07-22 14:31:30 +00:00
< div class = "description" >
< p > Moves all children from this Group to the Group given.< / p >
< / div >
2014-11-15 20:01:46 +00:00
2015-07-22 14:31:30 +00:00
< h5 > Parameters:< / h5 >
2014-11-15 20:01:46 +00:00
2015-07-22 14:31:30 +00:00
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
2014-11-15 20:01:46 +00:00
2015-07-22 14:31:30 +00:00
< th > Type< / th >
2014-11-15 20:01:46 +00:00
2015-07-22 14:31:30 +00:00
< th > Argument< / th >
2014-11-15 20:01:46 +00:00
2015-07-22 14:31:30 +00:00
< th > Default< / th >
2014-11-15 20:01:46 +00:00
2015-07-22 14:31:30 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2014-11-15 20:01:46 +00:00
2015-07-22 14:31:30 +00:00
< tbody >
2014-11-15 20:01:46 +00:00
< tr >
2015-07-22 14:31:30 +00:00
< td class = "name" > < code > group< / code > < / td >
2014-11-15 20:01:46 +00:00
< td class = "type" >
2015-07-22 14:31:30 +00:00
< span class = "param-type" > < a href = "Phaser.Group.html" > Phaser.Group< / a > < / span >
2014-11-15 20:01:46 +00:00
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
2015-07-22 14:31:30 +00:00
< td class = "description last" > < p > The new Group to which the children will be moved to.< / p > < / td >
2014-11-15 20:01:46 +00:00
< / tr >
< tr >
2015-07-22 14:31:30 +00:00
< td class = "name" > < code > silent< / code > < / td >
2014-11-15 20:01:46 +00:00
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
false
< / td >
2015-07-22 14:31:30 +00:00
< td class = "description last" > < p > If true the children will not dispatch the < code > onAddedToGroup< / code > event for the new Group.< / p > < / td >
2014-11-15 20:01:46 +00:00
< / tr >
< / tbody >
< / table >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
2015-07-22 14:31:30 +00:00
< span class = "param-type" > < a href = "Phaser.Group.html" > Phaser.Group< / a > < / span >
2014-11-15 20:01:46 +00:00
-
< / div >
< div class = "returns-desc param-desc" >
2015-07-22 14:31:30 +00:00
< p > The Group to which all the children were moved.< / p >
2014-11-15 20:01:46 +00:00
< / div >
< / div >
< dl class = "details" >
2015-07-22 14:31:30 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#moveAll" > Phaser.Group#moveAll< / a >
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1948" > line 1948< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="moveDown">< span class = "type-signature" > < / span > moveDown< span class = "signature" > (child)< / span > < span class = "type-signature" > → {any}< / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Moves the given child down one place in this group unless it's already at the bottom.< / p >
2014-11-15 20:01:46 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > child< / code > < / td >
2014-11-15 20:01:46 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > any< / span >
2014-11-15 20:01:46 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The child to move down in the group.< / p > < / td >
2014-11-15 20:01:46 +00:00
< / tr >
< / tbody >
< / table >
2014-12-03 10:39:11 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > any< / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The child that was moved.< / p >
< / div >
< / div >
2014-11-15 20:01:46 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "Phaser.Group.html#moveDown" > Phaser.Group#moveDown< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-718" > line 718< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="moveUp">< span class = "type-signature" > < / span > moveUp< span class = "signature" > (child)< / span > < span class = "type-signature" > → {any}< / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Moves the given child up one place in this group unless it's already at the top.< / p >
2014-11-15 20:01:46 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > child< / code > < / td >
2014-11-15 20:01:46 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > any< / span >
2014-11-15 20:01:46 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The child to move up in the group.< / p > < / td >
2014-11-15 20:01:46 +00:00
< / tr >
< / tbody >
< / table >
2014-12-03 10:39:11 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > any< / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The child that was moved.< / p >
< / div >
< / div >
2014-11-15 20:01:46 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "Phaser.Group.html#moveUp" > Phaser.Group#moveUp< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-694" > line 694< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="multiplyAll">< span class = "type-signature" > < / span > multiplyAll< span class = "signature" > (property, amount, checkAlive, checkVisible)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > 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 >
2014-11-15 20:01:46 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > property< / code > < / td >
2014-11-15 20:01:46 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > string< / span >
2014-11-15 20:01:46 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "Phaser.Group.html#multiplyAll" > Phaser.Group#multiplyAll< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1142" > line 1142< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="next">< span class = "type-signature" > < / span > next< span class = "signature" > ()< / span > < span class = "type-signature" > → {any}< / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / div >
2014-12-03 10:39:11 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< div class = "returns-type" >
< span class = "param-type" > any< / span >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
-
< / div >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< div class = "returns-desc param-desc" >
< p > The child the cursor now points to.< / p >
< / div >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< / div >
2014-11-15 20:01:46 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "Phaser.Group.html#next" > Phaser.Group#next< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-582" > line 582< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="postUpdate">< span class = "type-signature" > < internal> < / span > postUpdate< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > The core postUpdate - as called by World.< / p >
2014-11-15 20:01:46 +00:00
< / div >
2014-12-03 10:39:11 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#postUpdate" > Phaser.Group#postUpdate< / a >
< / li > < / dd >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< dt class = "important tag-deprecated" > Internal:< / dt >
< dd class = "tag-deprecated" > < ul >
< li > This member is < em > internal (protected)< / em > and may be modified or removed in the future.< / li >
< / ul > < / dd >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1382" > line 1382< / a >
2014-12-03 10:39:11 +00:00
< / dt >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< / dl >
< / 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 >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "Phaser.Group.html#preUpdate" > Phaser.Group#preUpdate< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
2014-12-03 10:39:11 +00:00
< dt class = "important tag-deprecated" > Internal:< / dt >
< dd class = "tag-deprecated" > < ul >
< li > This member is < em > internal (protected)< / em > and may be modified or removed in the future.< / li >
< / ul > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1336" > line 1336< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="previous">< span class = "type-signature" > < / span > previous< span class = "signature" > ()< / span > < span class = "type-signature" > → {any}< / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / div >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > any< / span >
2014-11-15 20:01:46 +00:00
-
< / div >
< div class = "returns-desc param-desc" >
2014-12-03 10:39:11 +00:00
< p > The child the cursor now points to.< / p >
2014-11-15 20:01:46 +00:00
< / div >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "Phaser.Group.html#previous" > Phaser.Group#previous< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-611" > line 611< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="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 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-12-03 10:39:11 +00:00
< th > Argument< / th >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< th > Default< / th >
2014-11-15 20:01:46 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > child< / code > < / td >
< td class = "type" >
2014-12-03 10:39:11 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< td class = "default" >
false
< / td >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > If true the the child will not dispatch the < code > onRemovedFromGroup< / code > event.< / p > < / td >
2014-11-15 20:01:46 +00:00
< / tr >
< / tbody >
< / table >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > boolean< / span >
2014-11-15 20:01:46 +00:00
-
< / div >
< div class = "returns-desc param-desc" >
2014-12-03 10:39:11 +00:00
< p > true if the child was removed from this group, otherwise false.< / p >
2014-11-15 20:01:46 +00:00
< / div >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "Phaser.Group.html#remove" > Phaser.Group#remove< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1900" > line 1900< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="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 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Removes all children from this group, but does not remove the group from its parent.< / p >
2014-11-15 20:01:46 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-12-03 10:39:11 +00:00
< th > Argument< / th >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< th > Default< / th >
2014-11-15 20:01:46 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > destroy< / code > < / td >
2014-11-15 20:01:46 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > boolean< / span >
2014-11-15 20:01:46 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< td class = "default" >
false
< / td >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > If true < code > destroy< / code > will be invoked on each removed child.< / p > < / td >
2014-11-15 20:01:46 +00:00
< / tr >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > silent< / code > < / td >
2014-11-15 20:01:46 +00:00
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< optional>< br >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< / td >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< td class = "default" >
false
< / td >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > If true the children will not dispatch their < code > onRemovedFromGroup< / code > events.< / p > < / td >
2014-11-15 20:01:46 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "Phaser.Group.html#removeAll" > Phaser.Group#removeAll< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1977" > line 1977< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="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 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Removes all children from this group whose index falls beteen the given startIndex and endIndex values.< / p >
2014-11-15 20:01:46 +00:00
< / div >
2014-12-03 10:39:11 +00:00
< h5 > Parameters:< / h5 >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< td class = "type" >
< span class = "param-type" > integer< / span >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< / 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 >
2014-11-15 20:01:46 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "Phaser.Group.html#removeBetween" > Phaser.Group#removeBetween< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-2018" > line 2018< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="removeChild">< span class = "type-signature" > < / span > removeChild< span class = "signature" > (child)< / span > < span class = "type-signature" > → {< a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > }< / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Removes a child from the container.< / p >
2014-11-15 20:01:46 +00:00
< / div >
2014-12-03 10:39:11 +00:00
< h5 > Parameters:< / h5 >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< th > Type< / th >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< tbody >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< tr >
< td class = "name" > < code > child< / code > < / td >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< td class = "type" >
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< / td >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The DisplayObject to remove< / p > < / td >
< / tr >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< div class = "returns-type" >
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
-
< / div >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< div class = "returns-desc param-desc" >
< p > The child that was removed.< / p >
2014-11-15 20:01:46 +00:00
< / div >
2014-12-03 10:39:11 +00:00
< / div >
2014-11-15 20:01:46 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "PIXI.DisplayObjectContainer.html#removeChild" > PIXI.DisplayObjectContainer#removeChild< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_pixi_display_DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-211" > line 211< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="removeChildAt">< span class = "type-signature" > < / span > removeChildAt< span class = "signature" > (index)< / span > < span class = "type-signature" > → {< a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > }< / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Removes a child from the specified index position.< / p >
2014-11-15 20:01:46 +00:00
< / div >
2014-12-03 10:39:11 +00:00
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< 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 >
2014-11-15 20:01:46 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
2014-11-15 20:01:46 +00:00
-
< / div >
< div class = "returns-desc param-desc" >
2014-12-03 10:39:11 +00:00
< p > The child that was removed.< / p >
2014-11-15 20:01:46 +00:00
< / div >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "PIXI.DisplayObjectContainer.html#removeChildAt" > PIXI.DisplayObjectContainer#removeChildAt< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_pixi_display_DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-226" > line 226< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="removeChildren">< span class = "type-signature" > < / span > removeChildren< span class = "signature" > (beginIndex, endIndex)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Removes all children from this container that are within the begin and end indexes.< / p >
2014-11-15 20:01:46 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > beginIndex< / code > < / td >
2014-11-15 20:01:46 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > Number< / span >
2014-11-15 20:01:46 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The beginning position. Default value is 0.< / p > < / td >
2014-11-15 20:01:46 +00:00
< / tr >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > endIndex< / code > < / td >
2014-11-15 20:01:46 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > Number< / span >
2014-11-15 20:01:46 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The ending position. Default value is size of the container.< / p > < / td >
2014-11-15 20:01:46 +00:00
< / tr >
2014-12-03 10:39:11 +00:00
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObjectContainer.html#removeChildren" > PIXI.DisplayObjectContainer#removeChildren< / a >
< / li > < / dd >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_pixi_display_DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-244" > line 244< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="removeFromHash">< span class = "type-signature" > < / span > removeFromHash< span class = "signature" > (child)< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Removes a child of this Group from the hash array.
This call will return false if the child is not in the hash.< / 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 = "global.html#DisplayObject" > DisplayObject< / a > < / span >
< / td >
< td class = "description last" > < p > The display object to remove from this Groups hash. Must be a member of this Group and in the hash.< / 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 successfully removed from the hash, otherwise false.< / p >
< / div >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#removeFromHash" > Phaser.Group#removeFromHash< / a >
< / li > < / 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-344" > line 344< / a >
2014-12-03 10:39:11 +00:00
< / dt >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< / dl >
< / dd >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< dt >
< h4 class = "name "
id="removeStageReference">< span class = "type-signature" > < / span > removeStageReference< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< div class = "description" >
< p > Removes the current stage reference from the container and all of its children.< / p >
2014-11-15 20:01:46 +00:00
< / div >
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "PIXI.DisplayObjectContainer.html#removeStageReference" > PIXI.DisplayObjectContainer#removeStageReference< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_pixi_display_DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-407" > line 407< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="replace">< span class = "type-signature" > < / span > replace< span class = "signature" > (oldChild, newChild)< / span > < span class = "type-signature" > → {any}< / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Replaces a child of this group with the given newChild. The newChild cannot be a member of this group.< / p >
2014-11-15 20:01:46 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > oldChild< / code > < / td >
2014-11-15 20:01:46 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > any< / span >
2014-11-15 20:01:46 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The child in this group that will be replaced.< / p > < / td >
2014-11-15 20:01:46 +00:00
< / tr >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > newChild< / code > < / td >
2014-11-15 20:01:46 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > any< / span >
2014-11-15 20:01:46 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The child to be inserted into this group.< / p > < / td >
2014-11-15 20:01:46 +00:00
< / tr >
< / tbody >
< / table >
2014-12-03 10:39:11 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > any< / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > Returns the oldChild that was replaced within this group.< / p >
< / div >
< / div >
2014-11-15 20:01:46 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "Phaser.Group.html#replace" > Phaser.Group#replace< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-791" > line 791< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="resetCursor">< span class = "type-signature" > < / span > resetCursor< span class = "signature" > (< span class = "optional" > index< / span > )< / span > < span class = "type-signature" > → {any}< / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > index< / code > < / td >
2014-11-15 20:01:46 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > integer< / span >
2014-11-15 20:01:46 +00:00
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
2014-12-03 10:39:11 +00:00
0
2014-11-15 20:01:46 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > Set the cursor to point to a specific index.< / p > < / td >
2014-11-15 20:01:46 +00:00
< / tr >
2014-12-03 10:39:11 +00:00
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< div class = "returns-type" >
< span class = "param-type" > any< / span >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
-
< / div >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< div class = "returns-desc param-desc" >
< p > The child the cursor now points to.< / p >
< / div >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< / div >
2014-11-15 20:01:46 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "Phaser.Group.html#resetCursor" > Phaser.Group#resetCursor< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-555" > line 555< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="reverse">< span class = "type-signature" > < / span > reverse< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Reverses all children in this group.< / p >
< p > This operaation applies only to immediate children and does not propagate to subgroups.< / p >
2014-11-15 20:01:46 +00:00
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "Phaser.Group.html#reverse" > Phaser.Group#reverse< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-764" > line 764< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="revive">< span class = "type-signature" > < / span > revive< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Handy for bringing game objects " back to life" . Just sets alive and exists back to true.< / p >
2014-11-15 20:01:46 +00:00
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-420" > line 420< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="sendToBack">< span class = "type-signature" > < / span > sendToBack< span class = "signature" > (child)< / span > < span class = "type-signature" > → {any}< / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Sends the given child to the bottom of this group so it renders below all other children.< / p >
2014-11-15 20:01:46 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > child< / code > < / td >
2014-11-15 20:01:46 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > any< / span >
2014-11-15 20:01:46 +00:00
< / td >
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2013-11-01 18:16:52 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The child to send to the bottom of this group.< / p > < / td >
2014-11-15 20:01:46 +00:00
< / tr >
2013-11-01 18:16:52 +00:00
2014-11-15 20:01:46 +00:00
< / tbody >
< / table >
2013-11-01 18:16:52 +00:00
2014-11-15 20:01:46 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
2013-11-01 18:16:52 +00:00
2014-11-15 20:01:46 +00:00
< div class = "returns-type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > any< / span >
2014-11-15 20:01:46 +00:00
-
< / div >
2013-11-01 18:16:52 +00:00
2014-11-15 20:01:46 +00:00
< div class = "returns-desc param-desc" >
2014-12-03 10:39:11 +00:00
< p > The child that was moved.< / p >
2013-11-01 18:16:52 +00:00
< / div >
2014-11-15 20:01:46 +00:00
< / div >
2013-11-01 18:16:52 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "Phaser.Group.html#sendToBack" > Phaser.Group#sendToBack< / a >
2013-11-01 18:16:52 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-675" > line 675< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-02-18 03:01:51 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-02-18 03:01:51 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
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 >
2014-02-18 03:01:51 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-02-18 03:01:51 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Quickly set a property on a single child of this group to a new value.< / p >
2014-11-15 20:01:46 +00:00
< p > The operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.< / p >
2014-02-18 03:01:51 +00:00
< / div >
2014-04-10 22:13:43 +00:00
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-04-11 12:09:28 +00:00
< th > Argument< / th >
2014-04-10 22:13:43 +00:00
2014-04-11 12:09:28 +00:00
< th > Default< / th >
2014-04-10 22:13:43 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
2014-12-03 10:39:11 +00:00
< 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 >
2014-04-10 22:13:43 +00:00
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > key< / code > < / td >
2014-04-10 22:13:43 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > string< / span >
2014-04-10 22:13:43 +00:00
< / td >
2014-04-11 12:09:28 +00:00
< td class = "attributes" >
2014-04-10 22:13:43 +00:00
2014-04-11 12:09:28 +00:00
< / td >
< td class = "default" >
< / td >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The property, as a string, to be set. For example: 'body.velocity.x'< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
2014-04-11 12:09:28 +00:00
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > value< / code > < / td >
2014-04-11 12:09:28 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > any< / span >
2014-04-11 12:09:28 +00:00
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The value that will be set.< / p > < / td >
2014-04-11 12:09:28 +00:00
< / tr >
2014-07-10 19:31:11 +00:00
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > checkAlive< / code > < / td >
2014-07-10 19:31:11 +00:00
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
false
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > If set then the child will only be updated if alive=true.< / p > < / td >
2014-07-10 19:31:11 +00:00
< / tr >
2014-02-18 03:01:51 +00:00
2014-11-15 20:01:46 +00:00
< tr >
< td class = "name" > < code > checkVisible< / code > < / td >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< td class = "type" >
2014-04-10 22:13:43 +00:00
< span class = "param-type" > boolean< / span >
2014-02-18 03:01:51 +00:00
2014-11-15 20:01:46 +00:00
< / td >
2014-04-11 12:09:28 +00:00
2014-11-15 20:01:46 +00:00
< td class = "attributes" >
< optional>< br >
2014-04-11 12:09:28 +00:00
2014-11-15 20:01:46 +00:00
2014-04-11 12:09:28 +00:00
2014-11-15 20:01:46 +00:00
< / td >
2014-04-11 12:09:28 +00:00
2014-11-15 20:01:46 +00:00
< td class = "default" >
false
< / td >
2014-04-11 12:09:28 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > If set then the child will only be updated if visible=true.< / p > < / td >
2014-11-15 20:01:46 +00:00
< / tr >
2014-04-11 12:09:28 +00:00
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > operation< / code > < / td >
2014-04-11 12:09:28 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > integer< / span >
2014-04-11 12:09:28 +00:00
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
2014-11-15 20:01:46 +00:00
0
2014-04-11 12:09:28 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< 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 >
2014-07-10 19:31:11 +00:00
< / tr >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > force< / code > < / td >
2014-07-10 19:31:11 +00:00
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
false
< / td >
2014-11-15 20:01:46 +00:00
< 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 >
2014-04-11 12:09:28 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< 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 >
2014-02-18 03:01:51 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "Phaser.Group.html#set" > Phaser.Group#set< / a >
2014-02-18 03:01:51 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-968" > line 968< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-11-01 18:16:52 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-11-01 18:16:52 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
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 >
2013-11-01 18:16:52 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-11-01 18:16:52 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< p > The operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.< / p >
2013-11-01 18:16:52 +00:00
< / div >
2014-04-10 22:13:43 +00:00
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
2014-04-11 12:09:28 +00:00
< th > Default< / th >
2014-04-10 22:13:43 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > key< / code > < / td >
2014-04-10 22:13:43 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > string< / span >
2014-04-10 22:13:43 +00:00
< / td >
< td class = "attributes" >
< / td >
2014-04-11 12:09:28 +00:00
< td class = "default" >
< / td >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The property, as a string, to be set. For example: 'body.velocity.x'< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > value< / code > < / td >
2014-04-10 22:13:43 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > any< / span >
2014-11-15 20:01:46 +00:00
< / 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 >
2014-04-10 22:13:43 +00:00
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2014-04-11 12:09:28 +00:00
< td class = "default" >
2014-11-15 20:01:46 +00:00
false
2014-04-11 12:09:28 +00:00
< / td >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< 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 >
2014-04-10 22:13:43 +00:00
< / tr >
2014-04-11 12:09:28 +00:00
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > checkVisible< / code > < / td >
2014-04-11 12:09:28 +00:00
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
false
< / td >
2014-11-15 20:01:46 +00:00
< 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 >
2014-04-11 12:09:28 +00:00
< / tr >
2014-07-10 19:31:11 +00:00
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > operation< / code > < / td >
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > integer< / span >
2014-11-15 20:01:46 +00:00
< / 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 >
2014-07-10 19:31:11 +00:00
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
false
< / td >
2014-11-15 20:01:46 +00:00
< 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 >
2014-07-10 19:31:11 +00:00
< / tr >
2014-04-10 22:13:43 +00:00
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2013-11-01 18:16:52 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "Phaser.Group.html#setAll" > Phaser.Group#setAll< / a >
2013-11-01 18:16:52 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-999" > line 999< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
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 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-11-15 20:01:46 +00:00
< th > Argument< / th >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< th > Default< / th >
2013-10-02 19:18:24 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > key< / code > < / td >
2014-04-10 22:13:43 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > string< / span >
2014-04-10 22:13:43 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "attributes" >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / td >
2013-11-28 15:57:09 +00:00
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
< td class = "default" >
< / td >
2014-04-29 14:39:02 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The property, as a string, to be set. For example: 'body.velocity.x'< / p > < / td >
2014-11-15 20:01:46 +00:00
< / tr >
2014-04-29 14:39:02 +00:00
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > value< / code > < / td >
2014-04-29 14:39:02 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > any< / span >
2014-04-29 14:39:02 +00:00
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The value that will be set.< / p > < / td >
2014-04-29 14:39:02 +00:00
< / tr >
2014-11-15 20:01:46 +00:00
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > checkAlive< / code > < / td >
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > boolean< / span >
2014-04-29 14:39:02 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< td class = "attributes" >
< optional>< br >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< td class = "default" >
2014-12-03 10:39:11 +00:00
false
2014-11-15 20:01:46 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / tr >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > checkVisible< / code > < / td >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< td class = "type" >
< span class = "param-type" > boolean< / span >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< td class = "attributes" >
< optional>< br >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< td class = "default" >
false
< / td >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / tr >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > operation< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > integer< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< optional>< br >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< / tr >
2014-11-15 20:01:46 +00:00
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > force< / code > < / td >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > boolean< / span >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< td class = "default" >
false
< / td >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< 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 >
2014-11-15 20:01:46 +00:00
< / tr >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / tbody >
< / table >
2013-10-02 19:18:24 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "Phaser.Group.html#setAllChildren" > Phaser.Group#setAllChildren< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1034" > line 1034< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="setAlpha">< span class = "type-signature" > < / span > setAlpha< span class = "signature" > (< span class = "optional" > min< / span > , < span class = "optional" > max< / span > , < span class = "optional" > rate< / span > , < span class = "optional" > ease< / span > , < span class = "optional" > yoyo< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2014-03-14 06:36:05 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > A more compact way of setting the alpha constraints of the particles.
The rate parameter, if set to a value above zero, lets you set the speed at which the Particle change in alpha from min to max.
If rate is zero, which is the default, the particle won't change alpha - instead it will pick a random alpha between min and max on emit.< / p >
2014-03-14 06:36:05 +00:00
< / div >
2014-04-10 22:13:43 +00:00
< h5 > Parameters:< / h5 >
2014-03-14 06:36:05 +00:00
2014-04-10 22:13:43 +00:00
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
2014-03-14 06:36:05 +00:00
2014-04-10 22:13:43 +00:00
< th > Type< / th >
2014-03-14 06:36:05 +00:00
2014-04-10 22:13:43 +00:00
< th > Argument< / th >
2014-03-14 06:36:05 +00:00
2014-04-10 22:13:43 +00:00
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > min< / code > < / td >
2014-04-10 22:13:43 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > number< / span >
2014-04-10 22:13:43 +00:00
< / td >
< td class = "attributes" >
2014-12-03 10:39:11 +00:00
< optional>< br >
2014-04-10 22:13:43 +00:00
< / td >
< td class = "default" >
2014-12-03 10:39:11 +00:00
1
2014-04-10 22:13:43 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The minimum value for this range.< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > max< / code > < / td >
2014-04-10 22:13:43 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > number< / span >
2014-04-10 22:13:43 +00:00
< / td >
< td class = "attributes" >
2014-12-03 10:39:11 +00:00
< optional>< br >
2014-04-10 22:13:43 +00:00
< / td >
< td class = "default" >
2014-12-03 10:39:11 +00:00
1
2014-04-10 22:13:43 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The maximum value for this range.< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > rate< / code > < / td >
2014-04-10 22:13:43 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > number< / span >
2014-04-10 22:13:43 +00:00
< / td >
< td class = "attributes" >
2014-12-03 10:39:11 +00:00
< optional>< br >
2014-04-10 22:13:43 +00:00
< / td >
< td class = "default" >
2014-12-03 10:39:11 +00:00
0
2014-04-10 22:13:43 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The rate (in ms) at which the particles will change in alpha from min to max, or set to zero to pick a random alpha between the two.< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > ease< / code > < / td >
2014-04-10 22:13:43 +00:00
< td class = "type" >
2015-03-23 23:46:30 +00:00
< span class = "param-type" > function< / span >
2014-04-10 22:13:43 +00:00
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
2014-12-03 10:39:11 +00:00
Phaser.Easing.Linear.None
2014-04-10 22:13:43 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > If you've set a rate > 0 this is the easing formula applied between the min and max values.< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > yoyo< / code > < / td >
2014-04-10 22:13:43 +00:00
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
false
< / td >
2014-03-14 06:36:05 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > If you've set a rate > 0 you can set if the ease will yoyo or not (i.e. ease back to its original values)< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
2014-03-14 06:36:05 +00:00
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source -
2015-03-26 02:38:46 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-704" > line 704< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="setChildIndex">< span class = "type-signature" > < / span > setChildIndex< span class = "signature" > (child, index)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Changes the position of an existing child in the display object container< / p >
2014-11-15 20:01:46 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
2014-03-14 06:36:05 +00:00
2014-04-10 22:13:43 +00:00
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > child< / code > < / td >
2014-04-10 22:13:43 +00:00
2014-03-14 06:36:05 +00:00
2014-04-10 22:13:43 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
2014-03-14 06:36:05 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The child DisplayObject instance for which you want to change the index number< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2014-05-20 09:12:48 +00:00
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > index< / code > < / td >
2014-05-20 09:12:48 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > Number< / span >
2014-05-20 09:12:48 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The resulting index number for the child display object< / p > < / td >
2014-05-20 09:12:48 +00:00
< / tr >
2014-04-10 22:13:43 +00:00
< / tbody >
< / table >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-02-05 06:29:17 +00:00
< dl class = "details" >
2014-12-03 10:39:11 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObjectContainer.html#setChildIndex" > PIXI.DisplayObjectContainer#setChildIndex< / a >
< / li > < / dd >
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_pixi_display_DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-176" > line 176< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-03-14 06:36:05 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="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 >
2014-03-14 06:36:05 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Sets a property to the given value on the child. The operation parameter controls how the value is set.< / p >
2015-03-23 23:46:30 +00:00
< 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 >
2014-03-14 06:36:05 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-12-03 10:39:11 +00:00
< th > Argument< / th >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< th > Default< / th >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< tbody >
2014-11-15 20:01:46 +00:00
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > child< / code > < / td >
2014-11-15 20:01:46 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > any< / span >
2014-03-14 06:36:05 +00:00
< / td >
2014-04-10 22:13:43 +00:00
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The child to set the property value on.< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > key< / code > < / td >
2014-04-10 22:13:43 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > array< / span >
2014-04-10 22:13:43 +00:00
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > An array of strings that make up the property that will be set.< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > value< / code > < / td >
2014-04-10 22:13:43 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > any< / span >
2014-04-10 22:13:43 +00:00
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The value that will be set.< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > operation< / code > < / td >
2014-04-10 22:13:43 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > integer< / span >
2014-04-10 22:13:43 +00:00
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2014-03-14 06:36:05 +00:00
2014-04-10 22:13:43 +00:00
< td class = "default" >
2014-12-03 10:39:11 +00:00
0
2014-04-10 22:13:43 +00:00
< / td >
2014-03-14 06:36:05 +00:00
2014-12-03 10:39:11 +00:00
< 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 >
2014-03-14 06:36:05 +00:00
< / tr >
2014-05-20 09:12:48 +00:00
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > force< / code > < / td >
2014-05-20 09:12:48 +00:00
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
false
< / td >
2014-12-03 10:39:11 +00:00
< 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 >
2014-05-20 09:12:48 +00:00
< / tr >
2014-03-14 06:36:05 +00:00
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< 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 >
2014-03-14 06:36:05 +00:00
< dl class = "details" >
2014-12-03 10:39:11 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#setProperty" > Phaser.Group#setProperty< / a >
< / li > < / dd >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-861" > line 861< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-02-05 06:29:17 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="setRotation">< span class = "type-signature" > < / span > setRotation< span class = "signature" > (< span class = "optional" > min< / span > , < span class = "optional" > max< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2014-02-05 06:29:17 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > A more compact way of setting the angular velocity constraints of the particles.< / p >
2014-02-05 06:29:17 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-12-03 10:39:11 +00:00
< th > Argument< / th >
2014-02-05 06:29:17 +00:00
2014-12-03 10:39:11 +00:00
< th > Default< / th >
2014-02-05 06:29:17 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > min< / code > < / td >
2014-02-05 06:29:17 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > number< / span >
2014-02-05 06:29:17 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< optional>< br >
2014-02-05 06:29:17 +00:00
2014-12-03 10:39:11 +00:00
< / td >
2014-02-05 06:29:17 +00:00
2014-12-03 10:39:11 +00:00
< td class = "default" >
0
< / td >
< td class = "description last" > < p > The minimum value for this range.< / p > < / td >
2014-02-05 06:29:17 +00:00
< / tr >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > max< / code > < / td >
2014-02-05 06:29:17 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > number< / span >
2014-02-05 06:29:17 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< optional>< br >
2014-02-05 06:29:17 +00:00
2014-12-03 10:39:11 +00:00
< / td >
2014-02-05 06:29:17 +00:00
2014-12-03 10:39:11 +00:00
< td class = "default" >
0
< / td >
< td class = "description last" > < p > The maximum value for this range.< / p > < / td >
2014-02-05 06:29:17 +00:00
< / tr >
2014-11-15 20:01:46 +00:00
< / tbody >
< / table >
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-26 02:38:46 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-687" > line 687< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="setScale">< span class = "type-signature" > < / span > setScale< span class = "signature" > (< span class = "optional" > minX< / span > , < span class = "optional" > maxX< / span > , < span class = "optional" > minY< / span > , < span class = "optional" > maxY< / span > , < span class = "optional" > rate< / span > , < span class = "optional" > ease< / span > , < span class = "optional" > yoyo< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > A more compact way of setting the scale constraints of the particles.
The rate parameter, if set to a value above zero, lets you set the speed and ease which the Particle uses to change in scale from min to max across both axis.
If rate is zero, which is the default, the particle won't change scale during update, instead it will pick a random scale between min and max on emit.< / p >
2014-11-15 20:01:46 +00:00
< / div >
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< h5 > Parameters:< / h5 >
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< th > Type< / th >
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< th > Argument< / th >
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< th > Default< / th >
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< tbody >
2014-02-05 06:29:17 +00:00
2014-05-20 09:12:48 +00:00
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > minX< / code > < / td >
2014-05-20 09:12:48 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > number< / span >
2014-05-20 09:12:48 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2014-11-15 20:01:46 +00:00
2014-05-20 09:12:48 +00:00
2014-12-03 10:39:11 +00:00
< td class = "default" >
1
< / td >
2014-05-20 09:12:48 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The minimum value of Particle.scale.x.< / p > < / td >
2014-05-20 09:12:48 +00:00
< / tr >
2014-02-05 06:29:17 +00:00
2014-12-03 10:39:11 +00:00
< tr >
< td class = "name" > < code > maxX< / code > < / td >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
1
< / td >
< td class = "description last" > < p > The maximum value of Particle.scale.x.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > minY< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
1
< / td >
< td class = "description last" > < p > The minimum value of Particle.scale.y.< / p > < / td >
< / tr >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< tr >
< td class = "name" > < code > maxY< / code > < / td >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< optional>< br >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< td class = "default" >
1
< / td >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The maximum value of Particle.scale.y.< / p > < / td >
< / tr >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< tr >
< td class = "name" > < code > rate< / code > < / td >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< td class = "type" >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< span class = "param-type" > number< / span >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< optional>< br >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< td class = "default" >
0
< / td >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The rate (in ms) at which the particles will change in scale from min to max, or set to zero to pick a random size between the two.< / p > < / td >
< / tr >
2013-10-02 19:18:24 +00:00
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > ease< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2015-03-23 23:46:30 +00:00
< span class = "param-type" > function< / span >
2013-10-02 19:18:24 +00:00
< / td >
< td class = "attributes" >
2014-04-10 22:13:43 +00:00
< optional>< br >
2013-10-02 19:18:24 +00:00
< / td >
< td class = "default" >
2014-12-03 10:39:11 +00:00
Phaser.Easing.Linear.None
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > If you've set a rate > 0 this is the easing formula applied between the min and max values.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > yoyo< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > boolean< / span >
2013-10-02 19:18:24 +00:00
< / td >
< td class = "attributes" >
2014-04-10 22:13:43 +00:00
< optional>< br >
2013-10-02 19:18:24 +00:00
< / td >
< td class = "default" >
2014-12-03 10:39:11 +00:00
false
2013-10-02 19:18:24 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > If you've set a rate > 0 you can set if the ease will yoyo or not (i.e. ease back to its original values)< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-26 02:38:46 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-743" > line 743< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-03-24 12:41:45 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="setSize">< span class = "type-signature" > < / span > setSize< span class = "signature" > (width, height)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-03-24 12:41:45 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > A more compact way of setting the width and height of the emitter.< / p >
2014-03-24 12:41:45 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-11-15 20:01:46 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< tbody >
2014-04-10 22:13:43 +00:00
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > width< / code > < / td >
2014-04-10 22:13:43 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The desired width of the emitter (particles are spawned randomly within these dimensions).< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
2014-05-20 09:12:48 +00:00
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > height< / code > < / td >
2014-05-20 09:12:48 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > number< / span >
2014-05-20 09:12:48 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The desired height of the emitter.< / p > < / td >
2014-05-20 09:12:48 +00:00
< / tr >
2014-04-10 22:13:43 +00:00
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-26 02:38:46 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-641" > line 641< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-04-10 22:13:43 +00:00
2014-03-24 12:41:45 +00:00
2014-04-10 22:13:43 +00:00
2014-03-24 12:41:45 +00:00
2014-04-10 22:13:43 +00:00
< / dl >
2014-03-24 12:41:45 +00:00
2014-04-10 22:13:43 +00:00
2014-03-24 12:41:45 +00:00
2014-04-10 22:13:43 +00:00
2014-03-24 12:41:45 +00:00
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< / dd >
2014-03-24 12:41:45 +00:00
2014-04-10 22:13:43 +00:00
2014-03-24 12:41:45 +00:00
2014-04-10 22:13:43 +00:00
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="setStageReference">< span class = "type-signature" > < / span > setStageReference< span class = "signature" > (stage)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-04-10 22:13:43 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-04-10 22:13:43 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.< / p >
2014-04-10 22:13:43 +00:00
< / div >
2014-03-24 12:41:45 +00:00
2014-04-10 22:13:43 +00:00
< h5 > Parameters:< / h5 >
2014-03-24 12:41:45 +00:00
2014-04-10 22:13:43 +00:00
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
2014-03-24 12:41:45 +00:00
2014-04-10 22:13:43 +00:00
< th > Type< / th >
2014-03-24 12:41:45 +00:00
2014-04-10 22:13:43 +00:00
2014-03-24 12:41:45 +00:00
2014-04-10 22:13:43 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2014-03-24 12:41:45 +00:00
2014-04-10 22:13:43 +00:00
< tbody >
2014-03-24 12:41:45 +00:00
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > stage< / code > < / td >
2014-03-24 12:41:45 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > < a href = "PIXI.Stage.html" > PIXI.Stage< / a > < / span >
2014-03-24 12:41:45 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > the stage that the container will have as its current stage reference< / p > < / td >
2014-03-24 12:41:45 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "PIXI.DisplayObjectContainer.html#setStageReference" > PIXI.DisplayObjectContainer#setStageReference< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_pixi_display_DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-391" > line 391< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="setXSpeed">< span class = "type-signature" > < / span > setXSpeed< span class = "signature" > (< span class = "optional" > min< / span > , < span class = "optional" > max< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > A more compact way of setting the X velocity range of the emitter.< / p >
2013-10-02 19:18:24 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > min< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-04-10 22:13:43 +00:00
< span class = "param-type" > number< / span >
2013-10-02 19:18:24 +00:00
< / td >
< td class = "attributes" >
2014-04-10 22:13:43 +00:00
< optional>< br >
2013-10-02 19:18:24 +00:00
< / td >
< td class = "default" >
2014-11-15 20:01:46 +00:00
0
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The minimum value for this range.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > max< / code > < / td >
2014-11-15 20:01:46 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
0
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The maximum value for this range.< / p > < / td >
2014-11-15 20:01:46 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source -
2015-03-26 02:38:46 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-655" > line 655< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="setYSpeed">< span class = "type-signature" > < / span > setYSpeed< span class = "signature" > (< span class = "optional" > min< / span > , < span class = "optional" > max< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > A more compact way of setting the Y velocity range of the emitter.< / p >
2014-11-15 20:01:46 +00:00
< / div >
< h5 > Parameters:< / h5 >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< th > Type< / th >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< th > Argument< / th >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< th > Default< / th >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< tbody >
2013-10-02 19:18:24 +00:00
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > min< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > number< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< optional>< br >
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
2014-12-03 10:39:11 +00:00
< td class = "default" >
0
< / td >
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The minimum value for this range.< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
2013-10-02 19:18:24 +00:00
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > max< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > number< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< optional>< br >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< td class = "default" >
0
< / td >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The maximum value for this range.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-26 02:38:46 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-671" > line 671< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
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 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-12-03 10:39:11 +00:00
< th > Argument< / th >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< th > Default< / th >
2013-10-02 19:18:24 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > key< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > string< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< td class = "default" >
'z'
< / td >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The name of the property to sort on. Defaults to the objects z-depth value.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > order< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > integer< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< td class = "default" >
Phaser.Group.SORT_ASCENDING
< / td >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "Phaser.Group.html#sort" > Phaser.Group#sort< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1584" > line 1584< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="start">< span class = "type-signature" > < / span > start< span class = "signature" > (< span class = "optional" > explode< / span > , < span class = "optional" > lifespan< / span > , < span class = "optional" > frequency< / span > , < span class = "optional" > quantity< / span > , < span class = "optional" > forceQuantity< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Call this function to start emitting particles.< / p >
2013-10-02 19:18:24 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-12-03 10:39:11 +00:00
< th > Argument< / th >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< th > Default< / th >
2013-10-02 19:18:24 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > explode< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > boolean< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< optional>< br >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< td class = "default" >
true
< / td >
< td class = "description last" > < p > Whether the particles should all burst out at once (true) or at the frequency given (false).< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > lifespan< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > number< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< optional>< br >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< td class = "default" >
0
< / td >
< td class = "description last" > < p > How long each particle lives once emitted in ms. 0 = forever.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > frequency< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
250
< / td >
< td class = "description last" > < p > Ignored if Explode is set to true. Frequency is how often to emit 1 particle. Value given in ms.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > quantity< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
0
< / td >
2015-01-06 06:57:25 +00:00
< td class = "description last" > < p > How many particles to launch. 0 = " all of the particles" which will keep emitting until Emitter.maxParticles is reached.< / p > < / td >
2014-12-03 10:39:11 +00:00
< / tr >
< tr >
< td class = "name" > < code > forceQuantity< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
false
< / td >
2015-01-06 06:57:25 +00:00
< td class = "description last" > < p > If < code > true< / code > and creating a particle flow, the quantity emitted will be forced to the be quantity given in this call. This can never exceed Emitter.maxParticles.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-491" > line 491< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="subAll">< span class = "type-signature" > < / span > subAll< span class = "signature" > (property, amount, checkAlive, checkVisible)< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< tbody >
2013-10-02 19:18:24 +00:00
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > property< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > string< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The property to decrement, for example 'body.velocity.x' or 'angle'.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
2014-12-03 10:39:11 +00:00
< tr >
< td class = "name" > < code > amount< / code > < / td >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< 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 >
2013-11-07 06:10:15 +00:00
2014-12-03 10:39:11 +00:00
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< tr >
< td class = "name" > < code > checkAlive< / code > < / td >
2013-11-07 06:10:15 +00:00
2014-12-03 10:39:11 +00:00
< td class = "type" >
< span class = "param-type" > boolean< / span >
2013-11-07 06:10:15 +00:00
2014-12-03 10:39:11 +00:00
< / td >
2013-11-07 06:10:15 +00:00
2014-12-03 10:39:11 +00:00
2013-11-07 06:10:15 +00:00
2014-12-03 10:39:11 +00:00
2013-11-07 06:10:15 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > If true the property will only be changed if the child is alive.< / p > < / td >
< / tr >
2013-11-07 06:10:15 +00:00
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > checkVisible< / code > < / td >
2013-11-07 06:10:15 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > boolean< / span >
2013-11-07 06:10:15 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > If true the property will only be changed if the child is visible.< / p > < / td >
2013-11-07 06:10:15 +00:00
< / tr >
2014-11-15 20:01:46 +00:00
< / tbody >
< / table >
2013-11-07 06:10:15 +00:00
2014-11-15 20:01:46 +00:00
2013-11-07 06:10:15 +00:00
2014-11-15 20:01:46 +00:00
2013-11-07 06:10:15 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "Phaser.Group.html#subAll" > Phaser.Group#subAll< / a >
2013-11-07 06:10:15 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-1125" > line 1125< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-11-07 06:10:15 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-11-07 06:10:15 +00:00
2013-10-02 19:18:24 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="swap">< span class = "type-signature" > < / span > swap< span class = "signature" > (child1, child2)< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > child1< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > any< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The first child to swap.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > child2< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > any< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The second child to swap.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
2014-11-15 20:01:46 +00:00
< / tbody >
< / table >
2014-07-10 19:31:11 +00:00
2014-11-15 20:01:46 +00:00
2014-07-10 19:31:11 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "Phaser.Group.html#swap" > Phaser.Group#swap< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-640" > line 640< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2014-12-03 10:39:11 +00:00
id="swapChildren">< span class = "type-signature" > < / span > swapChildren< span class = "signature" > (child, child2)< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Swaps the position of 2 Display Objects within this container.< / p >
2013-10-02 19:18:24 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > child< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
< / td >
< td class = "description last" > < p > -< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > child2< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > -< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
2014-11-15 20:01:46 +00:00
< / tbody >
< / table >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "PIXI.DisplayObjectContainer.html#swapChildren" > PIXI.DisplayObjectContainer#swapChildren< / a >
2014-11-15 20:01:46 +00:00
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_pixi_display_DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-134" > line 134< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dl >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt >
< h4 class = "name "
2015-03-23 23:46:30 +00:00
id="toGlobal">< span class = "type-signature" > < / span > toGlobal< span class = "signature" > (position)< / span > < span class = "type-signature" > → {Point}< / span > < / h4 >
2014-11-15 20:01:46 +00:00
< / dt >
< dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Calculates the global position of the display object< / p >
2014-11-15 20:01:46 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< tbody >
2013-10-02 19:18:24 +00:00
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > position< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2015-03-23 23:46:30 +00:00
< span class = "param-type" > Point< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The world origin to calculate from< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
2015-03-23 23:46:30 +00:00
< span class = "param-type" > Point< / span >
2014-12-03 10:39:11 +00:00
-
< / div >
< div class = "returns-desc param-desc" >
< p > A point object representing the position of this object< / p >
< / div >
< / div >
2013-10-02 19:18:24 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "PIXI.DisplayObject.html#toGlobal" > PIXI.DisplayObject#toGlobal< / a >
2013-10-02 19:18:24 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_pixi_display_DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "src_pixi_display_DisplayObject.js.html#sunlight-1-line-583" > line 583< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
2015-03-23 23:46:30 +00:00
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 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Calculates the local position of the display object relative to another point< / p >
2013-10-02 19:18:24 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2014-12-03 10:39:11 +00:00
< th > Argument< / th >
2013-10-02 19:18:24 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-12-03 10:39:11 +00:00
< td class = "name" > < code > position< / code > < / td >
< td class = "type" >
2015-03-23 23:46:30 +00:00
< span class = "param-type" > Point< / span >
2014-12-03 10:39:11 +00:00
< / 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 >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2013-10-02 19:18:24 +00:00
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The DisplayObject to calculate the global position from< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2014-12-03 10:39:11 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
2015-03-23 23:46:30 +00:00
< span class = "param-type" > Point< / span >
2014-12-03 10:39:11 +00:00
-
< / div >
< div class = "returns-desc param-desc" >
< p > A point object representing the position of this object< / p >
< / div >
< / div >
2013-10-02 19:18:24 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
2014-12-03 10:39:11 +00:00
< a href = "PIXI.DisplayObject.html#toLocal" > PIXI.DisplayObject#toLocal< / a >
2013-10-02 19:18:24 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_pixi_display_DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "src_pixi_display_DisplayObject.js.html#sunlight-1-line-597" > line 597< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-02-05 06:29:17 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2013-10-02 19:18:24 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="update">< span class = "type-signature" > < / span > update< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< div class = "description" >
< p > Called automatically by the game loop, decides when to launch particles and when to " die" .< / p >
< / div >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-03-23 23:46:30 +00:00
< a href = "src_particles_arcade_Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "src_particles_arcade_Emitter.js.html#sunlight-1-line-266" > line 266< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-03-14 06:36:05 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
< / 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 -
2015-07-22 14:31:30 +00:00
< a href = "src_pixi_display_DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "src_pixi_display_DisplayObject.js.html#sunlight-1-line-573" > line 573< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="updateZ">< span class = "type-signature" > < internal> < / span > updateZ< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2014-03-14 06:36:05 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
< div class = "description" >
2015-07-22 14:31:30 +00:00
< p > Internal method that re-applies all of the children's Z values.< / p >
2014-12-03 10:39:11 +00:00
< p > This must be called whenever children ordering is altered so that their < code > z< / code > indices are correctly updated.< / p >
2014-03-14 06:36:05 +00:00
< / div >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#updateZ" > Phaser.Group#updateZ< / a >
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "important tag-deprecated" > Internal:< / dt >
< dd class = "tag-deprecated" > < ul >
< li > This member is < em > internal (protected)< / em > and may be modified or removed in the future.< / li >
< / ul > < / dd >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-536" > line 536< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2014-03-14 06:36:05 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="xy">< span class = "type-signature" > < / span > xy< span class = "signature" > (index, x, y)< / span > < span class = "type-signature" > < / span > < / h4 >
2014-03-14 06:36:05 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
< div class = "description" >
2014-12-03 10:39:11 +00:00
< p > Positions the child found at the given index within this group to the given x and y coordinates.< / p >
2014-03-14 06:36:05 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > index< / code > < / td >
< td class = "type" >
2014-12-03 10:39:11 +00:00
< span class = "param-type" > integer< / span >
2014-03-14 06:36:05 +00:00
< / td >
2014-12-03 10:39:11 +00:00
< td class = "description last" > < p > The index of the child in the group to set the position of.< / p > < / td >
2014-03-14 06:36:05 +00:00
< / 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 >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#xy" > Phaser.Group#xy< / a >
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2015-07-22 14:31:30 +00:00
< a href = "src_core_Group.js.html" > core/Group.js< / a > , < a href = "src_core_Group.js.html#sunlight-1-line-742" > line 742< / a >
2014-11-15 20:01:46 +00:00
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2013-10-02 19:18:24 +00:00
< / dd >
< / dl >
< / article >
< / section >
< / div >
< div class = "clearfix" > < / div >
< footer >
< span class = "copyright" >
2015-03-23 23:46:30 +00:00
Phaser Copyright © 2012-2015 Photon Storm Ltd.
2013-10-02 19:18:24 +00:00
< / span >
< br / >
< span class = "jsdoc-message" >
2015-03-23 23:46:30 +00:00
Documentation generated by < a href = "https://github.com/jsdoc3/jsdoc" > JSDoc 3.3.0-alpha10< / a >
2015-07-22 14:31:30 +00:00
on Wed Jul 22 2015 14:55:17 GMT+0100 (GMT Daylight Time) using the < a href = "https://github.com/terryweiss/docstrap" > DocStrap template< / a > .
2013-10-02 19:18:24 +00:00
< / span >
< / footer >
< / div >
< div class = "span3" >
< div id = "toc" > < / div >
< / div >
< br clear = "both" >
< / div >
< / div >
< script src = "scripts/sunlight.js" > < / script >
< script src = "scripts/sunlight.javascript.js" > < / script >
< script src = "scripts/sunlight-plugin.doclinks.js" > < / script >
< script src = "scripts/sunlight-plugin.linenumbers.js" > < / script >
< script src = "scripts/sunlight-plugin.menu.js" > < / script >
< script src = "scripts/jquery.min.js" > < / script >
< script src = "scripts/jquery.scrollTo.js" > < / script >
< script src = "scripts/jquery.localScroll.js" > < / script >
< script src = "scripts/bootstrap-dropdown.js" > < / script >
< script src = "scripts/toc.js" > < / script >
< script > Sunlight . highlightAll ( { lineNumbers : true , showMenu : true , enableDoclinks : true } ) ; < / script >
< script >
$( function () {
$( "#toc" ).toc( {
2014-04-10 22:13:43 +00:00
anchorName : function(i, heading, prefix) {
2014-03-14 06:36:05 +00:00
return $(heading).attr("id") || ( prefix + i );
},
2013-10-02 19:18:24 +00:00
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
< / script >
< / body >
< / html >
