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]-->
< link type = "text/css" rel = "stylesheet" href = "styles/sunlight.default.css" >
< link type = "text/css" rel = "stylesheet" href = "styles/site.cerulean.css" >
< / head >
< body >
< div class = "container-fluid" >
< div class = "navbar navbar-fixed-top navbar-inverse" >
< div class = "navbar-inner" >
< a class = "brand" href = "index.html" > Phaser< / a >
< ul class = "nav" >
< li class = "dropdown" >
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 " >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.html" > Phaser< / a >
2013-10-02 19:18:24 +00:00
< / li >
< / ul >
< / li >
< li class = "dropdown" >
< a href = "classes.list.html" class = "dropdown-toggle" data-toggle = "dropdown" > Classes< b
class="caret">< / b > < / a >
< ul class = "dropdown-menu " >
< li >
< a href = "Phaser.Animation.html" > Animation< / a >
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.AnimationManager.html" > AnimationManager< / a >
2013-10-02 19:18:24 +00:00
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.AnimationParser.html" > AnimationParser< / a >
2013-10-02 19:18:24 +00:00
< / li >
2013-11-28 15:57:09 +00:00
< li >
< a href = "Phaser.BitmapData.html" > BitmapData< / a >
< / li >
2014-02-18 03:01:51 +00:00
< li >
< a href = "Phaser.BitmapFont.html" > BitmapFont< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.BitmapText.html" > BitmapText< / a >
< / li >
< li >
< a href = "Phaser.Button.html" > Button< / a >
< / li >
2013-10-02 19:18:24 +00:00
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Cache.html" > Cache< / a >
2013-10-02 19:18:24 +00:00
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Camera.html" > Camera< / a >
2013-10-02 19:18:24 +00:00
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Canvas.html" > Canvas< / a >
2013-10-02 19:18:24 +00:00
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Circle.html" > Circle< / a >
2013-10-02 19:18:24 +00:00
< / li >
2013-10-03 00:21:08 +00:00
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Color.html" > Color< / a >
2013-10-03 00:21:08 +00:00
< / li >
2013-10-02 19:18:24 +00:00
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Device.html" > Device< / a >
2013-10-02 19:18:24 +00:00
< / li >
2013-10-03 00:21:08 +00:00
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.html" > Easing< / a >
< / li >
< li >
< a href = "Phaser.Easing.Back.html" > Back< / a >
< / li >
< li >
< a href = "Phaser.Easing.Bounce.html" > Bounce< / a >
< / li >
< li >
< a href = "Phaser.Easing.Circular.html" > Circular< / a >
< / li >
< li >
< a href = "Phaser.Easing.Cubic.html" > Cubic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Elastic.html" > Elastic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Exponential.html" > Exponential< / a >
< / li >
< li >
< a href = "Phaser.Easing.Linear.html" > Linear< / a >
< / li >
< li >
< a href = "Phaser.Easing.Quadratic.html" > Quadratic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Quartic.html" > Quartic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Quintic.html" > Quintic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Sinusoidal.html" > Sinusoidal< / a >
< / li >
2014-02-18 03:01:51 +00:00
< li >
< a href = "Phaser.Ellipse.html" > Ellipse< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Events.html" > Events< / a >
< / li >
2013-11-28 15:57:09 +00:00
< li >
< a href = "Phaser.Filter.html" > Filter< / a >
< / li >
2013-10-03 01:38:35 +00:00
< li >
< a href = "Phaser.Frame.html" > Frame< / a >
< / li >
< li >
< a href = "Phaser.FrameData.html" > FrameData< / a >
2013-10-03 00:21:08 +00:00
< / li >
2013-10-02 19:18:24 +00:00
< li >
< a href = "Phaser.Game.html" > Game< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.GameObjectFactory.html" > GameObjectFactory< / a >
< / li >
2014-02-05 06:29:17 +00:00
< li >
< a href = "Phaser.Gamepad.html" > Gamepad< / a >
< / li >
< li >
< a href = "Phaser.GamepadButton.html" > GamepadButton< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Graphics.html" > Graphics< / a >
< / li >
2013-10-02 19:18:24 +00:00
< li >
< a href = "Phaser.Group.html" > Group< / a >
< / li >
2014-02-08 07:24:22 +00:00
< li >
< a href = "Phaser.Image.html" > Image< / a >
< / li >
2013-10-02 19:18:24 +00:00
< li >
< a href = "Phaser.Input.html" > Input< / a >
< / li >
< li >
< a href = "Phaser.InputHandler.html" > InputHandler< / a >
< / li >
< li >
< a href = "Phaser.Key.html" > Key< / a >
< / li >
< li >
< a href = "Phaser.Keyboard.html" > Keyboard< / a >
< / li >
2014-02-05 06:29:17 +00:00
< li >
< a href = "Phaser.Line.html" > Line< / a >
< / li >
2013-10-02 19:18:24 +00:00
< li >
< a href = "Phaser.LinkedList.html" > LinkedList< / a >
< / li >
< li >
< a href = "Phaser.Loader.html" > Loader< / a >
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.LoaderParser.html" > LoaderParser< / a >
2013-10-02 19:18:24 +00:00
< / li >
< li >
< a href = "Phaser.Math.html" > Math< / a >
< / li >
< li >
< a href = "Phaser.Mouse.html" > Mouse< / a >
< / li >
< li >
< a href = "Phaser.MSPointer.html" > MSPointer< / a >
< / li >
< li >
< a href = "Phaser.Net.html" > Net< / a >
< / li >
< li >
< a href = "Phaser.Particles.html" > Particles< / a >
< / li >
< li >
< a href = "Phaser.Particles.Arcade.Emitter.html" > Emitter< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Physics.html" > Physics< / a >
< / li >
< li >
< a href = "Phaser.Physics.Arcade.html" > Arcade< / a >
< / li >
2013-10-02 19:18:24 +00:00
< li >
< a href = "Phaser.Plugin.html" > Plugin< / a >
< / li >
< li >
< a href = "Phaser.PluginManager.html" > PluginManager< / a >
< / li >
< li >
< a href = "Phaser.Point.html" > Point< / a >
< / li >
< li >
< a href = "Phaser.Pointer.html" > Pointer< / a >
< / li >
2013-11-07 06:10:15 +00:00
< li >
< a href = "Phaser.Polygon.html" > Polygon< / a >
< / li >
2013-10-02 19:18:24 +00:00
< li >
< a href = "Phaser.QuadTree.html" > QuadTree< / a >
< / li >
< li >
< a href = "Phaser.RandomDataGenerator.html" > RandomDataGenerator< / a >
< / li >
< li >
< a href = "Phaser.Rectangle.html" > Rectangle< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.RenderTexture.html" > RenderTexture< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.RequestAnimationFrame.html" > RequestAnimationFrame< / a >
< / li >
2013-10-02 19:18:24 +00:00
< li >
< a href = "Phaser.Signal.html" > Signal< / a >
< / li >
2014-02-05 06:29:17 +00:00
< li >
< a href = "Phaser.SinglePad.html" > SinglePad< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.Sound.html" > Sound< / a >
< / li >
< li >
< a href = "Phaser.SoundManager.html" > SoundManager< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Sprite.html" > Sprite< / a >
< / li >
2014-02-18 03:01:51 +00:00
< li >
< a href = "Phaser.SpriteBatch.html" > SpriteBatch< / a >
< / li >
2013-10-02 19:18:24 +00:00
< li >
< a href = "Phaser.Stage.html" > Stage< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.StageScaleMode.html" > StageScaleMode< / a >
< / li >
2013-10-02 19:18:24 +00:00
< li >
< a href = "Phaser.State.html" > State< / a >
< / li >
< li >
< a href = "Phaser.StateManager.html" > StateManager< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Text.html" > Text< / a >
< / li >
2013-11-28 15:57:09 +00:00
< li >
< a href = "Phaser.Tile.html" > Tile< / a >
< / li >
< li >
< a href = "Phaser.Tilemap.html" > Tilemap< / a >
< / li >
< li >
< a href = "Phaser.TilemapLayer.html" > TilemapLayer< / a >
< / li >
< li >
< a href = "Phaser.TilemapParser.html" > TilemapParser< / a >
< / li >
< li >
< a href = "Phaser.Tileset.html" > Tileset< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.TileSprite.html" > TileSprite< / a >
< / li >
2013-10-03 01:38:35 +00:00
< li >
< a href = "Phaser.Time.html" > Time< / a >
< / li >
2013-11-28 15:57:09 +00:00
< li >
< a href = "Phaser.Timer.html" > Timer< / a >
< / li >
2014-02-05 06:29:17 +00:00
< li >
< a href = "Phaser.TimerEvent.html" > TimerEvent< / a >
< / li >
2013-10-02 19:18:24 +00:00
< li >
< a href = "Phaser.Touch.html" > Touch< / a >
< / li >
2013-10-03 01:38:35 +00:00
< li >
< a href = "Phaser.Tween.html" > Tween< / a >
< / li >
< li >
< a href = "Phaser.TweenManager.html" > TweenManager< / a >
< / li >
< li >
< a href = "Phaser.Utils.html" > Utils< / a >
< / li >
< li >
< a href = "Phaser.Utils.Debug.html" > Debug< / a >
< / li >
2013-10-02 19:18:24 +00:00
< li >
< a href = "Phaser.World.html" > World< / a >
< / li >
< li >
< a href = "SignalBinding.html" > SignalBinding< / a >
< / li >
< / ul >
< / li >
2014-02-08 07:24:22 +00:00
< li class = "dropdown" >
< a href = "global.html" class = "dropdown-toggle" data-toggle = "dropdown" > Global< b
class="caret">< / b > < / a >
< ul class = "dropdown-menu " >
< li >
< a href = "global.html#canUseNewCanvasBlendModes" > canUseNewCanvasBlendModes< / a >
< / li >
2014-02-18 03:01:51 +00:00
< li >
< a href = "global.html#getBounds" > getBounds< / a >
< / li >
2014-02-08 07:24:22 +00:00
< li >
< a href = "global.html#getNextPowerOfTwo" > getNextPowerOfTwo< / a >
< / li >
< li >
< a href = "global.html#hex2rgb" > hex2rgb< / a >
< / li >
< li >
< a href = "global.html#hitTest" > hitTest< / a >
< / li >
< li >
< a href = "global.html#rgb2hex" > rgb2hex< / a >
< / li >
< / ul >
< / li >
2013-10-02 19:18:24 +00:00
< / ul >
< / div >
< / div >
< div class = "row-fluid" >
< div class = "span8" >
< div id = "main" >
< h1 class = "page-title" > Class: Emitter< / h1 >
< section >
< header >
< h2 >
Emitter
< / h2 >
< div class = "class-description" > < p > Emitter is a lightweight particle emitter. 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 accorindgly.< / p > < / div >
< / header >
< article >
< div class = "container-overview" >
< dt >
2013-10-03 00:21:08 +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 >
< div class = "description" >
< p > Phaser - ArcadeEmitter< / p >
< / div >
< 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
2013-10-03 00:21:08 +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 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-22" > line 22< / a >
< / li > < / ul > < / dd >
< / dl >
< / 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 >
< h4 class = "name" id = "alive" > < span class = "type-signature" > < / span > alive< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > alive< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > < 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 > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< 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 >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-08 07:24:22 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-62" > line 62< / a >
2014-02-05 06:29:17 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
2013-10-02 19:18:24 +00:00
< dt >
< h4 class = "name" id = "alpha" > < span class = "type-signature" > < / span > alpha< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The emitters alpha value.< / p >
< / div >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > alpha< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > Gets or sets the alpha value of the Emitter.
Object.defineProperty(Phaser.Particles.Arcade.Emitter.prototype, " alpha" , {< / p >
< pre > < code > get: function () {
return this._container.alpha;
},
set: function (value) {
this._container.alpha = value;
}< / code > < / pre >
< p > });< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-518" > line 518< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "angle" > < span class = "type-signature" > < / span > angle< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< 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.< / p >
< / div >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > angle< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The angle of rotation given in degrees, where 0 degrees = to the right.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< 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 >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1203" > line 1203< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "angularDrag" > < span class = "type-signature" > < / span > angularDrag< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > angularDrag< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > The angular drag component of particles launched from the emitter if they are rotating.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > 0< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-125" > line 125< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "bottom" > < span class = "type-signature" > < readonly> < / span > bottom< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > bottom< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > Gets the bottom position of the Emitter.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-623" > line 623< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "bounce" > < span class = "type-signature" > < / span > bounce< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > bounce< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > How much each particle should bounce on each axis. 1 = full bounce, 0 = no bounce.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-142" > line 142< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
2014-02-18 03:01:51 +00:00
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "cameraOffset" > < span class = "type-signature" > < / span > cameraOffset< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > cameraOffset< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / td >
< td class = "description last" > < 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 > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< 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 >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-95" > line 95< / a >
< / li > < / ul > < / dd >
2013-11-01 18:16:52 +00:00
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "cursor" > < span class = "type-signature" > < / span > cursor< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< 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.< / p >
< / div >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > cursor< / code > < / td >
< td class = "type" >
< span class = "param-type" > any< / span >
< / td >
< td class = "description last" > < p > The current display object that the Group cursor is pointing to.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< 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 >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-88" > line 88< / a >
2013-11-01 18:16:52 +00:00
< / li > < / ul > < / dd >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "emitX" > < span class = "type-signature" > < / span > emitX< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< 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 >
< / div >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > emitX< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-186" > line 186< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "emitY" > < span class = "type-signature" > < / span > emitY< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< 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 >
< / div >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > emitY< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-194" > line 194< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "exists" > < span class = "type-signature" > < / span > exists< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > exists< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > Determines whether the emitter is being updated by the core game loop.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > true< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-178" > line 178< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
2014-02-18 03:01:51 +00:00
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "fixedToCamera" > < span class = "type-signature" > < / span > fixedToCamera< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > A Group that is fixed to the camera uses its x/y coordinates as offsets from the top left of the camera. These are stored in Group.cameraOffset.
Note that the cameraOffset values are in addition to any parent in the display list.
So if this Group was in a Group that has x: 200, then this will be added to the cameraOffset.x< / p >
< / div >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > fixedToCamera< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > < p > Set to true to fix this Group to the Camera at its current world coordinates.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< 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 >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1221" > line 1221< / a >
< / li > < / ul > < / dd >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "frequency" > < span class = "type-signature" > < / span > frequency< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > frequency< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > How often a particle is emitted in ms (if emitter is started with Explode === false).< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > 100< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-131" > line 131< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "game" > < span class = "type-signature" > < / span > game< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > game< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Game.html" > Phaser.Game< / a > < / span >
< / td >
< td class = "description last" > < p > A reference to the currently running Game.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#game" > Phaser.Group#game< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-22" > line 22< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "gravity" > < span class = "type-signature" > < / span > gravity< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > gravity< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > Sets the < code > body.gravity.y< / code > of each particle sprite to this value on launch.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
2014-02-05 06:29:17 +00:00
< dd class = "tag-default" > < ul class = "dummy" > < li > 100< / li > < / ul > < / dd >
2013-10-02 19:18:24 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-107" > line 107< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-05 06:29:17 +00:00
< h4 class = "name" id = "height" > < span class = "type-signature" > < / span > height< span class = "type-signature" > < / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > height< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > The height of the emitter. Particles can be randomly generated from anywhere within this box.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
2014-02-05 06:29:17 +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
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-65" > line 65< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-05 06:29:17 +00:00
< h4 class = "name" id = "left" > < span class = "type-signature" > < readonly> < / span > left< span class = "type-signature" > < / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > left< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > Gets the left position of the Emitter.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-584" > line 584< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-05 06:29:17 +00:00
< h4 class = "name" id = "length" > < span class = "type-signature" > < readonly> < / span > length< span class = "type-signature" > < / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > length< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > The total number of children in this Group, regardless of their exists/alive status.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
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#length" > Phaser.Group#length< / a >
< / 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
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1188" > line 1188< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-05 06:29:17 +00:00
< h4 class = "name" id = "lifespan" > < span class = "type-signature" > < / span > lifespan< span class = "type-signature" > < / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > lifespan< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < 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 > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
2014-02-05 06:29:17 +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
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-137" > line 137< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-05 06:29:17 +00:00
< h4 class = "name" id = "maxParticles" > < span class = "type-signature" > < / span > maxParticles< span class = "type-signature" > < / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > maxParticles< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +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 >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-28" > line 28< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-05 06:29:17 +00:00
< h4 class = "name" id = "maxParticleScale" > < span class = "type-signature" > < / span > maxParticleScale< span class = "type-signature" > < / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-05 06:29:17 +00:00
< td class = "name" > < code > maxParticleScale< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2014-02-05 06:29:17 +00:00
< span class = "param-type" > number< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > The maximum possible scale of a particle.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
2014-02-05 06:29:17 +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
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-89" > line 89< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-05 06:29:17 +00:00
< h4 class = "name" id = "maxParticleSpeed" > < span class = "type-signature" > < / span > maxParticleSpeed< span class = "type-signature" > < / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-02-05 06:29:17 +00:00
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > maxParticleSpeed< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / td >
< td class = "description last" > < p > The maximum possible velocity of a particle.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-77" > line 77< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "maxRotation" > < span class = "type-signature" > < / span > maxRotation< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
2013-10-02 19:18:24 +00:00
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > maxRotation< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > The maximum possible angular velocity of a particle.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > 360< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-101" > line 101< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "minParticleScale" > < span class = "type-signature" > < / span > minParticleScale< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > minParticleScale< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > The minimum possible scale of a particle.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > 1< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-83" > line 83< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "minParticleSpeed" > < span class = "type-signature" > < / span > minParticleSpeed< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > minParticleSpeed< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > The minimum possible velocity of a particle.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-71" > line 71< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "minRotation" > < span class = "type-signature" > < / span > minRotation< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > minRotation< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > The minimum possible angular velocity of a particle.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-95" > line 95< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "name" > < span class = "type-signature" > < / span > name< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < p > Description.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-35" > line 35< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "on" > < span class = "type-signature" > < / span > on< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > on< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > Determines whether the emitter is currently emitting particles. It is totally safe to directly toggle this.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > false< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-172" > line 172< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "particleClass" > < span class = "type-signature" > < / span > particleClass< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > particleClass< / code > < / td >
< td class = "type" >
2014-02-05 06:29:17 +00:00
< span class = "param-type" > any< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > For emitting your own particle class types.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > null< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-113" > line 113< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-05 06:29:17 +00:00
< h4 class = "name" id = "particleFriction" > < span class = "type-signature" > < / span > particleFriction< span class = "type-signature" > < / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
2014-02-05 06:29:17 +00:00
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > particleFriction< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The friction component of particles launched from the emitter.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > 0< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-119" > line 119< / a >
< / li > < / ul > < / dd >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "right" > < span class = "type-signature" > < readonly> < / span > right< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > right< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > Gets the right position of the Emitter.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-597" > line 597< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "rotation" > < span class = "type-signature" > < / span > rotation< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< 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.< / p >
< / div >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > rotation< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The angle of rotation given in radians.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< 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 >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1258" > line 1258< / a >
2013-10-23 13:00:28 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "scale" > < span class = "type-signature" > < / span > scale< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > scale< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > The scale of the Group container.< / p > < / td >
2013-10-23 13:00:28 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< 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 >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-77" > line 77< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "top" > < span class = "type-signature" > < readonly> < / span > top< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > top< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > Gets the top position of the Emitter.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-610" > line 610< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
2013-10-23 13:00:28 +00:00
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "total" > < span class = "type-signature" > < readonly> < / span > total< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > total< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > The total number of children in this Group who have a state of exists = true.< / p > < / td >
2013-10-23 13:00:28 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< 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 >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1173" > line 1173< / a >
2013-10-23 13:00:28 +00:00
< / li > < / ul > < / dd >
2013-10-02 19:18:24 +00:00
< / dl >
< / dd >
< dt >
2014-02-05 06:29:17 +00:00
< h4 class = "name" id = "type" > < span class = "type-signature" > < protected> < / span > type< span class = "type-signature" > < / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > type< / code > < / td >
< td class = "type" >
2014-02-05 06:29:17 +00:00
< span class = "param-type" > number< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > Internal Phaser Type value.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-03 00:21:08 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-41" > line 41< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "visible" > < span class = "type-signature" > < / span > visible< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The emitter visible state.< / p >
< / div >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > visible< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
2014-02-08 07:24:22 +00:00
< td class = "description last" > < p > Gets or sets the Emitter visible state.
Object.defineProperty(Phaser.Particles.Arcade.Emitter.prototype, " visible" , {< / p >
< pre > < code > get: function () {
return this._container.visible;
},
set: function (value) {
this._container.visible = value;
}< / code > < / pre >
< p > });< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-08 07:24:22 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-520" > line 520< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "width" > < span class = "type-signature" > < / span > width< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > width< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The width of the emitter. Particles can be randomly generated from anywhere within this box.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > 1< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-03 00:21:08 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-59" > line 59< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "x" > < span class = "type-signature" > < / span > x< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > Gets or sets the x position of the Emitter.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-08 07:24:22 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-522" > line 522< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "x" > < span class = "type-signature" > < / span > x< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The X position of the top left corner of the emitter in world space.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > 0< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-03 00:21:08 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-47" > line 47< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "y" > < span class = "type-signature" > < / span > y< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > Gets or sets the y position of the Emitter.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-568" > line 568< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "y" > < span class = "type-signature" > < / span > y< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The Y position of the top left corner of emitter in world space.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > 0< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-10-03 00:21:08 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-53" > line 53< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< / dl >
< h3 class = "subsection-title" > Methods< / h3 >
< dl >
< dt >
< h4 class = "name" id = "add" > < span class = "type-signature" > < / span > add< span class = "signature" > (child)< / span > < span class = "type-signature" > → {*}< / span > < / h4 >
< / dt >
< dd >
< 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 >
< 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 > An instance of Phaser.Sprite, Phaser.Button or any other display object..< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#add" > Phaser.Group#add< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-147" > line 147< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< 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 >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The child that was added to the Group.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > *< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "addAll" > < span class = "type-signature" > < / span > addAll< span class = "signature" > (property, amount, checkAlive, checkVisible)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Adds the amount to the given property on all children in this Group.
Group.addAll('x', 10) will add 10 to 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 increment, for example 'body.velocity.x' or 'angle'.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > amount< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The amount to increment the property by. If child.x = 10 then addAll('x', 40) would make child.x = 50.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > checkAlive< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > < p > If true the property will only be changed if the child is alive.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > checkVisible< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > < p > If true the property will only be changed if the child is visible.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "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 >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-524" > line 524< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "addAt" > < span class = "type-signature" > < / span > addAt< span class = "signature" > (child, index)< / span > < span class = "type-signature" > → {*}< / span > < / h4 >
< / dt >
< dd >
< 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 >
< 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 > An instance of Phaser.Sprite, Phaser.Button or any other display object..< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > index< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The index within the Group to insert the child to.< / 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#addAt" > Phaser.Group#addAt< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-179" > line 179< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The child that was added to the Group.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > *< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "at" > < span class = "type-signature" > < / span > at< span class = "signature" > (object)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
2014-02-05 06:29:17 +00:00
< p > Change the emitters center to match the center of any object with a < code > center< / code > property, such as a Sprite.< / 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 >
< td class = "name" > < code > object< / code > < / td >
< td class = "type" >
< span class = "param-type" > object< / span >
2014-02-05 06:29:17 +00:00
|
< span class = "param-type" > < a href = "Phaser.Sprite.html" > Phaser.Sprite< / a > < / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > The object that you wish to match the center with.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-503" > line 503< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "bringToTop" > < span class = "type-signature" > < / span > bringToTop< span class = "signature" > (child)< / span > < span class = "type-signature" > → {*}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Brings the given child to the top of this Group so it renders above all other children.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > child< / code > < / td >
< td class = "type" >
< span class = "param-type" > *< / span >
< / td >
< td class = "description last" > < p > The child to bring to the top of this Group.< / 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#bringToTop" > Phaser.Group#bringToTop< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-344" > line 344< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The child that was moved.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > *< / span >
< / dd >
< / dl >
< / dd >
< dt >
2013-11-01 18:16:52 +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 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
< div class = "description" >
< p > Calls a function on all of the children regardless if they are dead or alive (see callAllExists if you need control over that)
2013-11-07 06:10:15 +00:00
After the method parameter and context you can add as many extra parameters as you like, which will all be passed to the child.< / p >
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 >
2013-11-01 18:16:52 +00:00
< th > Default< / th >
2013-10-02 19:18:24 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2013-11-01 18:16:52 +00:00
< td class = "name" > < code > method< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2013-11-01 18:16:52 +00:00
< span class = "param-type" > string< / span >
2013-10-02 19:18:24 +00:00
< / td >
< td class = "attributes" >
< / td >
2013-11-01 18:16:52 +00:00
< td class = "default" >
< / td >
2013-10-02 19:18:24 +00:00
2013-11-01 18:16:52 +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 >
< / tr >
< tr >
< td class = "name" > < code > context< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
2014-02-05 06:29:17 +00:00
null
2013-11-01 18:16:52 +00:00
< / td >
2014-02-05 06:29:17 +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 >
2013-10-02 19:18:24 +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 >
2013-11-01 18:16:52 +00:00
< td class = "default" >
< / td >
2013-10-02 19:18:24 +00:00
2013-11-01 18:16:52 +00:00
< td class = "description last" > < p > Additional parameters that will be passed to the method.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / 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#callAll" > Phaser.Group#callAll< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-664" > line 664< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "callAllExists" > < span class = "type-signature" > < / span > callAllExists< span class = "signature" > (callback, existsValue, parameter)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Calls a function 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 >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > callback< / code > < / td >
< td class = "type" >
< span class = "param-type" > function< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > The function that exists on the children that will be called.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > existsValue< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < p > Only children with exists=existsValue will be called.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > parameter< / code > < / td >
< td class = "type" >
< span class = "param-type" > *< / span >
< / td >
< td class = "attributes" >
< repeatable>< br >
< / td >
< td class = "description last" > < p > Additional parameters that will be passed to the callback.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#callAllExists" > Phaser.Group#callAllExists< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-588" > line 588< / a >
2013-11-01 18:16:52 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "callbackFromArray" > < span class = "type-signature" > < protected> < / span > callbackFromArray< span class = "signature" > (child, callback, length)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
2014-02-05 06:29:17 +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-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" >
< span class = "param-type" > object< / span >
< / td >
< td class = "description last" > < p > The object to inspect.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > callback< / code > < / td >
< td class = "type" >
< span class = "param-type" > array< / span >
< / td >
< td class = "description last" > < p > The array of function names.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > length< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The size of the array (pre-calculated in callAll).< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#callbackFromArray" > Phaser.Group#callbackFromArray< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-611" > line 611< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
2014-02-05 06:29:17 +00:00
< / dd >
< dt >
< h4 class = "name" id = "countDead" > < span class = "type-signature" > < / span > countDead< span class = "signature" > ()< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Call this function to find out how many members of the group are dead.< / 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#countDead" > Phaser.Group#countDead< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1006" > line 1006< / a >
2014-02-05 06:29:17 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The number of children flagged as dead.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
2013-10-02 19:18:24 +00:00
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "countLiving" > < span class = "type-signature" > < / span > countLiving< span class = "signature" > ()< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Call this function to find out how many members of the group are alive.< / 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#countLiving" > Phaser.Group#countLiving< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-994" > line 994< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2014-02-05 06:29:17 +00:00
< p > The number of children flagged as alive.< / p >
2013-10-02 19:18:24 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
< / dd >
< / dl >
< / dd >
< dt >
2013-10-25 15:54:40 +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 > }< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
< div class = "description" >
< p > Automatically creates a new Phaser.Sprite object and adds it to the top of this Group.
Useful if you don't need to create the Sprite instances before-hand.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
2013-10-23 13:00:28 +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 > x< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
2013-10-23 13:00:28 +00:00
< td class = "default" >
< / td >
2013-10-02 19:18:24 +00:00
< td class = "description last" > < p > The x coordinate to display the newly created Sprite at. The value is in relation to the Group.x point.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > y< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
2013-10-23 13:00:28 +00:00
< td class = "default" >
< / td >
2013-10-02 19:18:24 +00:00
< td class = "description last" > < p > The y coordinate to display the newly created Sprite at. The value is in relation to the Group.y point.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > key< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
2013-10-23 13:00:28 +00:00
< td class = "default" >
< / td >
2013-10-02 19:18:24 +00:00
< 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 >
2013-10-23 13:00:28 +00:00
< td class = "default" >
< / td >
2013-10-02 19:18:24 +00:00
< 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 >
2013-10-23 13:00:28 +00:00
< td class = "default" >
true
< / td >
2013-10-02 19:18:24 +00:00
< td class = "description last" > < p > The default exists state of the Sprite.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#create" > Phaser.Group#create< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-222" > line 222< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The child that was created.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2013-10-25 15:54:40 +00:00
< span class = "param-type" > < a href = "Phaser.Sprite.html" > Phaser.Sprite< / a > < / span >
2013-10-02 19:18:24 +00:00
< / dd >
< / dl >
2013-10-23 13:00:28 +00:00
< / dd >
< dt >
< h4 class = "name" id = "createMultiple" > < span class = "type-signature" > < / span > createMultiple< span class = "signature" > (quantity, key, < span class = "optional" > frame< / span > , < span class = "optional" > exists< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > 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
and will be positioned at 0, 0 (relative to the Group.x/y)< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > quantity< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > The number of Sprites to create.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > key< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > The Game.cache key of the image that this Sprite will use.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > frame< / code > < / td >
< td class = "type" >
< span class = "param-type" > 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 >
< / 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#createMultiple" > Phaser.Group#createMultiple< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-260" > line 260< / a >
2013-10-23 13:00:28 +00:00
< / li > < / ul > < / dd >
< / dl >
2013-10-02 19:18:24 +00:00
< / dd >
< dt >
2014-02-05 06:29:17 +00:00
< h4 class = "name" id = "destroy" > < span class = "type-signature" > < / span > destroy< span class = "signature" > (< span class = "optional" > destroyChildren< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
< div class = "description" >
< p > Destroys this Group. Removes all children, then removes the container from the display list and nulls references.< / p >
< / 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 > 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" >
false
< / td >
< td class = "description last" > < p > Should every child of this Group have its destroy method called?< / p > < / td >
< / tr >
< / tbody >
< / table >
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 >
< a href = "Phaser.Group.html#destroy" > Phaser.Group#destroy< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1134" > line 1134< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "divideAll" > < span class = "type-signature" > < / span > divideAll< span class = "signature" > (property, amount, checkAlive, checkVisible)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Divides the given property by the amount on all children in this Group.
Group.divideAll('x', 2) will half 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 divide, for example 'body.velocity.x' or 'angle'.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > amount< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The amount to divide the property by. If child.x = 100 then divideAll('x', 2) would make child.x = 50.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > checkAlive< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > < p > If true the property will only be changed if the child is alive.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > checkVisible< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > < p > If true the property will only be changed if the child is visible.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "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 >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-572" > line 572< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-05 06:29:17 +00:00
< h4 class = "name" id = "emitParticle" > < span class = "type-signature" > < / span > emitParticle< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
< div class = "description" >
2014-02-05 06:29:17 +00:00
< p > This function can be used both internally and externally to emit the next particle.< / p >
2013-10-02 19:18:24 +00:00
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-376" > line 376< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-05 06:29:17 +00:00
< h4 class = "name" id = "forEach" > < span class = "type-signature" > < / span > forEach< span class = "signature" > (callback, callbackContext, checkExists)< / span > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
< div class = "description" >
2014-02-05 06:29:17 +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 >
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
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-02-05 06:29:17 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2013-10-02 19:18:24 +00:00
< 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" >
< span class = "param-type" > Object< / span >
< / td >
< td class = "description last" > < p > The context in which the function should be called (usually 'this').< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > checkExists< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "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 >
< 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 >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-787" > line 787< / a >
2013-11-07 06:10:15 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "forEachAlive" > < span class = "type-signature" > < / span > forEachAlive< span class = "signature" > (callback, callbackContext)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< 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 >
< / 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 > 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" >
< span class = "param-type" > Object< / span >
< / td >
< td class = "description last" > < p > The context in which the function should be called (usually 'this').< / 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#forEachAlive" > Phaser.Group#forEachAlive< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-819" > line 819< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "forEachAlive" > < span class = "type-signature" > < / span > forEachAlive< span class = "signature" > (callback, callbackContext)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< 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 >
< / 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 > 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" >
< span class = "param-type" > Object< / span >
< / td >
< td class = "description last" > < p > The context in which the function should be called (usually 'this').< / 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#forEachAlive" > Phaser.Group#forEachAlive< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-837" > line 837< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "forEachDead" > < span class = "type-signature" > < / span > forEachDead< span class = "signature" > (callback, callbackContext)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< 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 >
< / 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 > 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" >
< span class = "param-type" > Object< / span >
< / td >
< td class = "description last" > < p > The context in which the function should be called (usually 'this').< / 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#forEachDead" > Phaser.Group#forEachDead< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-855" > line 855< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "getAt" > < span class = "type-signature" > < / span > getAt< span class = "signature" > (index)< / span > < span class = "type-signature" > → {*}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Returns the child found at the given index within this Group.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > index< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The index to return the child from.< / 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#getAt" > Phaser.Group#getAt< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-209" > line 209< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The child that was found at the given index.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > *< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "getFirstAlive" > < span class = "type-signature" > < / span > getFirstAlive< span class = "signature" > ()< / span > < span class = "type-signature" > → {Any}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
2013-11-28 15:57:09 +00:00
< p > Call this function to retrieve the first object with alive === true in the group.
2013-10-02 19:18:24 +00:00
This is handy for checking if everything has been wiped out, or choosing a squad leader, etc.< / 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#getFirstAlive" > Phaser.Group#getFirstAlive< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-968" > line 968< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The first alive child, or null if none found.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Any< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "getFirstDead" > < span class = "type-signature" > < / span > getFirstDead< span class = "signature" > ()< / span > < span class = "type-signature" > → {Any}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
2013-11-28 15:57:09 +00:00
< p > Call this function to retrieve the first object with alive === false in the group.
2013-10-02 19:18:24 +00:00
This is handy for checking if everything has been wiped out, or choosing a squad leader, etc.< / 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#getFirstDead" > Phaser.Group#getFirstDead< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-981" > line 981< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The first dead child, or null if none found.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Any< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "getFirstExists" > < span class = "type-signature" > < / span > getFirstExists< span class = "signature" > (state)< / span > < span class = "type-signature" > → {Any}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Call this function to retrieve the first object with exists == (the given state) in the 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 > state< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > < p > True or false.< / 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#getFirstExists" > Phaser.Group#getFirstExists< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-950" > line 950< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The first child, or null if none found.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Any< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "getIndex" > < span class = "type-signature" > < / span > getIndex< span class = "signature" > (child)< / span > < span class = "type-signature" > → {number}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Get the index position of the given child in 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 > child< / code > < / td >
< td class = "type" >
< span class = "param-type" > *< / span >
< / td >
< td class = "description last" > < p > The child to get the index for.< / 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#getIndex" > Phaser.Group#getIndex< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-363" > line 363< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > The index of the child or -1 if it's not a member of this Group.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > number< / span >
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "getRandom" > < span class = "type-signature" > < / span > getRandom< span class = "signature" > (startIndex, length)< / span > < span class = "type-signature" > → {Any}< / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Returns a member at random from the 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 > startIndex< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< 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 >
< / tr >
< tr >
< td class = "name" > < code > length< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > Optional restriction on the number of values you want to randomly select from.< / 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#getRandom" > Phaser.Group#getRandom< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1018" > line 1018< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > A random child of this Group.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Any< / span >
< / dd >
< / dl >
< / dd >
< dt >
2014-02-05 06:29:17 +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 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
< div class = "description" >
2013-11-07 06:10:15 +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 >
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 >
2013-11-07 06:10:15 +00:00
< th > Argument< / th >
2013-10-02 19:18:24 +00:00
2013-11-07 06:10:15 +00:00
< th > Default< / th >
2013-10-02 19:18:24 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2013-11-07 06:10:15 +00:00
< td class = "name" > < code > key< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2013-11-07 06:10:15 +00:00
< span class = "param-type" > string< / span >
2013-10-02 19:18:24 +00:00
< / td >
2013-11-07 06:10:15 +00:00
< td class = "attributes" >
2013-10-02 19:18:24 +00:00
2013-11-07 06:10:15 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2013-11-07 06:10:15 +00:00
< td class = "default" >
< / td >
< td class = "description last" > < p > The child property to check, i.e. 'exists', 'alive', 'health'< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< tr >
2013-11-07 06:10:15 +00:00
< td class = "name" > < code > value< / code > < / td >
2013-10-02 19:18:24 +00:00
< td class = "type" >
2013-11-07 06:10:15 +00:00
< span class = "param-type" > any< / span >
2013-10-02 19:18:24 +00:00
< / td >
2013-11-07 06:10:15 +00:00
< td class = "attributes" >
2013-10-02 19:18:24 +00:00
2013-11-07 06:10:15 +00:00
2013-10-02 19:18:24 +00:00
2013-11-07 06:10:15 +00:00
< / td >
< td class = "default" >
< / td >
< 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 >
< / tr >
< tr >
< td class = "name" > < code > returnType< / 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 > How to return the data from this method. Either Phaser.Group.RETURN_NONE, Phaser.Group.RETURN_TOTAL or Phaser.Group.RETURN_CHILD.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > callback< / code > < / td >
< td class = "type" >
< span class = "param-type" > function< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
null
< / td >
< td class = "description last" > < p > Optional function that will be called on each matching child. 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" >
< span class = "param-type" > Object< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > The context in which the function should be called (usually 'this').< / p > < / td >
< / tr >
< / 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#iterate" > Phaser.Group#iterate< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-893" > line 893< / a >
2013-11-07 06:10:15 +00:00
< / li > < / ul > < / dd >
< / dl >
2014-02-05 06:29:17 +00:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > Returns either a numeric total (if RETURN_TOTAL was specified) or the child object.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > any< / span >
< / dd >
< / dl >
2013-11-07 06:10:15 +00:00
< / dd >
< dt >
< h4 class = "name" id = "kill" > < span class = "type-signature" > < / span > kill< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Call this function to turn off all the particles and the emitter.< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-315" > line 315< / a >
2013-11-07 06:10:15 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-05 06:29:17 +00:00
< h4 class = "name" id = "makeParticles" > < span class = "type-signature" > < / span > makeParticles< span class = "signature" > (keys, frames, quantity, < 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 >
2013-11-07 06:10:15 +00:00
< / dt >
< dd >
< div class = "description" >
< p > This function generates a new array of particle sprites to attach to the emitter.< / p >
< / 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-11-07 06:10:15 +00:00
2014-02-05 06:29:17 +00:00
< th > Default< / th >
2013-11-07 06:10:15 +00:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > keys< / code > < / td >
< td class = "type" >
2014-02-05 06:29:17 +00:00
< span class = "param-type" > array< / span >
|
< span class = "param-type" > string< / span >
2013-11-07 06:10:15 +00:00
< / td >
2014-02-05 06:29:17 +00:00
< td class = "attributes" >
2013-11-07 06:10:15 +00:00
2014-02-05 06:29:17 +00:00
< / td >
2013-11-07 06:10:15 +00:00
2014-02-05 06:29:17 +00:00
< 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 >
2013-11-07 06:10:15 +00:00
< / tr >
< tr >
< td class = "name" > < code > frames< / code > < / td >
< td class = "type" >
2014-02-05 06:29:17 +00:00
< span class = "param-type" > array< / span >
|
2013-11-07 06:10:15 +00:00
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "attributes" >
2013-11-07 06:10:15 +00:00
2014-02-05 06:29:17 +00:00
< / td >
2013-11-07 06:10:15 +00:00
2014-02-05 06:29:17 +00:00
< td class = "default" >
< / 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 >
2013-11-07 06:10:15 +00:00
< / tr >
2013-10-02 19:18:24 +00:00
< tr >
< td class = "name" > < code > quantity< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "attributes" >
< / td >
2013-10-02 19:18:24 +00:00
2014-02-05 06:29:17 +00:00
< td class = "default" >
< / td >
2013-10-02 19:18:24 +00:00
2014-02-05 06:29:17 +00:00
< td class = "description last" > < p > The number of particles to generate.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< tr >
< td class = "name" > < code > collide< / code > < / td >
< td class = "type" >
2014-02-05 06:29:17 +00:00
< span class = "param-type" > boolean< / span >
2013-10-02 19:18:24 +00:00
< / td >
2014-02-05 06:29:17 +00:00
< td class = "attributes" >
< optional>< br >
2013-10-02 19:18:24 +00:00
2014-02-05 06:29:17 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2014-02-05 06:29:17 +00:00
< td class = "default" >
false
< / td >
< td class = "description last" > < p > Sets the checkCollision.none flag on the particle sprites body.< / p > < / td >
2013-10-02 19:18:24 +00:00
< / tr >
< tr >
< td class = "name" > < code > collideWorldBounds< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "attributes" >
< optional>< br >
2013-10-02 19:18:24 +00:00
2014-02-05 06:29:17 +00:00
< / td >
2013-10-02 19:18:24 +00:00
2014-02-05 06:29:17 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-245" > line 245< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2014-02-05 06:29:17 +00:00
< p > This Emitter instance.< / p >
2013-10-02 19:18:24 +00:00
< / div >
2014-02-05 06:29:17 +00:00
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Phaser.Particles.Arcade.Emitter.html" > Phaser.Particles.Arcade.Emitter< / a > < / span >
< / dd >
< / dl >
2013-10-02 19:18:24 +00:00
< / 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:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-556" > line 556< / a >
2013-11-01 18:16:52 +00:00
< / li > < / ul > < / dd >
< / 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 >
< 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:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-282" > line 282< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "postUpdate" > < span class = "type-signature" > < protected> < / 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 = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-764" > line 764< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "preUpdate" > < span class = "type-signature" > < protected> < / 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 = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-724" > line 724< / a >
2013-11-01 18:16:52 +00:00
< / li > < / ul > < / dd >
< / 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 >
< 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:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-306" > line 306< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2013-11-28 15:57:09 +00:00
< h4 class = "name" id = "remove" > < span class = "type-signature" > < / span > remove< span class = "signature" > (child)< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
< div class = "description" >
< p > Removes the given child from this Group and sets its group property to null.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > child< / code > < / td >
< td class = "type" >
< span class = "param-type" > Any< / span >
< / td >
< td class = "description last" > < p > The child to remove.< / 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#remove" > Phaser.Group#remove< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1040" > line 1040< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
2013-11-28 15:57:09 +00:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
< p > true if the child was removed from this Group, otherwise false.< / p >
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
2013-10-02 19:18:24 +00:00
< / dd >
< dt >
< h4 class = "name" id = "removeAll" > < span class = "type-signature" > < / span > removeAll< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Removes all children from this Group, setting all group properties to null.
The Group container remains on the display list.< / p >
< / div >
< dl class = "details" >
< dt class = "inherited-from" > Inherited From:< / dt >
< dd class = "inherited-from" > < ul class = "dummy" > < li >
< a href = "Phaser.Group.html#removeAll" > Phaser.Group#removeAll< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1070" > line 1070< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "removeBetween" > < span class = "type-signature" > < / span > removeBetween< span class = "signature" > (startIndex, endIndex)< / 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 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 = "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 = "description last" > < p > The index to stop removing children from. Must be higher than startIndex and less than the length of the Group.< / 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:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-1098" > line 1098< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / 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 >
< 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:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-376" > line 376< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / 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" >
2014-02-05 06:29:17 +00:00
< p > Handy for bringing game objects " back to life" . Just sets alive and exists back to true.< / p >
2013-10-02 19:18:24 +00:00
< / div >
2014-02-05 06:29:17 +00:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-327" > line 327< / a >
< / li > < / ul > < / dd >
< / 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 > < span class = "type-signature" > < / 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 >
< / tbody >
< / table >
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 >
< a href = "Phaser.Group.html#set" > Phaser.Group#set< / a >
< / li > < / dd >
2013-10-02 19:18:24 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-468" > line 468< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "setAll" > < span class = "type-signature" > < / span > setAll< span class = "signature" > (key, value, < span class = "optional" > checkAlive< / span > , < span class = "optional" > checkVisible< / span > , < span class = "optional" > operation< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > This function allows you to quickly set the same property across all children 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 > 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 only children with alive=true will be updated.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > checkVisible< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
false
< / td >
< td class = "description last" > < p > If set then only children with visible=true will be updated.< / 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 >
< / 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#setAll" > Phaser.Group#setAll< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-494" > line 494< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "setProperty" > < span class = "type-signature" > < / span > setProperty< span class = "signature" > (child, key, value, < span class = "optional" > operation< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Sets the given property to the given value on the child. The operation controls the assignment of the value.< / 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" > *< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > The child to set the property value on.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > key< / code > < / td >
< td class = "type" >
< span class = "param-type" > array< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > An array of strings that make up the property that will be set.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > value< / code > < / td >
< td class = "type" >
< span class = "param-type" > *< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > The value that will be set.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > operation< / code > < / td >
< td class = "type" >
< span class = "param-type" > 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 >
< / 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#setProperty" > Phaser.Group#setProperty< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-408" > line 408< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-05 06:29:17 +00:00
< 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 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
< div class = "description" >
< p > A more compact way of setting the angular velocity constraints of the emitter.< / p >
< / 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
2014-02-05 06:29:17 +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 > min< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2013-10-02 19:18:24 +00:00
2014-02-05 06:29:17 +00:00
< td class = "default" >
0
< / td >
2013-10-02 19:18:24 +00:00
< td class = "description last" > < p > The minimum value for this range.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > max< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2013-10-02 19:18:24 +00:00
2014-02-05 06:29:17 +00:00
< td class = "default" >
0
< / td >
2013-10-02 19:18:24 +00:00
< td class = "description last" > < p > The maximum value for this range.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-487" > line 487< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "setSize" > < span class = "type-signature" > < / span > setSize< span class = "signature" > (width, height)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > A more compact way of setting the width and height of the emitter.< / 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 > width< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The desired width of the emitter (particles are spawned randomly within these dimensions).< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > height< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The desired height of the emitter.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-442" > line 442< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-05 06:29:17 +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 >
< div class = "description" >
< p > A more compact way of setting the X velocity range of the emitter.< / p >
< / 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
2014-02-05 06:29:17 +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 > min< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2013-10-02 19:18:24 +00:00
2014-02-05 06:29:17 +00:00
< td class = "default" >
0
< / td >
2013-10-02 19:18:24 +00:00
< td class = "description last" > < p > The minimum value for this range.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > max< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2013-10-02 19:18:24 +00:00
2014-02-05 06:29:17 +00:00
< td class = "default" >
0
< / td >
2013-10-02 19:18:24 +00:00
< td class = "description last" > < p > The maximum value for this range.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-455" > line 455< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-05 06:29:17 +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 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
< div class = "description" >
< p > A more compact way of setting the Y velocity range of the emitter.< / p >
< / 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
2014-02-05 06:29:17 +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 > min< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2013-10-02 19:18:24 +00:00
2014-02-05 06:29:17 +00:00
< td class = "default" >
0
< / td >
2013-10-02 19:18:24 +00:00
< td class = "description last" > < p > The minimum value for this range.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > max< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2013-10-02 19:18:24 +00:00
2014-02-05 06:29:17 +00:00
< td class = "default" >
0
< / td >
2013-10-02 19:18:24 +00:00
< td class = "description last" > < p > The maximum value for this range.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-471" > line 471< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
2013-11-07 06:10:15 +00:00
< / dd >
< dt >
< 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 >
< / dt >
< dd >
< div class = "description" >
< 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 >
< / 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" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
'y'
< / td >
< td class = "description last" > < p > The < code > string< / code > name of the property you want to sort on.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > order< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
Phaser.Group.SORT_ASCENDING
< / td >
< 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 >
< / 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#sort" > Phaser.Group#sort< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-873" > line 873< / a >
2013-11-07 06:10:15 +00:00
< / li > < / ul > < / dd >
< / dl >
2013-10-02 19:18:24 +00:00
< / dd >
< dt >
2014-02-05 06:29:17 +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 > < span class = "type-signature" > < / span > < / h4 >
2013-10-02 19:18:24 +00:00
< / dt >
< dd >
< div class = "description" >
< p > Call this function to start emitting particles.< / p >
< / 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
2014-02-05 06:29:17 +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 > explode< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2013-10-02 19:18:24 +00:00
2014-02-05 06:29:17 +00:00
< td class = "default" >
true
< / td >
2013-10-02 19:18:24 +00:00
< td class = "description last" > < p > Whether the particles should all burst out at once.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > lifespan< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2013-10-02 19:18:24 +00:00
2014-02-05 06:29:17 +00:00
< td class = "default" >
0
< / td >
2013-10-02 19:18:24 +00:00
< td class = "description last" > < p > How long each particle lives once emitted. 0 = forever.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > frequency< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2013-10-02 19:18:24 +00:00
2014-02-05 06:29:17 +00:00
< td class = "default" >
250
< / td >
2013-10-02 19:18:24 +00:00
< td class = "description last" > < p > Ignored if Explode is set to true. Frequency is how often to emit a particle in ms.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > quantity< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-05 06:29:17 +00:00
< td class = "attributes" >
< optional>< br >
< / td >
2013-10-02 19:18:24 +00:00
2014-02-05 06:29:17 +00:00
< td class = "default" >
0
< / td >
2013-10-02 19:18:24 +00:00
< td class = "description last" > < p > How many particles to launch. 0 = " all of the particles" .< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-338" > line 338< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / 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 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > property< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < p > The property to decrement, for example 'body.velocity.x' or 'angle'.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > amount< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The amount to subtract from the property. If child.x = 50 then subAll('x', 40) would make child.x = 10.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > checkAlive< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > < p > If true the property will only be changed if the child is alive.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > checkVisible< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > < p > If true the property will only be changed if the child is visible.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "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 >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-540" > line 540< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-08 07:24:22 +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 >
< div class = "description" >
2013-11-07 06:10:15 +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, doing so will return false.< / 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 >
< td class = "name" > < code > child1< / code > < / td >
< td class = "type" >
< span class = "param-type" > *< / span >
< / td >
< td class = "description last" > < p > The first child to swap.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > child2< / code > < / td >
< td class = "type" >
< span class = "param-type" > *< / span >
< / td >
< td class = "description last" > < p > The second child to swap.< / 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#swap" > Phaser.Group#swap< / a >
< / li > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-18 03:01:51 +00:00
< a href = "Group.js.html" > core/Group.js< / a > , < a href = "Group.js.html#sunlight-1-line-330" > line 330< / a >
2014-02-05 06:29:17 +00:00
< / li > < / ul > < / dd >
< / dl >
2013-10-02 19:18:24 +00:00
< / dd >
< dt >
< h4 class = "name" id = "update" > < span class = "type-signature" > < / span > update< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Called automatically by the game loop, decides when to launch particles and when to " die" .< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Emitter.js.html" > particles/arcade/Emitter.js< / a > , < a href = "Emitter.js.html#sunlight-1-line-201" > line 201< / a >
2013-10-02 19:18:24 +00:00
< / li > < / ul > < / dd >
< / dl >
< / 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" >
2013-10-25 15:54:40 +00:00
Documentation generated by < a href = "https://github.com/jsdoc3/jsdoc" > JSDoc 3.3.0-dev< / a >
2014-02-18 03:01:51 +00:00
on Tue Feb 18 2014 03:01:24 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( {
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 >
