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-04-29 14:39:02 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.ArrayList.html" > ArrayList< / a >
< / li >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.ArraySet.html" > ArraySet< / a >
< / li >
2014-11-15 20:01:46 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.ArrayUtils.html" > ArrayUtils< / a >
< / li >
2014-10-09 15:12:53 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.AudioSprite.html" > AudioSprite< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.BitmapData.html" > BitmapData< / a >
< / 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 >
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 >
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 >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Back.html" > Back< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Bounce.html" > Bounce< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Circular.html" > Circular< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Cubic.html" > Cubic< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Elastic.html" > Elastic< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Exponential.html" > Exponential< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Linear.html" > Linear< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Quadratic.html" > Quadratic< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Quartic.html" > Quartic< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Quintic.html" > Quintic< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-2" >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.Sinusoidal.html" > Sinusoidal< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2014-02-18 03:01:51 +00:00
< a href = "Phaser.Ellipse.html" > Ellipse< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Events.html" > Events< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-11-28 15:57:09 +00:00
< a href = "Phaser.Filter.html" > Filter< / a >
< / li >
2014-09-09 14:36:56 +00:00
< li class = "class-depth-1" >
< a href = "Phaser.FlexGrid.html" > FlexGrid< / a >
< / li >
< li class = "class-depth-1" >
< a href = "Phaser.FlexLayer.html" > FlexLayer< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-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" >
2014-02-05 06:29:17 +00:00
< a href = "Phaser.GamepadButton.html" > GamepadButton< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-25 15:54:40 +00:00
< a href = "Phaser.Graphics.html" > Graphics< / a >
< / li >
2014-04-10 22:13:43 +00:00
< li class = "class-depth-1" >
2013-10-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 >
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 >
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 >
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 >
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" >
2013-10-02 19:18:24 +00:00
< a href = "Phaser.World.html" > World< / a >
< / li >
2014-11-15 20:01:46 +00:00
< li class = "class-depth-1" >
< a href = "PIXI.AbstractFilter.html" > AbstractFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.AjaxRequest.html" > AjaxRequest< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.AlphaMaskFilter.html" > AlphaMaskFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.AsciiFilter.html" > AsciiFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.AssetLoader.html" > AssetLoader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.AtlasLoader.html" > AtlasLoader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.BaseTexture.html" > BaseTexture< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.BitmapFontLoader.html" > BitmapFontLoader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.BitmapText.html" > BitmapText< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.BlurFilter.html" > BlurFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.BlurXFilter.html" > BlurXFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.BlurYFilter.html" > BlurYFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.CanvasBuffer.html" > CanvasBuffer< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.CanvasGraphics.html" > CanvasGraphics< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.CanvasMaskManager.html" > CanvasMaskManager< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.CanvasRenderer.html" > CanvasRenderer< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.CanvasTinter.html" > CanvasTinter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Circle.html" > Circle< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.ColorMatrixFilter.html" > ColorMatrixFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.ColorStepFilter.html" > ColorStepFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.ComplexPrimitiveShader.html" > ComplexPrimitiveShader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.ConvolutionFilter.html" > ConvolutionFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.CrossHatchFilter.html" > CrossHatchFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.DisplacementFilter.html" > DisplacementFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.DisplayObject.html" > DisplayObject< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.DisplayObjectContainer.html" > DisplayObjectContainer< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.DotScreenFilter.html" > DotScreenFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Ellipse.html" > Ellipse< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Event.html" > Event< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.EventTarget.html" > EventTarget< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.FilterBlock.html" > FilterBlock< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.FilterTexture.html" > FilterTexture< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Graphics.html" > Graphics< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.GraphicsData.html" > GraphicsData< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.GrayFilter.html" > GrayFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.ImageLoader.html" > ImageLoader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.InteractionData.html" > InteractionData< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.InteractionManager.html" > InteractionManager< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.InvertFilter.html" > InvertFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.JsonLoader.html" > JsonLoader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Matrix.html" > Matrix< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.MovieClip.html" > MovieClip< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.NoiseFilter.html" > NoiseFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.NormalMapFilter.html" > NormalMapFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.PixelateFilter.html" > PixelateFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.PIXI.html" > PIXI< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.PixiFastShader.html" > PixiFastShader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.PixiShader.html" > PixiShader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Point.html" > Point< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Polygon.html" > Polygon< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.PolyK.html" > PolyK< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.PrimitiveShader.html" > PrimitiveShader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Rectangle.html" > Rectangle< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.RenderTexture.html" > RenderTexture< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.RGBSplitFilter.html" > RGBSplitFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Rope.html" > Rope< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.RoundedRectangle.html" > RoundedRectangle< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.SepiaFilter.html" > SepiaFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.SmartBlurFilter.html" > SmartBlurFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Spine.html" > Spine< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.SpineLoader.html" > SpineLoader< / a >
< / li >
2014-11-25 00:23:44 +00:00
< li class = "class-depth-1" >
< a href = "PIXI.SpineTextureLoader.html" > SpineTextureLoader< / a >
< / li >
2014-11-15 20:01:46 +00:00
< li class = "class-depth-1" >
< a href = "PIXI.Sprite.html" > Sprite< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.SpriteBatch.html" > SpriteBatch< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.SpriteSheetLoader.html" > SpriteSheetLoader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Stage.html" > Stage< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Strip.html" > Strip< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.StripShader.html" > StripShader< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Text.html" > Text< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.Texture.html" > Texture< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.TilingSprite.html" > TilingSprite< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.TiltShiftFilter.html" > TiltShiftFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.TiltShiftXFilter.html" > TiltShiftXFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.TiltShiftYFilter.html" > TiltShiftYFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.TwistFilter.html" > TwistFilter< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.VideoTexture.html" > VideoTexture< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.WebGLBlendModeManager.html" > WebGLBlendModeManager< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.WebGLFastSpriteBatch.html" > WebGLFastSpriteBatch< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.WebGLFilterManager.html" > WebGLFilterManager< / a >
< / li >
< li class = "class-depth-1" >
< a href = "PIXI.WebGLRenderer.html" > WebGLRenderer< / a >
< / li >
2013-10-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 " >
< li class = "class-depth-1" > < a href = "Phaser.Group.html" > Group< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.World.html" > World< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Loader.html" > Loader< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Time.html" > Time< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Camera.html" > Camera< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.StateManager.html" > State Manager< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.TweenManager.html" > Tween Manager< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.SoundManager.html" > Sound Manager< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.InputManager.html" > Input Manager< / a > < / li >
< 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 >
< li class = "class-depth-1" > < a href = "Phaser.Emitter.html" > Emitter< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Text.html" > Text< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Tween.html" > Tween< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.BitmapText.html" > BitmapText< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Tilemap.html" > Tilemap< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.BitmapData.html" > BitmapData< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.RetroFont.html" > RetroFont< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Button.html" > Button< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Animation.html" > Animation< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Graphics.html" > Graphics< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.RenderTexture.html" > RenderTexture< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.TileSprite.html" > TileSprite< / a > < / li >
< / ul >
< / li >
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.Rectangle.html" > Rectangle< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Point.html" > Point< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Line.html" > Line< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Ellipse.html" > Ellipse< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Polygon.html" > Polygon< / a > < / li >
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 >
< li class = "class-depth-1" > < a href = "Phaser.Mouse.html" > Mouse< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Keyboard.html" > Keyboard< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Key.html" > Key< / a > < / li >
< li class = "class-depth-1" > < a href = "Phaser.Gamepad.html" > Gamepad< / a > < / li >
< / ul >
< / li >
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Community< b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu " >
< li class = "class-depth-1" > < a href = "https://github.com/photonstorm/phaser" > Phaser Github< / a > < / li >
< li class = "class-depth-1" > < a href = "http://examples.phaser.io" > Phaser Examples< / a > < / li >
< li class = "class-depth-1" > < a href = "https://github.com/photonstorm/phaser-plugins" > Phaser Plugins< / a > < / li >
< li class = "class-depth-1" > < a href = "http://www.html5gamedevs.com/forum/14-phaser/" > Forum< / a > < / li >
< li class = "class-depth-1" > < a href = "http://stackoverflow.com/questions/tagged/phaser-framework" > Stack Overflow< / a > < / li >
< li class = "class-depth-1" > < a href = "https://confirmsubscription.com/h/r/369DE48E3E86AF1E" > Newsletter< / a > < / li >
< li class = "class-depth-1" > < a href = "https://twitter.com/photonstorm" > Twitter< / a > < / li >
< li class = "class-depth-1" > < a href = "http://www.html5gamedevs.com/topic/4470-official-phaserio-irc-channel-phaserio-on-freenode/" > IRC< / a > < / li >
< li class = "class-depth-1" > < a href = "https://www.gittip.com/photonstorm/" > GitTip< / a > < / li >
< / ul >
< / li >
2014-11-15 20:01:46 +00:00
< / ul >
< / div >
< / div >
< div class = "row-fluid" >
2013-10-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 >
2014-10-09 15:12:53 +00:00
< div class = "class-description" > < p > Phaser.Particles.Arcade.Emitter< / p > < / div >
2013-10-02 19:18:24 +00:00
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-20" > line 20< / a >
< / 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 -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-70" > line 70< / a >
< / 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" >
< p > The alpha value of the Group container.< / 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-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 -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1907" > line 1907< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-103" > line 103< / a >
< / 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" >
< p > The angle of rotation of the Group container. 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. The angle of rotation given in degrees, where 0 degrees = to the right.< / 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 = "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 -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1848" > line 1848< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-126" > line 126< / a >
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-45" > line 45< / a >
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-187" > line 187< / a >
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-182" > line 182< / a >
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-161" > line 161< / a >
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-806" > line 806< / a >
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-143" > line 143< / a >
< / 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="buttonMode">< span class = "type-signature" > < / span > buttonMode< 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" >
< p > This is used to indicate if the displayObject should display a mouse hand cursor on rollover< / p >
< / 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 >
< a href = "PIXI.DisplayObject.html#buttonMode" > PIXI.DisplayObject#buttonMode< / a >
< / li > < / dd >
2014-02-18 03:01:51 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-90" > line 90< / a >
< / dt >
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 "
id="cacheAsBitmap">< span class = "type-signature" > < / span > cacheAsBitmap< span class = "type-signature" > :Boolean< / span > < / h4 >
2013-11-01 18:16:52 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Set if this display object is cached as a bitmap.
This basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.
To remove simply set this property to 'null'< / p >
< / div >
2013-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 >
< a href = "PIXI.DisplayObject.html#cacheAsBitmap" > PIXI.DisplayObject#cacheAsBitmap< / a >
< / 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 -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-436" > line 436< / a >
< / 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 "
id="cameraOffset">< span class = "type-signature" > < / span > cameraOffset< span class = "type-signature" > :< a href = "Phaser.Point.html" > Phaser.Point< / a > < / span > < / h4 >
< / dt >
< dd >
2013-11-01 18:16:52 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > If this object is fixedToCamera then this stores the x/y offset that its drawn at, from the top-left of the camera view.< / p >
< / div >
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 >
< a href = "Phaser.Group.html#cameraOffset" > Phaser.Group#cameraOffset< / a >
< / li > < / dd >
2013-11-01 18:16:52 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-107" > line 107< / a >
< / 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 "
id="children">< span class = "type-signature" > < readonly> < / span > children< span class = "type-signature" > :Array.< DisplayObject>< / 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 > [read-only] The array of children of this container.< / 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.< DisplayObject>< / 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-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObjectContainer.html#children" > PIXI.DisplayObjectContainer#children< / a >
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "DisplayObjectContainer.js.html#sunlight-1-line-17" > line 17< / a >
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
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
< div class = "description" >
< p > The type of objects that will be created when you use Group.create or Group.createMultiple. Defaults to Phaser.Sprite.
When a new object is created it is passed the following parameters to its constructor: game, x, y, key, frame.< / 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 = "Phaser.Group.html#classType" > Phaser.Group#classType< / 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 -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-90" > line 90< / a >
< / 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="cursor">< span class = "type-signature" > < / span > cursor< span class = "type-signature" > :any< / 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 cursor is a simple way to iterate through the objects in a Group using the Group.next and Group.previous functions.
The cursor is set to the first child added to the Group and doesn't change unless you call next, previous or set it directly with Group.cursor. The current display object that the Group cursor is pointing to.< / 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 = "Phaser.Group.html#cursor" > Phaser.Group#cursor< / a >
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-102" > line 102< / a >
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="defaultCursor">< span class = "type-signature" > < / span > defaultCursor< 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 > This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true< / p >
< / div >
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#defaultCursor" > PIXI.DisplayObject#defaultCursor< / 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 -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-143" > line 143< / a >
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-169" > line 169< / a >
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-177" > line 177< / a >
< / 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" >
< p > If true all Sprites created by, or added to this Group, will have a physics body enabled on them. Change the body type with < code > Group.physicsBodyType< / code > .< / p >
< / 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-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > enableBody< / li > < / ul > < / dd >
2014-02-18 03:01:51 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-113" > line 113< / a >
< / 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-11-15 20:01:46 +00:00
< p > If true when a physics body is created (via Group.enableBody) it will create a physics debug object as well. 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-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-118" > line 118< / a >
< / 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-11-15 20:01:46 +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 -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-76" > line 76< / a >
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="filterArea">< span class = "type-signature" > < / span > filterArea< span class = "type-signature" > :< a href = "PIXI.Rectangle.html" > PIXI.Rectangle< / a > < / span > < / h4 >
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 -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-180" > line 180< / a >
< / 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 -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-400" > line 400< / a >
< / 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" >
< 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.
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 Set to true to fix this Group to the Camera at its current world coordinates.< / 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 = "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 -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1866" > line 1866< / 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="frequency">< span class = "type-signature" > < / span > frequency< span class = "type-signature" > :boolean< / 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 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-132" > line 132< / a >
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="game">< span class = "type-signature" > < / span > game< span class = "type-signature" > :< a href = "Phaser.Game.html" > Phaser.Game< / a > < / span > < / h4 >
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-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 -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-30" > line 30< / a >
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-109" > line 109< / a >
< / 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="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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-719" > line 719< / a >
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="hitArea">< span class = "type-signature" > < / span > hitArea< span class = "type-signature" > :< a href = "PIXI.Rectangle.html" > PIXI.Rectangle< / a > |< a href = "PIXI.Circle.html" > PIXI.Circle< / a > |< a href = "PIXI.Ellipse.html" > PIXI.Ellipse< / a > |< a href = "PIXI.Polygon.html" > PIXI.Polygon< / a > < / span > < / h4 >
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
2014-11-15 20:01:46 +00:00
< span class = "param-type" > < a href = "PIXI.Rectangle.html" > PIXI.Rectangle< / a > < / span >
|
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< span class = "param-type" > < a href = "PIXI.Circle.html" > PIXI.Circle< / a > < / span >
|
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< span class = "param-type" > < a href = "PIXI.Ellipse.html" > PIXI.Ellipse< / a > < / span >
|
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< span class = "param-type" > < a href = "PIXI.Polygon.html" > PIXI.Polygon< / a > < / 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 -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-81" > line 81< / a >
< / 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" >
< p > A Group with < code > ignoreDestroy< / code > set to < code > true< / code > ignores all calls to its < code > destroy< / code > method.< / 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 = "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 -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-82" > line 82< / a >
< / 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="interactive">< span class = "type-signature" > < / span > interactive< span class = "type-signature" > :Boolean< / span > < / h4 >
< / dt >
< dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Indicates if the sprite will have touch and mouse interactivity. It is false by default< / 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#interactive" > PIXI.DisplayObject#interactive< / a >
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-02-05 06:29:17 +00:00
< dt class = "tag-default" > Default Value:< / dt >
2014-11-15 20:01:46 +00:00
< dd class = "tag-default" > < ul class = "dummy" > < li > false< / li > < / ul > < / dd >
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 -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-339" > line 339< / a >
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-767" > line 767< / a >
< / dt >
2014-10-09 15:12:53 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="length">< span class = "type-signature" > < readonly> < / span > length< span class = "type-signature" > :number< / 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" >
< p > The total number of children in this Group, regardless of their exists/alive status.< / p >
< / 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 -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1833" > line 1833< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-138" > line 138< / a >
< / 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 -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-380" > line 380< / a >
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-98" > line 98< / a >
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-26" > line 26< / a >
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-69" > line 69< / a >
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-57" > line 57< / a >
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-86" > line 86< / a >
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-92" > line 92< / a >
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-63" > line 63< / a >
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-51" > line 51< / a >
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-80" > line 80< / a >
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-33" > line 33< / a >
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-149" > line 149< / a >
< / 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" >
< p > This signal is dispatched if this Group is destroyed.< / p >
< / 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 -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-128" > line 128< / a >
< / 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 -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-106" > line 106< / a >
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-155" > line 155< / a >
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-193" > line 193< / a >
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-115" > line 115< / a >
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-120" > line 120< / a >
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-199" > line 199< / a >
< / 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 "
id="physicsBodyType">< span class = "type-signature" > < / span > physicsBodyType< 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 > If Group.enableBody is true this is the type of physics body that is created on new Sprites. Phaser.Physics.ARCADE, Phaser.Physics.P2, Phaser.Physics.NINJA, etc.< / 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 = "Phaser.Group.html#physicsBodyType" > Phaser.Group#physicsBodyType< / 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 -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-123" > line 123< / a >
< / 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="pivot">< span class = "type-signature" > < / span > pivot< span class = "type-signature" > :< a href = "PIXI.Point.html" > PIXI.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 pivot point of the displayObject that it rotates around< / 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#pivot" > PIXI.DisplayObject#pivot< / a >
< / 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
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-49" > line 49< / a >
< / 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 "
id="position">< span class = "type-signature" > < / span > position< span class = "type-signature" > :< a href = "PIXI.Point.html" > PIXI.Point< / a > < / span > < / h4 >
2014-09-09 14:36:56 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > The coordinate of the object relative to the local coordinates of the parent.< / p >
< / div >
2014-09-09 14:36:56 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2014-09-09 14:36:56 +00:00
< dt class = "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#position" > PIXI.DisplayObject#position< / a >
2014-09-09 14:36:56 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-14" > line 14< / a >
< / 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 "
id="renderable">< span class = "type-signature" > < / span > renderable< 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" >
< p > Can this object be rendered< / p >
< / 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 = "PIXI.DisplayObject.html#renderable" > PIXI.DisplayObject#renderable< / a >
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-98" > line 98< / a >
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
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" >
< p > Gets the right 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-780" > line 780< / a >
< / 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="rotation">< span class = "type-signature" > < / span > rotation< 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 angle of rotation of the Group container. 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. The angle of rotation given in radians.< / 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 = "Phaser.Group.html#rotation" > Phaser.Group#rotation< / a >
< / 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 -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1903" > line 1903< / 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="scale">< span class = "type-signature" > < / span > scale< 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 scale of the Group container.< / 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 = "Phaser.Group.html#scale" > Phaser.Group#scale< / 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 -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-95" > line 95< / a >
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-74" > line 74< / a >
< / 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 -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-115" > line 115< / a >
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-793" > line 793< / a >
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="total">< span class = "type-signature" > < readonly> < / span > total< 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 children in this Group who have a state of exists = true.< / 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 = "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 -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1818" > line 1818< / 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 -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-30" > line 30< / a >
< / 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 -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-41" > line 41< / 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="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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-39" > line 39< / a >
< / 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" >
< p > The visible state of the Group. Non-visible Groups and all of their children are not rendered.< / 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 = "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 -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1905" > line 1905< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-703" > line 703< / a >
< / 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 -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-124" > line 124< / 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 -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-359" > line 359< / a >
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-735" > line 735< / a >
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-751" > line 751< / a >
< / dt >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="z">< span class = "type-signature" > < / span > z< 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 z-depth value of this object within its Group (remember the World is a Group as well). No two objects in a Group can have the same z value.< / p >
< / div >
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 -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-45" > line 45< / a >
< / 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 "
id="add">< span class = "type-signature" > < / span > add< span class = "signature" > (child, < span class = "optional" > silent< / 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-11-15 20:01:46 +00:00
< div class = "description" >
< p > Adds an existing object to this Group. The object can be an instance of Phaser.Sprite, Phaser.Button or any other display object.
The child is automatically added to the top of the Group, so renders on-top of everything else within the Group. If you need to control
that then see the addAt method.< / 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 >
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-11-15 20:01:46 +00:00
< span class = "param-type" > *< / 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-11-15 20:01:46 +00:00
< td class = "description last" > < p > An instance of Phaser.Sprite, Phaser.Button or any other display object.< / p > < / td >
< / 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-11-15 20:01:46 +00:00
< td class = "description last" > < p > If the silent parameter is < code > true< / code > the child will not dispatch the onAddedToGroup 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" >
< span class = "param-type" > *< / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The child that was added to the Group.< / p >
< / 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 -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-188" > line 188< / a >
< / 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
2014-11-15 20:01:46 +00:00
< dt class = "tag-see" > See:< / dt >
< dd class = "tag-see" >
< ul >
< li > < a href = "Phaser.Group.html#create" > Phaser.Group#create< / a > < / li >
< li > < a href = "Phaser.Group.html#addAt" > Phaser.Group#addAt< / a > < / li >
< / ul >
< / 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
< / 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" >
< p > Adds the amount to the given property on all children in this Group.
Group.addAll('x', 10) will add 10 to the child.x value.< / 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 > 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 -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-937" > line 937< / a >
< / 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="addAt">< span class = "type-signature" > < / span > addAt< span class = "signature" > (child, index, < span class = "optional" > silent< / 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-11-15 20:01:46 +00:00
< div class = "description" >
< p > Adds an existing object to this Group. The object can be an instance of Phaser.Sprite, Phaser.Button or any other display object.
The child is added to the Group at the location specified by the index value, this allows you to control child ordering.< / 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 >
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" >
< span class = "param-type" > *< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > An instance of Phaser.Sprite, Phaser.Button or any other display object..< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > index< / 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 >
2014-11-15 20:01:46 +00:00
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > The index within the Group to insert the child to.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > silent< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
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-11-15 20:01:46 +00:00
< td class = "description last" > < p > If the silent parameter is < code > true< / code > the child will not dispatch the onAddedToGroup 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" >
< span class = "param-type" > *< / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The child that was added to the Group.< / p >
< / 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 -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-254" > line 254< / a >
< / 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 -
< a href = "DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "DisplayObjectContainer.js.html#sunlight-1-line-90" > line 90< / a >
< / 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" >
< p > The child that was added.< / p >
< / 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 >
2014-11-15 20:01:46 +00:00
< a href = "PIXI.DisplayObjectContainer.html#addChildAt" > PIXI.DisplayObjectContainer#addChildAt< / a >
2013-11-01 18:16:52 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "DisplayObjectContainer.js.html#sunlight-1-line-102" > line 102< / a >
< / 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 "
id="addMultiple">< span class = "type-signature" > < / span > addMultiple< span class = "signature" > (children, < span class = "optional" > silent< / 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-11-15 20:01:46 +00:00
< p > Adds an array existing objects to this Group. The objects can be instances of Phaser.Sprite, Phaser.Button or any other display object.
The children are automatically added to the top of the Group, so render on-top of everything else within the Group.
TODO: Add ability to pass the children as parameters rather than having to be an array.< / 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-11-15 20:01:46 +00:00
< th > Argument< / th >
2014-02-05 06:29:17 +00:00
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< th > Default< / th >
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 >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > children< / code > < / td >
2014-04-10 22:13:43 +00:00
2014-02-05 06:29:17 +00:00
2014-04-10 22:13:43 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > array< / span >
2014-02-05 06:29:17 +00:00
2014-04-10 22:13:43 +00:00
< / td >
2014-02-05 06:29:17 +00:00
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< td class = "attributes" >
2014-04-10 22:13:43 +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
< / td >
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-11-15 20:01:46 +00:00
< td class = "default" >
< / td >
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 class = "description last" > < p > An array containing instances of Phaser.Sprite, Phaser.Button or any other display object.< / 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
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > silent< / 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" > boolean< / span >
< / 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
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" >
false
< / td >
2014-04-10 22:13:43 +00:00
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > If the silent parameter is < code > true< / code > the children will not dispatch the onAddedToGroup event.< / 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" >
< span class = "param-type" > *< / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The array of children that were added to the Group.< / 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-11-15 20:01:46 +00:00
< a href = "Phaser.Group.html#addMultiple" > Phaser.Group#addMultiple< / a >
2013-10-02 19:18:24 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-230" > line 230< / a >
< / 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 "
id="ascendingSortHandler">< span class = "type-signature" > < / 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 >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1417" > line 1417< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-681" > line 681< / a >
< / 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 "
id="bringToTop">< span class = "type-signature" > < / span > bringToTop< span class = "signature" > (child)< / span > < span class = "type-signature" > → {*}< / 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-11-15 20:01:46 +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-11-15 20:01:46 +00:00
< span class = "param-type" > *< / span >
2013-10-23 13:00:28 +00:00
< / td >
2014-11-15 20:01:46 +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" >
< span class = "param-type" > *< / 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 -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-493" > line 493< / a >
< / 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 "
id="callAll">< span class = "type-signature" > < / span > callAll< span class = "signature" > (method, < span class = "optional" > context< / span > , parameter)< / 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-11-15 20:01:46 +00:00
< p > Calls a function on all of the children regardless if they are dead or alive (see callAllExists if you need control over that)
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-11-15 20:01:46 +00:00
< td class = "description last" > < p > A string containing the name of the function that will be called. The function must exist on the child.< / 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-11-15 20:01:46 +00:00
< td class = "name" > < code > parameter< / 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" > *< / 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 -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1082" > line 1082< / 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-11-15 20:01:46 +00:00
< p > Calls a function on all of the children that have exists=true in this Group.
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-11-15 20:01:46 +00:00
< span class = "param-type" > function< / span >
2014-02-05 06:29:17 +00:00
< / td >
< td class = "attributes" >
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The function that exists on the children that will be called.< / 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" >
< span class = "param-type" > *< / span >
< / 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 -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1001" > line 1001< / a >
< / 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-11-15 20:01:46 +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-11-15 20:01:46 +00:00
< span class = "param-type" > number< / 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 -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1029" > line 1029< / 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-11-15 20:01:46 +00:00
< p > This function allows you to quickly check that the same property across all children of this Group is equal to the given value.
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-07-18 11:45:51 +00:00
< span class = "param-type" > *< / 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 -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-905" > line 905< / a >
< / 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" >
< span class = "param-type" > *< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > The child to check the property value on.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > key< / code > < / td >
< td class = "type" >
< span class = "param-type" > array< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > An array of strings that make up the property that will be set.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > value< / code > < / td >
< td class = "type" >
< span class = "param-type" > *< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > The value that will be checked.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > force< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
false
< / td >
< td class = "description last" > < p > If < code > force< / code > is true then the property will be checked on the child regardless if it already exists or not. If true and the property doesn't exist, false will be returned.< / p > < / td >
< / tr >
< / tbody >
< / table >
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 -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-771" > line 771< / a >
< / 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 "
id="click">< span class = "type-signature" > < / span > click< span class = "signature" > (interactionData)< / span > < span class = "type-signature" > < / 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-11-15 20:01:46 +00:00
< p > A callback that is used when the users clicks on the displayObject with their mouse's left button< / p >
2014-07-18 11:45:51 +00:00
< / div >
2014-11-15 20:01:46 +00:00
< h5 > Parameters:< / h5 >
2014-07-18 11:45:51 +00:00
2014-11-15 20:01:46 +00:00
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
2014-07-18 11:45:51 +00:00
2014-11-15 20:01:46 +00:00
< th > Type< / th >
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
2014-07-18 11:45:51 +00:00
2014-11-15 20:01:46 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2014-07-18 11:45:51 +00:00
2014-11-15 20:01:46 +00:00
< tbody >
2014-07-18 11:45:51 +00:00
2014-11-15 20:01:46 +00:00
< tr >
< td class = "name" > < code > interactionData< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "PIXI.InteractionData.html" > PIXI.InteractionData< / a > < / span >
< / td >
< td class = "description last" > < p > -< / p > < / td >
< / tr >
< / tbody >
< / table >
2014-07-18 11:45:51 +00:00
2014-11-15 20:01:46 +00:00
< dl class = "details" >
2014-07-18 11:45:51 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#click" > PIXI.DisplayObject#click< / a >
< / li > < / dd >
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
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
2014-07-18 11:45:51 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-252" > line 252< / a >
< / 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
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
< / 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 "
id="countDead">< span class = "type-signature" > < / span > countDead< span class = "signature" > ()< / span > < span class = "type-signature" > → {number}< / 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-11-15 20:01:46 +00:00
< p > Call this function to find out how many members of the group are dead.< / p >
2014-07-18 11:45:51 +00:00
< / div >
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 number of children flagged as dead.< / 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 >
2014-11-15 20:01:46 +00:00
< a href = "Phaser.Group.html#countDead" > Phaser.Group#countDead< / a >
2014-07-18 11:45:51 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1616" > line 1616< / 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 "
id="countLiving">< span class = "type-signature" > < / span > countLiving< span class = "signature" > ()< / span > < span class = "type-signature" > → {number}< / 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" >
< p > Call this function to find out how many members of the group are alive.< / p >
< / 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-07-18 11:45:51 +00:00
< span class = "param-type" > number< / span >
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 -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1604" > line 1604< / 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 "
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 = "Phaser.Sprite.html" > Phaser.Sprite< / a > |object}< / 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 > Automatically creates a new Phaser.Sprite object and adds it to the top of this Group.
You can change Group.classType to any object and this call will create an object of that type instead, but it should extend either Sprite or Image.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > The x coordinate to display the newly created Sprite at. The value is in relation to the Group.x point.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > The y coordinate to display the newly created Sprite at. The value is in relation to the Group.y point.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > key< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > The Game.cache key of the image that this Sprite will use.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > frame< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
|
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > If the Sprite image contains multiple frames you can specify which one to use here.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > exists< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
true
< / td >
< td class = "description last" > < p > The default exists state of the Sprite.< / p > < / td >
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > < a href = "Phaser.Sprite.html" > Phaser.Sprite< / a > < / span >
|
< span class = "param-type" > object< / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The child that was created. Will be a Phaser.Sprite unless Group.classType has been changed.< / 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#create" > Phaser.Group#create< / a >
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-314" > line 314< / a >
< / 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-04-10 22:13:43 +00:00
< p > Automatically creates multiple Phaser.Sprite objects and adds them to the top of this Group.
Useful if you need to quickly generate a pool of identical sprites, such as bullets. By default the sprites will be set to not exist
2014-04-29 14:39:02 +00:00
and will be positioned at 0, 0 (relative to the Group.x/y)
You can change Group.classType to any object and this call will create an object of that type instead, but it should extend either Sprite or Image.< / 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-04-10 22:13:43 +00:00
< span class = "param-type" > number< / 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" >
< span class = "param-type" > number< / span >
|
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > If the Sprite image contains multiple frames you can specify which one to use here.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > exists< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
false
< / td >
< td class = "description last" > < p > The default exists state of the Sprite.< / p > < / td >
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 -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-359" > line 359< / a >
< / 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="customSort">< span class = "type-signature" > < / span > customSort< span class = "signature" > (sortHandler, context)< / 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-04-10 22:13:43 +00:00
< p > This allows you to use your own sort handler function.
It will be sent two parameters: the two children involved in the comparison (a and b). It should return -1 if a > b, 1 if a < b or 0 if a === b.< / 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 > 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-04-10 22:13:43 +00:00
< td class = "description last" > < p > Your sort handler function. It will be sent two parameters: the two children involved in the comparison. It must return -1, 1 or 0.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > context< / code > < / td >
< td class = "type" >
< span class = "param-type" > object< / span >
< / td >
< td class = "description last" > < p > The scope 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 -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1395" > line 1395< / 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="descendingSortHandler">< span class = "type-signature" > < / 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-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1448" > line 1448< / 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="destroy">< span class = "type-signature" > < / span > destroy< span class = "signature" > (< span class = "optional" > destroyChildren< / span > , < span class = "optional" > soft< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
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-04-10 22:13:43 +00:00
< p > Destroys this Group. Removes all children, then removes the container from the display list and nulls references.< / p >
2013-10-02 19:18:24 +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 >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > destroyChildren< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
true
< / td >
< td class = "description last" > < p > Should every child of this Group have its destroy method called?< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > soft< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
false
< / td >
< td class = "description last" > < p > A 'soft destroy' (set to true) doesn't remove this Group from its parent or null the game reference. Set to false and it does.< / p > < / td >
< / tr >
< / tbody >
< / table >
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#destroy" > Phaser.Group#destroy< / a >
2013-10-02 19:18:24 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1784" > line 1784< / 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-04-10 22:13:43 +00:00
< p > Divides the given property by the amount on all children in this Group.
Group.divideAll('x', 2) will half the child.x value.< / 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 -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-985" > line 985< / a >
< / dt >
2014-07-10 19:31:11 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-07-10 19:31:11 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="emitParticle">< span class = "type-signature" > < / span > emitParticle< span class = "signature" > ()< / 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 > 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
2014-07-10 19:31:11 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-444" > line 444< / a >
< / dt >
2014-07-10 19:31:11 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-07-10 19:31:11 +00:00
< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-375" > line 375< / a >
< / dt >
2014-07-10 19:31:11 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-07-10 19:31:11 +00:00
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-11-25 00:23:44 +00:00
< p > Allows you to obtain a Phaser.ArraySet of children that return true for the given predicate
For example:< / p >
< pre > < code > var healthyList = Group.filter(function(child, index, children) {
return child.health > 10 ? true : false;
}, true);
healthyList.callAll('attack');< / code > < / pre >
< p > Note: Currently this will skip any children which are Groups themselves.< / p >
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 >
< td class = "description last" > < p > The function that each child will be evaluated against. Each child of the Group will be passed to it as its first parameter, the index as the second, and the entire child array as the third< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > checkExists< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
false
< / td >
< td class = "description last" > < p > If set only children with exists=true will be passed to the callback, otherwise all children will be passed.< / p > < / td >
< / 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 -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1212" > line 1212< / 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 "
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 > < 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 start emitting a flow of particles at the given frequency.< / 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 > 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
2014-07-10 19:31:11 +00:00
< td class = "description last" > < p > Frequency is how often to emit a particle, 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" >
0
< / td >
< td class = "description last" > < p > How many particles to launch.< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-388" > line 388< / a >
< / dt >
2014-03-14 06:36:05 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="forEach">< span class = "type-signature" > < / span > forEach< span class = "signature" > (callback, callbackContext, < span class = "optional" > checkExists< / 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-04-10 22:13:43 +00:00
< p > Allows you to call your own function on each member of this Group. You must pass the callback and context in which it will run.
After the checkExists parameter you can add as many parameters as you like, which will all be passed to the callback along with the child.
For example: Group.forEach(awardBonusGold, this, true, 100, 500)
Note: Currently this 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 >
< td class = "description last" > < p > The function that will be called. Each child of the Group will be passed to it as its first parameter.< / 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-04-11 12:09:28 +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 >
< td class = "description last" > < p > If set only children with exists=true will be passed to the callback, otherwise all children will be passed.< / p > < / td >
< / 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 -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1251" > line 1251< / 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="forEachAlive">< span class = "type-signature" > < / span > forEachAlive< span class = "signature" > (callback, callbackContext)< / 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 > Allows you to call your own function on each alive member of this Group (where child.alive=true). You must pass the callback and context in which it will run.
You can add as many parameters as you like, which will all be passed to the callback along with the child.
For example: Group.forEachAlive(causeDamage, this, 500)< / 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 >
< td class = "name" > < code > callback< / code > < / td >
< td class = "type" >
< span class = "param-type" > function< / span >
< / td >
< td class = "description last" > < p > The function that will be called. Each child of the Group will be passed to it as its first parameter.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > callbackContext< / code > < / td >
< td class = "type" >
2014-04-11 12:09:28 +00:00
< span class = "param-type" > Object< / span >
2014-04-10 22:13:43 +00:00
< / td >
< td class = "description last" > < p > The context in which the function should be called (usually 'this').< / 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 >
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 -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1317" > line 1317< / 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="forEachDead">< span class = "type-signature" > < / span > forEachDead< span class = "signature" > (callback, callbackContext)< / 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-04-10 22:13:43 +00:00
< p > Allows you to call your own function on each dead member of this Group (where alive=false). You must pass the callback and context in which it will run.
You can add as many parameters as you like, which will all be passed to the callback along with the child.
For example: Group.forEachDead(bringToLife, this)< / 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 > 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-04-10 22:13:43 +00:00
< td class = "description last" > < p > The function that will be called. Each child of the Group will be passed to it as its first parameter.< / 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-04-11 12:09:28 +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 = "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
< / 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 -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1339" > line 1339< / 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 "
id="forEachExists">< span class = "type-signature" > < / span > forEachExists< span class = "signature" > (callback, callbackContext)< / 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" >
< p > Allows you to call your own function on each member of this Group where child.exists=true. You must pass the callback and context in which it will run.
You can add as many parameters as you like, which will all be passed to the callback along with the child.
For example: Group.forEachExists(causeDamage, this, 500)< / p >
< / 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 >
< 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-04-10 22:13:43 +00:00
< td class = "description last" > < p > The function that will be called. Each child of the Group will be passed to it as its first parameter.< / p > < / td >
2014-03-14 06:36:05 +00:00
< / tr >
< tr >
< td class = "name" > < code > callbackContext< / code > < / td >
< td class = "type" >
2014-04-11 12:09:28 +00:00
< span class = "param-type" > Object< / span >
2014-03-14 06:36:05 +00:00
< / td >
< 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 >
< / 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 -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1295" > line 1295< / 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 -
2014-11-25 00:23:44 +00:00
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-582" > line 582< / a >
2014-11-15 20:01:46 +00:00
< / dt >
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="getAt">< span class = "type-signature" > < / span > getAt< span class = "signature" > (index)< / span > < span class = "type-signature" > → {*}< / span > < / h4 >
2014-03-14 06:36:05 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
< div class = "description" >
2014-11-15 20:01:46 +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" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The index to return the child from.< / p > < / td >
< / tr >
< / tbody >
< / table >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > *< / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The child that was found at the given index. If the index was out of bounds then this will return -1.< / p >
< / 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 -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-294" > line 294< / a >
< / 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="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-11-15 20:01:46 +00:00
< p > Returns the child at the bottom of this Group. The bottom is the one 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" >
< span class = "param-type" > Any< / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The child at the bottom of the Group.< / p >
< / div >
< / div >
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 -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1589" > line 1589< / 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="getBounds">< span class = "type-signature" > < / span > getBounds< span class = "signature" > ()< / span > < span class = "type-signature" > → {< a href = "PIXI.Rectangle.html" > PIXI.Rectangle< / a > }< / span > < / h4 >
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" >
< span class = "param-type" > < a href = "PIXI.Rectangle.html" > PIXI.Rectangle< / a > < / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The rectangular bounding area< / p >
< / div >
< / div >
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 -
< a href = "DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "DisplayObjectContainer.js.html#sunlight-1-line-302" > line 302< / a >
< / 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 -
< a href = "DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "DisplayObjectContainer.js.html#sunlight-1-line-193" > line 193< / a >
< / 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 -
< a href = "DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "DisplayObjectContainer.js.html#sunlight-1-line-158" > line 158< / a >
< / 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="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-11-15 20:01:46 +00:00
< p > Call this function to retrieve the first object with alive === true in the group.
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" >
< 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 -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1548" > line 1548< / 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="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-11-15 20:01:46 +00:00
< p > Call this function to retrieve the first object with alive === false in the group.
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" >
< span class = "param-type" > Any< / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The first dead child, or null if none found.< / p >
< / div >
< / div >
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 -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1561" > line 1561< / 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 "
id="getFirstExists">< span class = "type-signature" > < / span > getFirstExists< span class = "signature" > (state)< / 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-11-15 20:01:46 +00:00
< p > Call this function to retrieve the first object with exists == (the given state) in the Group.< / 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 >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > state< / 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-11-15 20:01:46 +00:00
< td class = "description last" > < p > True or false.< / 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" >
< 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 -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1530" > line 1530< / 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 "
id="getIndex">< span class = "type-signature" > < / span > getIndex< 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 > Get the index position of the given child in this Group. This should always match the childs z 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-11-15 20:01:46 +00:00
< span class = "param-type" > *< / 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-04-10 22:13:43 +00:00
< span class = "param-type" > number< / span >
2014-11-15 20:01:46 +00:00
-
< / div >
< div class = "returns-desc param-desc" >
< p > The index of the child or -1 if it's not a member of this Group.< / p >
< / div >
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 -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-613" > line 613< / a >
< / 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="getLocalBounds">< span class = "type-signature" > < / span > getLocalBounds< span class = "signature" > ()< / span > < span class = "type-signature" > → {< a href = "PIXI.Rectangle.html" > PIXI.Rectangle< / a > }< / span > < / h4 >
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" >
< span class = "param-type" > < a href = "PIXI.Rectangle.html" > PIXI.Rectangle< / a > < / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The rectangular bounding area< / p >
< / div >
< / div >
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 -
< a href = "DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "DisplayObjectContainer.js.html#sunlight-1-line-362" > line 362< / a >
< / 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="getRandom">< span class = "type-signature" > < / span > getRandom< span class = "signature" > (startIndex, length)< / 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-11-15 20:01:46 +00:00
< p > Returns a member at random 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 >
< 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-11-15 20:01:46 +00:00
< span class = "param-type" > number< / span >
2013-10-02 19:18:24 +00:00
< / td >
2013-11-07 06:10:15 +00:00
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > Optional offset off the front of the array. Default value is 0, or the beginning of the array.< / 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-03-14 06:36:05 +00:00
< span class = "param-type" > number< / span >
2013-10-02 19:18:24 +00:00
< / td >
2013-11-07 06:10:15 +00:00
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > Optional 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" >
< 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 -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1628" > line 1628< / 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 "
id="getTop">< span class = "type-signature" > < / span > getTop< span class = "signature" > ()< / span > < span class = "type-signature" > → {Any}< / span > < / h4 >
< / dt >
< dd >
2013-11-07 06:10:15 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Returns the child at the top of this Group. The top is the one being displayed (rendered) above every other child.< / p >
< / 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" >
< 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 -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1574" > line 1574< / 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-11-15 20:01:46 +00:00
< p > Checks if the child has the given property. 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-04-10 22:13:43 +00:00
< span class = "param-type" > *< / 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" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > array< / 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 -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-662" > line 662< / a >
< / 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 "
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 > < 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-11-15 20:01:46 +00:00
< p > Iterates over the children of the Group. When a child has a property matching key that equals the given value, it is considered as a match.
Matched children can be sent to the optional callback, or simply returned or counted.
You can add as many callback parameters as you like, which will all be passed to the callback along with the child, after the callbackContext parameter.< / 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-11-15 20:01:46 +00:00
< td class = "description last" > < p > If child.key === this value it will be considered a match. Note that a strict comparison is used.< / 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-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 = "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-11-15 20:01:46 +00:00
< td class = "description last" > < p > How to return the data from this method. Either Phaser.Group.RETURN_NONE, Phaser.Group.RETURN_TOTAL or Phaser.Group.RETURN_CHILD.< / 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 >
< td class = "description last" > < p > Optional function that will be called on each matching child. Each child of the Group will be passed to it as its first parameter.< / 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" >
< 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
< / 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" >
< p > Returns either a numeric total (if RETURN_TOTAL was specified) or the child object.< / p >
< / 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 -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1472" > line 1472< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-350" > line 350< / a >
< / 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 >
< / 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.< / 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" >
< dt class = "tag-source" > Source -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-283" > line 283< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="mousedown">< span class = "type-signature" > < / span > mousedown< span class = "signature" > (interactionData)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > A callback that is used when the user clicks the mouse's left button down over the sprite< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > interactionData< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "PIXI.InteractionData.html" > PIXI.InteractionData< / a > < / span >
< / td >
< td class = "description last" > < p > -< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#mousedown" > PIXI.DisplayObject#mousedown< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-258" > line 258< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="mouseout">< span class = "type-signature" > < / span > mouseout< span class = "signature" > (interactionData)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > A callback that is used when the users mouse leaves the displayObject< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > interactionData< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "PIXI.InteractionData.html" > PIXI.InteractionData< / a > < / span >
< / td >
< td class = "description last" > < p > -< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#mouseout" > PIXI.DisplayObject#mouseout< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-245" > line 245< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="mouseover">< span class = "type-signature" > < / span > mouseover< span class = "signature" > (interactionData)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > A callback that is used when the users mouse rolls over the displayObject< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > interactionData< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "PIXI.InteractionData.html" > PIXI.InteractionData< / a > < / span >
< / td >
< td class = "description last" > < p > -< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#mouseover" > PIXI.DisplayObject#mouseover< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-239" > line 239< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="mouseup">< span class = "type-signature" > < / span > mouseup< span class = "signature" > (interactionData)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > A callback that is used when the user releases the mouse's left button that was over the displayObject
for this callback to be fired, the mouse's left button must have been pressed down over the displayObject< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > interactionData< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "PIXI.InteractionData.html" > PIXI.InteractionData< / a > < / span >
< / td >
< td class = "description last" > < p > -< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#mouseup" > PIXI.DisplayObject#mouseup< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-264" > line 264< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="mouseupoutside">< span class = "type-signature" > < / span > mouseupoutside< span class = "signature" > (interactionData)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject
for this callback to be fired, the mouse's left button must have been pressed down over the displayObject< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > interactionData< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "PIXI.InteractionData.html" > PIXI.InteractionData< / a > < / span >
< / td >
< td class = "description last" > < p > -< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#mouseupoutside" > PIXI.DisplayObject#mouseupoutside< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-271" > line 271< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="moveDown">< span class = "type-signature" > < / span > moveDown< span class = "signature" > (child)< / span > < span class = "type-signature" > → {*}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Moves the given child down one place in this Group unless it's already at the top.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > child< / code > < / td >
< td class = "type" >
< span class = "param-type" > *< / span >
< / td >
< td class = "description last" > < p > The child to move down in the Group.< / p > < / td >
< / tr >
< / tbody >
< / table >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > *< / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The child that was moved.< / 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#moveDown" > Phaser.Group#moveDown< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-555" > line 555< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="moveUp">< span class = "type-signature" > < / span > moveUp< span class = "signature" > (child)< / span > < span class = "type-signature" > → {*}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Moves the given child up one place in this Group unless it's already at the top.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > child< / code > < / td >
< td class = "type" >
< span class = "param-type" > *< / span >
< / td >
< td class = "description last" > < p > The child to move up in the Group.< / p > < / td >
< / tr >
< / tbody >
< / table >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > *< / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The child that was moved.< / 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#moveUp" > Phaser.Group#moveUp< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-531" > line 531< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="multiplyAll">< span class = "type-signature" > < / span > multiplyAll< span class = "signature" > (property, amount, checkAlive, checkVisible)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Multiplies the given property by the amount on all children in this Group.
Group.multiplyAll('x', 2) will x2 the child.x value.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > property< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < p > The property to multiply, for example 'body.velocity.x' or 'angle'.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > amount< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The amount to multiply the property by. If child.x = 10 then multiplyAll('x', 2) would make child.x = 20.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > checkAlive< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > < p > If true the property will only be changed if the child is alive.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > checkVisible< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > < p > If true the property will only be changed if the child is visible.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#multiplyAll" > Phaser.Group#multiplyAll< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-969" > line 969< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="next">< span class = "type-signature" > < / span > next< span class = "signature" > ()< / span > < span class = "type-signature" > → {*}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Advances the Group cursor to the next object in the Group. If it's at the end of the Group it wraps around to the first object.< / p >
< / div >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > *< / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The child the cursor now points to.< / 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#next" > Phaser.Group#next< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-424" > line 424< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="postUpdate">< span class = "type-signature" > < internal> < / span > postUpdate< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The core postUpdate - as called by World.< / p >
< / div >
< dl class = "details" >
< dt class = "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 >
< dt class = "important tag-deprecated" > Internal:< / dt >
< dd class = "tag-deprecated" > < ul >
< li > This member is < em > internal (protected)< / em > and may be modified or removed in the future.< / li >
< / ul > < / dd >
< dt class = "tag-source" > Source -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1188" > line 1188< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="preUpdate">< span class = "type-signature" > < internal> < / span > preUpdate< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The core preUpdate - as called by World.< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#preUpdate" > Phaser.Group#preUpdate< / a >
< / li > < / dd >
< dt class = "important tag-deprecated" > Internal:< / dt >
< dd class = "tag-deprecated" > < ul >
< li > This member is < em > internal (protected)< / em > and may be modified or removed in the future.< / li >
< / ul > < / dd >
< dt class = "tag-source" > Source -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1148" > line 1148< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="previous">< span class = "type-signature" > < / span > previous< span class = "signature" > ()< / span > < span class = "type-signature" > → {*}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Moves the Group cursor to the previous object in the Group. If it's at the start of the Group it wraps around to the last object.< / p >
< / div >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > *< / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The child the cursor now points to.< / 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#previous" > Phaser.Group#previous< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-451" > line 451< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="remove">< span class = "type-signature" > < / span > remove< span class = "signature" > (child, < span class = "optional" > destroy< / span > , < span class = "optional" > silent< / span > )< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Removes the given child from this Group. This will dispatch an onRemovedFromGroup event from the child (if it has one),
reset the Group cursor and optionally destroy the child.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > child< / code > < / td >
< td class = "type" >
< span class = "param-type" > Any< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > The child to 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 > You can optionally call destroy on the child that was removed.< / 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 the silent parameter is < code > true< / code > the child will not dispatch the onRemovedFromGroup event.< / p > < / td >
< / tr >
< / tbody >
< / table >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > boolean< / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > true if the child was removed from this Group, otherwise false.< / p >
< / div >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#remove" > Phaser.Group#remove< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1650" > line 1650< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="removeAll">< span class = "type-signature" > < / span > removeAll< span class = "signature" > (< span class = "optional" > destroy< / span > , < span class = "optional" > silent< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Removes all children from this Group, setting the < code > parent< / code > property of the children to < code > null< / code > .
The Group container remains on the display list.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > destroy< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
false
< / td >
< td class = "description last" > < p > You can optionally call destroy on each child that is removed.< / 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 the silent parameter is < code > true< / code > the children will not dispatch their onRemovedFromGroup events.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#removeAll" > Phaser.Group#removeAll< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1693" > line 1693< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="removeBetween">< span class = "type-signature" > < / span > removeBetween< span class = "signature" > (startIndex, < span class = "optional" > endIndex< / span > , < span class = "optional" > destroy< / span > , < span class = "optional" > silent< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Removes all children from this Group whos index falls beteen the given startIndex and endIndex values.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > startIndex< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > The index to start removing children from.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > endIndex< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / 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 > You can optionally call destroy on the child that was removed.< / 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 the silent parameter is < code > true< / code > the children will not dispatch their onRemovedFromGroup events.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#removeBetween" > Phaser.Group#removeBetween< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1731" > line 1731< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="removeChild">< span class = "type-signature" > < / span > removeChild< span class = "signature" > (child)< / span > < span class = "type-signature" > → {< a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Removes a child from the container.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > child< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
< / td >
< td class = "description last" > < p > The DisplayObject to remove< / p > < / td >
< / tr >
< / tbody >
< / table >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The child that was removed.< / p >
< / div >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObjectContainer.html#removeChild" > PIXI.DisplayObjectContainer#removeChild< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "DisplayObjectContainer.js.html#sunlight-1-line-210" > line 210< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="removeChildAt">< span class = "type-signature" > < / span > removeChildAt< span class = "signature" > (index)< / span > < span class = "type-signature" > → {< a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > }< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Removes a child from the specified index position.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > index< / code > < / td >
< td class = "type" >
< span class = "param-type" > Number< / span >
< / td >
< td class = "description last" > < p > The index to get the child from< / p > < / td >
< / tr >
< / tbody >
< / table >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > < a href = "PIXI.DisplayObject.html" > PIXI.DisplayObject< / a > < / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The child that was removed.< / p >
< / div >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObjectContainer.html#removeChildAt" > PIXI.DisplayObjectContainer#removeChildAt< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "DisplayObjectContainer.js.html#sunlight-1-line-225" > line 225< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="removeChildren">< span class = "type-signature" > < / span > removeChildren< span class = "signature" > (beginIndex, endIndex)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Removes all children from this container that are within the begin and end indexes.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > beginIndex< / code > < / td >
< td class = "type" >
< span class = "param-type" > Number< / span >
< / td >
< td class = "description last" > < p > The beginning position. Default value is 0.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > endIndex< / code > < / td >
< td class = "type" >
< span class = "param-type" > Number< / span >
< / td >
< td class = "description last" > < p > The ending position. Default value is size of the container.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObjectContainer.html#removeChildren" > PIXI.DisplayObjectContainer#removeChildren< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "DisplayObjectContainer.js.html#sunlight-1-line-243" > line 243< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="removeStageReference">< span class = "type-signature" > < / span > removeStageReference< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Removes the current stage reference from the container and all of its children.< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObjectContainer.html#removeStageReference" > PIXI.DisplayObjectContainer#removeStageReference< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "DisplayObjectContainer.js.html#sunlight-1-line-404" > line 404< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="replace">< span class = "type-signature" > < / span > replace< span class = "signature" > (oldChild, newChild)< / span > < span class = "type-signature" > → {*}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Replaces a child of this Group with the given newChild. The newChild cannot be a member of this Group.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > oldChild< / code > < / td >
< td class = "type" >
< span class = "param-type" > *< / span >
< / td >
< td class = "description last" > < p > The child in this Group that will be replaced.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > newChild< / code > < / td >
< td class = "type" >
< span class = "param-type" > *< / span >
< / td >
< td class = "description last" > < p > The child to be inserted into this Group.< / p > < / td >
< / tr >
< / tbody >
< / table >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > *< / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > Returns the oldChild that was replaced within this Group.< / p >
< / div >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#replace" > Phaser.Group#replace< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-626" > line 626< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="resetCursor">< span class = "type-signature" > < / span > resetCursor< span class = "signature" > (< span class = "optional" > index< / span > )< / span > < span class = "type-signature" > → {*}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Sets the Group cursor to the first object in the Group. If the optional index parameter is given it sets the cursor to the object at that index instead.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > index< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
0
< / td >
< td class = "description last" > < p > Set the cursor to point to a specific index.< / p > < / td >
< / tr >
< / tbody >
< / table >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > *< / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The child the cursor now points to.< / 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#resetCursor" > Phaser.Group#resetCursor< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-399" > line 399< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="reverse">< span class = "type-signature" > < / span > reverse< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Reverses all children in this Group. Note that this does not propagate, only direct children are re-ordered.< / 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#reverse" > Phaser.Group#reverse< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-601" > line 601< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="revive">< span class = "type-signature" > < / span > revive< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Handy for bringing game objects " back to life" . Just sets alive and exists back to true.< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-363" > line 363< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="rightclick">< span class = "type-signature" > < / span > rightclick< span class = "signature" > (interactionData)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > A callback that is used when the users clicks on the displayObject with their mouse's right button< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > interactionData< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "PIXI.InteractionData.html" > PIXI.InteractionData< / a > < / span >
< / td >
< td class = "description last" > < p > -< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#rightclick" > PIXI.DisplayObject#rightclick< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-279" > line 279< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="rightdown">< span class = "type-signature" > < / span > rightdown< span class = "signature" > (interactionData)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > A callback that is used when the user clicks the mouse's right button down over the sprite< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > interactionData< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "PIXI.InteractionData.html" > PIXI.InteractionData< / a > < / span >
< / td >
< td class = "description last" > < p > -< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#rightdown" > PIXI.DisplayObject#rightdown< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-285" > line 285< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="rightup">< span class = "type-signature" > < / span > rightup< span class = "signature" > (interactionData)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > A callback that is used when the user releases the mouse's right button that was over the displayObject
for this callback to be fired the mouse's right button must have been pressed down over the displayObject< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > interactionData< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "PIXI.InteractionData.html" > PIXI.InteractionData< / a > < / span >
< / td >
< td class = "description last" > < p > -< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#rightup" > PIXI.DisplayObject#rightup< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-291" > line 291< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="rightupoutside">< span class = "type-signature" > < / span > rightupoutside< span class = "signature" > (interactionData)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject
for this callback to be fired, the mouse's right button must have been pressed down over the displayObject< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > interactionData< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "PIXI.InteractionData.html" > PIXI.InteractionData< / a > < / span >
< / td >
< td class = "description last" > < p > -< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#rightupoutside" > PIXI.DisplayObject#rightupoutside< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-298" > line 298< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="sendToBack">< span class = "type-signature" > < / span > sendToBack< span class = "signature" > (child)< / span > < span class = "type-signature" > → {*}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Sends the given child to the bottom of this Group so it renders below all other children.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > child< / code > < / td >
< td class = "type" >
< span class = "param-type" > *< / span >
< / td >
< td class = "description last" > < p > The child to send to the bottom of this Group.< / p > < / td >
< / tr >
< / tbody >
< / table >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > *< / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > The child that was moved.< / 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#sendToBack" > Phaser.Group#sendToBack< / a >
< / li > < / dd >
< dt class = "tag-source" > Source -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-512" > line 512< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="set">< span class = "type-signature" > < / span > set< span class = "signature" > (child, key, value, < span class = "optional" > checkAlive< / span > , < span class = "optional" > checkVisible< / span > , < span class = "optional" > operation< / span > , < span class = "optional" > force< / span > )< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > This function allows you to quickly set a property on a single child of this Group to a new value.
The operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > child< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Sprite.html" > Phaser.Sprite< / a > < / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > The child to set the property on.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > key< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > The property, as a string, to be set. For example: 'body.velocity.x'< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > value< / code > < / td >
< td class = "type" >
< span class = "param-type" > *< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > The value that will be set.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > checkAlive< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
false
< / td >
< td class = "description last" > < p > If set then the child will only be updated if alive=true.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > checkVisible< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
false
< / td >
< td class = "description last" > < p > If set then the child will only be updated if visible=true.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > operation< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
0
< / td >
< td class = "description last" > < p > Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > force< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
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-11-01 18:16:52 +00:00
2014-11-15 20:01:46 +00:00
< / td >
2013-11-01 18:16:52 +00:00
2014-11-15 20:01:46 +00:00
< td class = "default" >
false
< / td >
2013-11-01 18:16:52 +00:00
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 >
< / 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" >
< span class = "param-type" > boolean< / span >
-
< / div >
2013-11-01 18:16:52 +00:00
2014-11-15 20:01:46 +00:00
< div class = "returns-desc param-desc" >
< p > True if the property was set, false if not.< / 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-11-15 20:01:46 +00:00
< a href = "Phaser.Group.html#set" > Phaser.Group#set< / a >
2013-11-01 18:16:52 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-800" > line 800< / a >
< / 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 "
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 >
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-11-15 20:01:46 +00:00
< p > This function allows you to quickly set the same property across all children of this Group to a new value.
This call doesn't descend down children, so if you have a Group inside of this Group, the property will be set on the Group but not its children.
If you need that ability please see < code > Group.setAllChildren< / code > .< / p >
< p > The operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.< / p >
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 >
< 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-11-15 20:01:46 +00:00
< span class = "param-type" > *< / 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-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-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-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 >
< / 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-11-15 20:01:46 +00:00
< span class = "param-type" > number< / 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-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-11-15 20:01:46 +00:00
< a href = "Phaser.Group.html#setAll" > Phaser.Group#setAll< / a >
2014-02-18 03:01:51 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-830" > line 830< / a >
< / 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 "
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-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 > This function allows you to 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 Group.setAll 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-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-11-15 20:01:46 +00:00
< span class = "param-type" > *< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > The value that will be set.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > checkAlive< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
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" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
0
< / td >
< td class = "description last" > < p > Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > force< / code > < / td >
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-11-15 20:01:46 +00:00
< a href = "Phaser.Group.html#setAllChildren" > Phaser.Group#setAllChildren< / a >
2013-11-01 18:16:52 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-864" > line 864< / a >
< / 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="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 >
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 > 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 >
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-11-15 20:01:46 +00:00
< td class = "name" > < code > min< / 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" > number< / span >
2013-10-02 19:18:24 +00:00
< / td >
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
< / td >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< td class = "default" >
1
< / td >
< td class = "description last" > < p > The minimum value for this range.< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > max< / 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 = "attributes" >
< optional>< br >
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" >
1
< / td >
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The maximum value for this range.< / p > < / td >
< / tr >
2014-04-29 14:39:02 +00:00
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > rate< / code > < / td >
2014-04-29 14:39:02 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
0
< / td >
2014-11-15 20:01:46 +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-29 14:39:02 +00:00
< / tr >
2014-11-15 20:01:46 +00:00
< tr >
< td class = "name" > < code > ease< / code > < / td >
2014-04-29 14:39:02 +00:00
2014-11-15 20:01:46 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
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" >
Phaser.Easing.Linear.None
< / td >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +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 >
< / 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 > yoyo< / 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" > 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-11-15 20:01:46 +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 >
< / 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
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-594" > line 594< / a >
< / 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="setChildIndex">< span class = "type-signature" > < / span > setChildIndex< span class = "signature" > (child, index)< / 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 > Changes the position of an existing child in the display object 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-04-10 22:13:43 +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 child DisplayObject instance for which you want to change the index number< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
2014-11-15 20:01:46 +00:00
< tr >
< td class = "name" > < code > index< / 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 resulting index number for the child display object< / p > < / td >
< / 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 >
< a href = "PIXI.DisplayObjectContainer.html#setChildIndex" > PIXI.DisplayObjectContainer#setChildIndex< / a >
< / 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 -
< a href = "DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "DisplayObjectContainer.js.html#sunlight-1-line-175" > line 175< / a >
< / dt >
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
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 "
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-11-15 20:01:46 +00:00
< p > Sets a property to the given value on the child. The operation parameter controls how the value is set.
Operation 0 means set the existing value to the given value, or if force is < code > false< / code > create a new property with the given value.
1 will add the given value to the value already present.
2 will subtract the given value from the value already present.
3 will multiply the value already present by the given value.
4 will divide the value already present by the given value.< / 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 >
< td class = "name" > < code > child< / code > < / td >
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > *< / span >
2014-04-10 22:13:43 +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 child to set the property value on.< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
< tr >
< td class = "name" > < code > key< / code > < / td >
< td class = "type" >
2014-11-15 20:01:46 +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-11-15 20:01:46 +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 >
< td class = "name" > < code > value< / code > < / td >
< td class = "type" >
< span class = "param-type" > *< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > The value that will be set.< / p > < / td >
< / tr >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > operation< / 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 >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
2014-11-15 20:01:46 +00:00
0
2014-04-10 22:13:43 +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-04-10 22:13:43 +00:00
< / tr >
< tr >
2014-11-15 20:01:46 +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" >
false
< / td >
2014-03-14 06:36:05 +00:00
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-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 >
< h5 > Returns:< / h5 >
< div class = "returns" >
< div class = "returns-type" >
< span class = "param-type" > boolean< / span >
-
< / div >
< div class = "returns-desc param-desc" >
< p > True if the property was set, false if not.< / p >
< / div >
< / div >
< dl class = "details" >
< dt class = "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 >
< dt class = "tag-source" > Source -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-695" > line 695< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
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 >
< / dt >
< dd >
< div class = "description" >
< p > A more compact way of setting the angular velocity constraints of the particles.< / 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 >
2014-03-14 06:36:05 +00:00
2014-04-10 22:13:43 +00:00
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > min< / 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" >
< span class = "param-type" > number< / 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
< td class = "attributes" >
< optional>< br >
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 >
2013-10-02 19:18:24 +00:00
2014-04-10 22:13:43 +00:00
< td class = "default" >
0
< / td >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +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
2014-04-10 22:13:43 +00:00
2014-05-20 09:12:48 +00:00
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > max< / 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 >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
2014-11-15 20:01:46 +00:00
0
2014-05-20 09:12:48 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The maximum value for this range.< / 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-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-577" > line 577< / a >
< / dt >
2014-03-14 06:36:05 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="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-03-14 06:36:05 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > 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-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-11-15 20:01:46 +00:00
< td class = "name" > < code > minX< / 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 >
< td class = "attributes" >
2014-11-15 20:01:46 +00:00
< optional>< br >
2014-04-10 22:13:43 +00:00
< / td >
< td class = "default" >
2014-11-15 20:01:46 +00:00
1
2014-04-10 22:13:43 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The minimum value of Particle.scale.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 > maxX< / code > < / td >
2014-03-14 06:36:05 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > number< / span >
< / td >
< 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 >
2014-03-14 06:36:05 +00:00
< / td >
2014-04-10 22:13:43 +00:00
< td class = "attributes" >
2014-11-15 20:01:46 +00:00
< optional>< br >
2014-04-10 22:13:43 +00:00
< / td >
< td class = "default" >
2014-11-15 20:01:46 +00:00
1
2014-04-10 22:13:43 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The minimum value of Particle.scale.y.< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > maxY< / 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 >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
2014-11-15 20:01:46 +00:00
1
2014-04-10 22:13:43 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The maximum value of Particle.scale.y.< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > rate< / 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 >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
2014-11-15 20:01:46 +00:00
0
2014-04-10 22:13:43 +00:00
< / td >
2014-11-15 20:01:46 +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 >
2014-04-10 22:13:43 +00:00
< / tr >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > ease< / code > < / td >
2014-04-10 22:13:43 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / 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-11-15 20:01:46 +00:00
Phaser.Easing.Linear.None
2014-04-10 22:13:43 +00:00
< / td >
2014-03-14 06:36:05 +00:00
2014-11-15 20:01:46 +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-03-14 06:36:05 +00:00
< / tr >
2014-05-20 09:12:48 +00:00
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > yoyo< / 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-11-15 20:01:46 +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-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-03-14 06:36:05 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-633" > line 633< / a >
< / 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 "
id="setSize">< span class = "type-signature" > < / span > setSize< span class = "signature" > (width, height)< / 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-11-15 20:01:46 +00:00
< p > A more compact way of setting the width and height of the emitter.< / 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 >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > width< / 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-11-15 20:01:46 +00:00
< td class = "description last" > < p > The desired width of the emitter (particles are spawned randomly within these dimensions).< / p > < / td >
2014-02-05 06:29:17 +00:00
< / tr >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > height< / 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-11-15 20:01:46 +00:00
< td class = "description last" > < p > The desired height of the emitter.< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-531" > line 531< / a >
< / 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 "
id="setStageReference">< span class = "type-signature" > < / span > setStageReference< span class = "signature" > (stage)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
2014-02-05 06:29:17 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.< / p >
< / div >
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-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
< 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-11-15 20:01:46 +00:00
< td class = "name" > < code > stage< / 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" > < a href = "PIXI.Stage.html" > PIXI.Stage< / a > < / span >
2014-05-20 09:12:48 +00:00
< / td >
2014-11-15 20:01:46 +00:00
2014-05-20 09:12:48 +00:00
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > the stage that the container will have as its current stage reference< / p > < / td >
2014-05-20 09:12:48 +00:00
< / tr >
2014-02-05 06:29:17 +00:00
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
2013-10-02 19:18:24 +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 >
2014-11-15 20:01:46 +00:00
< a href = "PIXI.DisplayObjectContainer.html#setStageReference" > PIXI.DisplayObjectContainer#setStageReference< / a >
2014-02-05 06:29:17 +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 -
< a href = "DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "DisplayObjectContainer.js.html#sunlight-1-line-386" > line 386< / a >
< / 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="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-11-15 20:01:46 +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-04-10 22:13:43 +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-04-10 22:13:43 +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-04-10 22:13:43 +00:00
< td class = "name" > < code > max< / 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-04-10 22:13:43 +00:00
0
2013-10-02 19:18:24 +00:00
< / td >
2014-11-15 20:01:46 +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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-545" > line 545< / a >
< / dt >
2014-03-24 12:41:45 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="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-03-24 12:41:45 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > A more compact way of setting the Y velocity range 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 >
< th > Argument< / th >
< th > Default< / 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-11-15 20:01:46 +00:00
< td class = "name" > < code > min< / code > < / td >
2014-04-10 22:13:43 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
0
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The minimum value for this range.< / p > < / td >
2014-04-10 22:13:43 +00:00
< / tr >
2014-05-20 09:12:48 +00:00
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > max< / 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 >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
2014-11-15 20:01:46 +00:00
0
2014-05-20 09:12:48 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The maximum value for this range.< / 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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-561" > line 561< / a >
< / 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 "
id="sort">< span class = "type-signature" > < / span > sort< span class = "signature" > (< span class = "optional" > index< / span > , < span class = "optional" > order< / 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-11-15 20:01:46 +00:00
< p > Call this function to sort the group according to a particular 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 >
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
< th > Argument< / th >
2014-03-24 12:41:45 +00:00
2014-04-10 22:13:43 +00:00
< th > Default< / th >
< 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-11-15 20:01:46 +00:00
< td class = "name" > < code > index< / 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" > string< / span >
2014-03-24 12:41:45 +00:00
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
2014-11-15 20:01:46 +00:00
'z'
2014-03-24 12:41:45 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The < code > string< / code > name of the property you want to sort on. Defaults to the objects z-depth value.< / p > < / td >
2014-03-24 12:41:45 +00:00
< / tr >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > order< / code > < / td >
2014-03-24 12:41:45 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
2014-11-15 20:01:46 +00:00
Phaser.Group.SORT_ASCENDING
2014-03-24 12:41:45 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The < code > Group< / code > constant that defines the sort order. Possible values are Phaser.Group.SORT_ASCENDING and Phaser.Group.SORT_DESCENDING.< / p > < / td >
2014-03-24 12:41:45 +00:00
< / tr >
< / tbody >
< / table >
2014-11-15 20:01:46 +00:00
2014-03-24 12:41:45 +00:00
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#sort" > Phaser.Group#sort< / a >
< / li > < / dd >
2014-03-24 12:41:45 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2014-11-25 00:23:44 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1361" > line 1361< / 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="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-11-15 20:01:46 +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 >
< th > Argument< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > explode< / 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 > Whether the particles should all burst out at once (true) or at the frequency given (false).< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > lifespan< / 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-11-15 20:01:46 +00:00
< td class = "description last" > < p > How long each particle lives once emitted in ms. 0 = forever.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > frequency< / 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
250
2014-04-10 22:13:43 +00:00
2013-10-02 19:18:24 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< / tr >
< tr >
2014-11-15 20:01:46 +00:00
< 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. 0 = " all of the particles" .< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > forceQuantity< / 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
2014-11-15 20:01:46 +00:00
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
false
< / td >
< td class = "description last" > < p > If true and creating a particle flow, the quantity emitted will be forced to the be quantity given in this call.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-402" > line 402< / a >
< / dt >
< / dl >
< / dd >
< dt >
< h4 class = "name "
id="subAll">< span class = "type-signature" > < / span > subAll< span class = "signature" > (property, amount, checkAlive, checkVisible)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Subtracts the amount from the given property on all children in this Group.
Group.subAll('x', 10) will minus 10 from the child.x value.< / p >
< / 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
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
< 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-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 decrement, 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 >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > amount< / code > < / td >
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 = "type" >
< span class = "param-type" > number< / 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-11-15 20:01:46 +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 >
2014-04-10 22:13:43 +00:00
< / tr >
2013-10-02 19:18:24 +00:00
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > checkAlive< / 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 alive.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< 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-04-10 22:13:43 +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
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#subAll" > Phaser.Group#subAll< / a >
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-953" > line 953< / a >
< / 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="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-11-15 20:01:46 +00:00
< p > Swaps the position of two children in this Group. Both children must be in this Group.
You cannot swap a child with itself, or swap un-parented children.< / 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 > child1< / 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" > *< / 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 child to swap.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > child2< / 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" > *< / 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 child to swap.< / 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 >
< a href = "Phaser.Group.html#swap" > Phaser.Group#swap< / a >
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-478" > line 478< / a >
< / 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="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-11-15 20:01:46 +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-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 > -< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > child2< / 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 > -< / 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 >
< a href = "PIXI.DisplayObjectContainer.html#swapChildren" > PIXI.DisplayObjectContainer#swapChildren< / a >
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "DisplayObjectContainer.js.html" > pixi/display/DisplayObjectContainer.js< / a > , < a href = "DisplayObjectContainer.js.html#sunlight-1-line-133" > line 133< / a >
< / dt >
2013-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="tap">< span class = "type-signature" > < / span > tap< span class = "signature" > (interactionData)< / 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 > A callback that is used when the users taps on the sprite with their finger
basically a touch version of click< / 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-11-15 20:01:46 +00:00
< td class = "name" > < code > interactionData< / 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.InteractionData.html" > PIXI.InteractionData< / 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 >
< / 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 >
< a href = "PIXI.DisplayObject.html#tap" > PIXI.DisplayObject#tap< / a >
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-309" > line 309< / a >
< / dt >
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
2013-11-07 06:10:15 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="toGlobal">< span class = "type-signature" > < / span > toGlobal< span class = "signature" > (position)< / span > < span class = "type-signature" > → {< a href = "PIXI.Point.html" > PIXI.Point< / a > }< / span > < / h4 >
2013-11-07 06:10:15 +00:00
< / dt >
< dd >
2014-11-15 20:01:46 +00:00
2013-11-07 06:10:15 +00:00
< div class = "description" >
2014-11-15 20:01:46 +00:00
< p > Calculates the global position of the display object< / p >
2013-11-07 06:10:15 +00:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > position< / code > < / td >
2013-11-07 06:10:15 +00:00
< td class = "type" >
2014-11-15 20:01:46 +00:00
< span class = "param-type" > < a href = "PIXI.Point.html" > PIXI.Point< / a > < / span >
2013-11-07 06:10:15 +00:00
< / td >
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The world origin to calculate 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" >
< span class = "param-type" > < a href = "PIXI.Point.html" > PIXI.Point< / a > < / 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 > A point object representing the position of this object< / p >
< / div >
2013-11-07 06:10:15 +00:00
2014-11-15 20:01:46 +00:00
< / div >
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-11-15 20:01:46 +00:00
< a href = "PIXI.DisplayObject.html#toGlobal" > PIXI.DisplayObject#toGlobal< / a >
2013-11-07 06:10:15 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2014-11-25 00:23:44 +00:00
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-616" > line 616< / 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 "
id="toLocal">< span class = "type-signature" > < / span > toLocal< span class = "signature" > (position, < span class = "optional" > from< / span > )< / span > < span class = "type-signature" > → {< a href = "PIXI.Point.html" > PIXI.Point< / a > }< / span > < / h4 >
2013-10-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 > 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-02-05 06:29:17 +00:00
< th > Argument< / 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 > position< / 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.Point.html" > PIXI.Point< / a > < / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-02-05 06:29:17 +00:00
< td class = "attributes" >
< / td >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The world origin to calculate from< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< tr >
2014-11-15 20:01:46 +00:00
< td class = "name" > < code > from< / 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-02-05 06:29:17 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< td class = "description last" > < p > The DisplayObject to calculate the global position from< / p > < / td >
2013-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
< h5 > Returns:< / h5 >
< div class = "returns" >
2014-07-10 19:31:11 +00:00
2014-11-15 20:01:46 +00:00
< div class = "returns-type" >
< span class = "param-type" > < a href = "PIXI.Point.html" > PIXI.Point< / a > < / span >
2014-07-10 19:31:11 +00:00
2014-11-15 20:01:46 +00:00
-
< / div >
< div class = "returns-desc param-desc" >
< p > A point object representing the position of this object< / p >
< / div >
2014-07-10 19:31:11 +00:00
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
< dl class = "details" >
2014-11-15 20:01:46 +00:00
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "PIXI.DisplayObject.html#toLocal" > PIXI.DisplayObject#toLocal< / a >
< / li > < / dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
2014-11-25 00:23:44 +00:00
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-630" > line 630< / 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="touchend">< span class = "type-signature" > < / span > touchend< span class = "signature" > (interactionData)< / 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 > A callback that is used when the user releases a touch over the displayObject< / 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 > interactionData< / 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.InteractionData.html" > PIXI.InteractionData< / 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 >
< a href = "PIXI.DisplayObject.html#touchend" > PIXI.DisplayObject#touchend< / 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-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-322" > line 322< / a >
< / dt >
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 "
id="touchendoutside">< span class = "type-signature" > < / span > touchendoutside< span class = "signature" > (interactionData)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
2013-10-02 19:18:24 +00:00
2014-11-15 20:01:46 +00:00
< div class = "description" >
< p > A callback that is used when the user releases the touch that was over the displayObject
for this callback to be fired, The touch must have started over the sprite< / p >
< / 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-11-15 20:01:46 +00:00
< td class = "name" > < code > interactionData< / 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.InteractionData.html" > PIXI.InteractionData< / 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 >
< / 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 = "PIXI.DisplayObject.html#touchendoutside" > PIXI.DisplayObject#touchendoutside< / a >
2013-10-02 19:18:24 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-328" > line 328< / a >
< / dt >
2013-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="touchstart">< span class = "type-signature" > < / span > touchstart< span class = "signature" > (interactionData)< / 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 > A callback that is used when the user touches over the displayObject< / 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 > interactionData< / 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.InteractionData.html" > PIXI.InteractionData< / 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 >
< / 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 = "PIXI.DisplayObject.html#touchstart" > PIXI.DisplayObject#touchstart< / a >
2013-10-02 19:18:24 +00:00
< / li > < / dd >
2014-11-15 20:01:46 +00:00
< dt class = "tag-source" > Source -
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-316" > line 316< / a >
< / dt >
2014-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 -
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-248" > line 248< / a >
< / 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 -
2014-11-25 00:23:44 +00:00
< a href = "DisplayObject.js.html" > pixi/display/DisplayObject.js< / a > , < a href = "DisplayObject.js.html#sunlight-1-line-606" > line 606< / a >
2014-11-15 20:01:46 +00:00
< / dt >
< / 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" >
< p > Internal method that re-applies all of the childrens Z values.< / p >
< / 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 -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-382" > line 382< / a >
< / dt >
2014-03-14 06:36:05 +00:00
< / dl >
2014-11-15 20:01:46 +00:00
2014-03-14 06:36:05 +00:00
< / dd >
< dt >
2014-11-15 20:01:46 +00:00
< h4 class = "name "
id="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" >
< p > Positions the child found at the given index within this Group to the given x and y coordinates.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > index< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The index of the child in the Group to set the position of.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The new x position of the child.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The new y position of the child.< / p > < / td >
< / tr >
< / tbody >
< / table >
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 -
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-579" > line 579< / a >
< / 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" >
2014-02-05 06:29:17 +00:00
Phaser Copyright © 2012-2014 Photon Storm Ltd.
2013-10-02 19:18:24 +00:00
< / span >
< br / >
< span class = "jsdoc-message" >
2014-04-11 12:09:28 +00:00
Documentation generated by < a href = "https://github.com/jsdoc3/jsdoc" > JSDoc 3.3.0-dev< / a >
2014-11-25 00:23:44 +00:00
on Tue Nov 25 2014 00:17:41 GMT-0000 (GMT) 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 >
