phaser/v2-community/resources/docgen/output/Phaser.Particles.Arcade.Emitter.json

1 line
86 KiB
JSON
Raw Normal View History

{"class":{"name":"Phaser.Particles.Arcade.Emitter","extends":"Phaser.Group","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"Current game instance.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate within the Emitter that the particles are emitted from.","optional":true,"default":"0"},{"name":"y","type":["number"],"help":"The y coordinate within the Emitter that the particles are emitted from.","optional":true,"default":"0"},{"name":"maxParticles","type":["number"],"help":"The total number of particles in this emitter.","optional":true,"default":"50"}],"help":"Emitter is a lightweight particle emitter that uses Arcade Physics.\\nIt can be used for one-time explosions or for continuous effects like rain and fire.\\nAll it really does is launch Particle objects out at set intervals, and fixes their positions and velocities accordingly."},"consts":[],"methods":{"public":[{"name":"add","static":false,"returns":{"types":["any"],"help":"The child that was added to the Group."},"help":"Adds an existing object to this Group. The object can be an instance of Phaser.Sprite, Phaser.Button or any other display object.\\nThe 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\\nthat then see the addAt method.","line":209,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"An instance of Phaser.Sprite, Phaser.Button or any other display object.","optional":false,"default":null},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the child will not dispatch the onAddedToGroup event.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"addAll","static":false,"returns":null,"help":"Adds the amount to the given property on all children in this Group.\\nGroup.addAll('x', 10) will add 10 to the child.x value.","line":956,"public":true,"protected":false,"private":false,"parameters":[{"name":"property","type":["string"],"help":"The property to increment, for example 'body.velocity.x' or 'angle'.","optional":false,"default":null},{"name":"amount","type":["number"],"help":"The amount to increment the property by. If child.x = 10 then addAll('x', 40) would make child.x = 50.","optional":false,"default":null},{"name":"checkAlive","type":["boolean"],"help":"If true the property will only be changed if the child is alive.","optional":false,"default":null},{"name":"checkVisible","type":["boolean"],"help":"If true the property will only be changed if the child is visible.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"addAt","static":false,"returns":{"types":["any"],"help":"The child that was added to the Group."},"help":"Adds an existing object to this Group. The object can be an instance of Phaser.Sprite, Phaser.Button or any other display object.\\nThe child is added to the Group at the location specified by the index value, this allows you to control child ordering.","line":273,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["any"],"help":"An instance of Phaser.Sprite, Phaser.Button or any other display object..","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index within the Group to insert the child to.","optional":false,"default":null},{"name":"silent","type":["boolean"],"help":"If the silent parameter is `true` the child will not dispatch the onAddedToGroup event.","optional":true,"default":"false"}],"inherited":true,"inheritedFrom":"Phaser.Group"},{"name":"addChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container.","line":93,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to add to the container","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":