Filter
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord
Phaser . GameObjects . Particles . ParticleEmitterManager
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord
Phaser . GameObjects . Particles . ParticleEmitterManager
A Particle Emitter Manager creates and controls Particle and Gravity.
Constructor:
new ParticleEmitterManager(scene, texture, [frame], [emitters])
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| scene | Phaser.Scene |
The Scene to which this Emitter Manager belongs. |
|
| texture | string |
The key of the Texture this Emitter Manager will use to render particles, as stored in the Texture Manager. |
|
| frame | string | number | <optional> |
An optional frame from the Texture this Emitter Manager will use to render particles. |
| emitters | Phaser.Types.GameObjects.Particles.ParticleEmitterConfig | Array.<Phaser.Types.GameObjects.Particles.ParticleEmitterConfig> | <optional> |
Configuration settings for one or more emitters to create. |
Extends
- Phaser.GameObjects.GameObject
- Phaser.GameObjects.Components.Depth
- Phaser.GameObjects.Components.Mask
- Phaser.GameObjects.Components.Pipeline
- Phaser.GameObjects.Components.Transform
- Phaser.GameObjects.Components.Visible
Members
Description:
The active state of this Game Object.
A Game Object with an active state of true is processed by the Scenes UpdateList, if added to it.
An active object is one which is having its logic and internal systems updated.
Type:
Description:
The angle of this Game Object as expressed in degrees.
Phaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left and -90 is up.
If you prefer to work in radians, see the rotation property instead.
Type:
Description:
If this Game Object is enabled for Arcade or Matter Physics then this property will contain a reference to a Physics Body.
Type:
Description:
A bitmask that controls if this Game Object is drawn by a Camera or not.
Not usually set directly, instead call Camera.ignore, however you can
set this property directly using the Camera.id property:
Type:
Description:
A Data Manager.
It allows you to store, query and get key/value paired information specific to this Game Object.
null by default. Automatically created if you use getData or setData or setDataEnabled.
Type:
Description:
The initial WebGL pipeline of this Game Object.
If you call resetPipeline on this Game Object, the pipeline is reset to this default.
Description:
The depth of this Game Object within the Scene.
The depth is also known as the 'z-index' in some environments, and allows you to change the rendering order of Game Objects, without actually moving their position in the display list.
The default depth is zero. A Game Object with a higher depth value will always render in front of one with a lower value.
Setting the depth will queue a depth sort event within the Scene.
Type:
Description:
Holds a reference to the Display List that contains this Game Object.
This is set automatically when this Game Object is added to a Scene or Layer.
You should treat this property as being read-only.
Description:
A list of Emitters being managed by this Emitter Manager.
Description:
The texture frame used to render this Emitter Manager's particles.
Type:
Description:
Names of this Emitter Manager's texture frames.
Type:
Description:
Does this Game Object have any Post Pipelines set?
Type:
Description:
This Game Object will ignore all calls made to its destroy method if this flag is set to true.
This includes calls that may come from a Group, Container or the Scene itself.
While it allows you to persist a Game Object across Scenes, please understand you are entirely
responsible for managing references to and from this Game Object.
Type:
Description:
If this Game Object is enabled for input then this property will contain an InteractiveObject instance.
Not usually set directly. Instead call GameObject.setInteractive().
Description:
The Mask this Game Object is using during render.
Description:
The name of this Game Object. Empty by default and never populated by Phaser, this is left for developers to use.
Type:
Description:
The parent Container of this Game Object, if it has one.
Description:
The current WebGL pipeline of this Game Object.
Description:
An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.
Type:
Description:
The WebGL Post FX Pipelines this Game Object uses for post-render effects.
The pipelines are processed in the order in which they appear in this array.
If you modify this array directly, be sure to set the
hasPostPipeline property accordingly.
Type:
Description:
The flags that are compared against RENDER_MASK to determine if this Game Object will render or not.
The bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.
If those components are not used by your custom class then you can use this bitmask as you wish.
Type:
Description:
The angle of this Game Object in radians.
Phaser uses a right-hand clockwise rotation system, where 0 is right, PI/2 is down, +-PI is left and -PI/2 is up.
If you prefer to work in degrees, see the angle property instead.
Type:
Description:
This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object
to the same value, at the same time. When reading this value the result returned is (scaleX + scaleY) / 2.
Use of this property implies you wish the horizontal and vertical scales to be equal to each other. If this
isn't the case, use the scaleX or scaleY properties instead.
Type:
Description:
The horizontal scale of this Game Object.
Type:
Description:
The vertical scale of this Game Object.
Type:
Description:
A reference to the Scene to which this Game Object belongs.
Game Objects can only belong to one Scene.
You should consider this property as being read-only. You cannot move a Game Object to another Scene by simply changing it.
Type:
Description:
The current state of this Game Object.
Phaser itself will never modify this value, although plugins may do so.
Use this property to track the state of a Game Object during its lifetime. For example, it could change from a state of 'moving', to 'attacking', to 'dead'. The state value should be an integer (ideally mapped to a constant in your game code), or a string. These are recommended to keep it light and simple, with fast comparisons. If you need to store complex data about your Game Object, look at using the Data Component instead.
Type:
Description:
The Tab Index of the Game Object. Reserved for future use by plugins and the Input Manager.
Type:
Description:
The texture used to render this Emitter Manager's particles.
Type:
Description:
The time scale applied to all emitters and particles, affecting flow rate, lifespan, and movement. Values larger than 1 are faster than normal. This is multiplied with any timeScale set on each individual emitter.
Type:
Description:
A textual representation of this Game Object, i.e. sprite.
Used internally by Phaser but is available for your own custom classes to populate.
Type:
Description:
The visible state of the Game Object.
An invisible Game Object will skip rendering, but will still process update logic.
Type:
Description:
The w position of this Game Object.
Type:
Description:
A list of Gravity Wells being managed by this Emitter Manager.
Description:
The x position of this Game Object.
Type:
Description:
The y position of this Game Object.
Type:
Description:
The z position of this Game Object.
Note: The z position does not control the rendering order of 2D Game Objects. Use Phaser.GameObjects.Components.Depth#depth instead.
Type:
Methods
Description:
Adds an existing Particle Emitter to this Emitter Manager.
Parameters:
| name | type | description |
|---|---|---|
| emitter | Phaser.GameObjects.Particles.ParticleEmitter |
The Particle Emitter to add to this Emitter Manager. |
Returns:
Description:
The Particle Emitter that was added to this Emitter Manager.
Description:
Adds an existing Gravity Well object to this Emitter Manager.
Parameters:
| name | type | description |
|---|---|---|
| well | Phaser.GameObjects.Particles.GravityWell |
The Gravity Well to add to this Emitter Manager. |
Returns:
Description:
The Gravity Well that was added to this Emitter Manager.
Description:
Add a listener for a given event.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| event | string | symbol |
The event name. |
||
| fn | function |
The listener function. |
||
| context | * | <optional> | this |
The context to invoke the listener with. |
Returns:
Description:
this.
Description:
This callback is invoked when this Game Object is added to a Scene.
Can be overriden by custom Game Objects, but be aware of some Game Objects that will use this, such as Sprites, to add themselves into the Update List.
You can also listen for the ADDED_TO_SCENE event from this Game Object.
Description:
Clears the mask that this Game Object was using.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| destroyMask | boolean | <optional> | false |
Destroy the mask before clearing it? |
Returns:
Description:
This Game Object instance.
Description:
Copies an object's coordinates to this Game Object's position.
Parameters:
| name | type | description |
|---|---|---|
| source | Phaser.Types.Math.Vector2Like | Phaser.Types.Math.Vector3Like | Phaser.Types.Math.Vector4Like |
An object with numeric 'x', 'y', 'z', or 'w' properties. Undefined values are not copied. |
Returns:
Description:
This Game Object instance.
Description:
Creates and returns a Bitmap Mask. This mask can be used by any Game Object, including this one.
Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.
To create the mask you need to pass in a reference to a renderable Game Object. A renderable Game Object is one that uses a texture to render with, such as an Image, Sprite, Render Texture or BitmapText.
If you do not provide a renderable object, and this Game Object has a texture, it will use itself as the object. This means you can call this method to create a Bitmap Mask from any renderable Game Object.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| renderable | Phaser.GameObjects.GameObject | <optional> |
A renderable Game Object that uses a texture, such as a Sprite. |
Returns:
Description:
This Bitmap Mask that was created.
Description:
Creates a new Particle Emitter object, adds it to this Emitter Manager and returns a reference to it.
Parameters:
| name | type | description |
|---|---|---|
| config | Phaser.Types.GameObjects.Particles.ParticleEmitterConfig |
Configuration settings for the Particle Emitter to create. |
Returns:
Description:
The Particle Emitter that was created.
Description:
Creates and returns a Geometry Mask. This mask can be used by any Game Object, including this one.
To create the mask you need to pass in a reference to a Graphics Game Object.
If you do not provide a graphics object, and this Game Object is an instance of a Graphics object, then it will use itself to create the mask.
This means you can call this method to create a Geometry Mask from any Graphics Game Object.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| graphics | Phaser.GameObjects.Graphics | <optional> |
A Graphics Game Object. The geometry within it will be used as the mask. |
Returns:
Description:
This Geometry Mask that was created.
Description:
Creates a new Gravity Well, adds it to this Emitter Manager and returns a reference to it.
Parameters:
| name | type | description |
|---|---|---|
| config | Phaser.Types.GameObjects.Particles.GravityWellConfig |
Configuration settings for the Gravity Well to create. |
Returns:
Description:
The Gravity Well that was created.
Description:
Destroys this Game Object removing it from the Display List and Update List and severing all ties to parent resources.
Also removes itself from the Input Manager and Physics Manager if previously enabled.
Use this to remove a Game Object from your game if you don't ever plan to use it again. As long as no reference to it exists within your own code it should become free for garbage collection by the browser.
If you just want to temporarily disable an object then look at using the Game Object Pool instead of destroying it, as destroyed objects cannot be resurrected.
Description:
If this Game Object has previously been enabled for input, this will disable it.
An object that is disabled for input stops processing or being considered for
input events, but can be turned back on again at any time by simply calling
setInteractive() with no arguments provided.
If want to completely remove interaction from this Game Object then use removeInteractive instead.
Returns:
Description:
This GameObject.
Description:
Calls each of the listeners registered for a given event.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| event | string | symbol |
The event name. |
|
| args | * | <optional> |
Additional arguments that will be passed to the event handler. |
Returns:
Description:
true if the event had listeners, else false.
Type:
- boolean
Description:
Emits particles from each active emitter.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| count | number | <optional> |
The number of particles to release from each emitter. The default is the emitter's own {@link Phaser.GameObjects.Particles.ParticleEmitter#quantity}. |
| x | number | <optional> |
The x-coordinate to to emit particles from. The default is the x-coordinate of the emitter's current location. |
| y | number | <optional> |
The y-coordinate to to emit particles from. The default is the y-coordinate of the emitter's current location. |
Returns:
Description:
This Emitter Manager.
Description:
Emits particles from each active emitter.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| x | number | <optional> |
The x-coordinate to to emit particles from. The default is the x-coordinate of the emitter's current location. |
| y | number | <optional> |
The y-coordinate to to emit particles from. The default is the y-coordinate of the emitter's current location. |
| count | number | <optional> |
The number of particles to release from each emitter. The default is the emitter's own {@link Phaser.GameObjects.Particles.ParticleEmitter#quantity}. |
Returns:
Description:
This Emitter Manager.
Description:
Return an array listing the events for which the emitter has registered listeners.
Type:
- Array.<(string
- symbol)>
Description:
Retrieves the value for the given key in this Game Objects Data Manager, or undefined if it doesn't exist.
You can also access values via the values object. For example, if you had a key called gold you can do either:
sprite.getData('gold');
Or access the value directly:
sprite.data.values.gold;
You can also pass in an array of keys, in which case an array of values will be returned:
sprite.getData([ 'gold', 'armor', 'health' ]);
This approach is useful for destructuring arrays in ES6.
Parameters:
| name | type | description |
|---|---|---|
| key | string | Array.<string> |
The key of the value to retrieve, or an array of keys. |
Returns:
Description:
The value belonging to the given key, or an array of values, the order of which will match the input array.
Type:
- *
Description:
Returns an array containing the display list index of either this Game Object, or if it has one, its parent Container. It then iterates up through all of the parent containers until it hits the root of the display list (which is index 0 in the returned array).
Used internally by the InputPlugin but also useful if you wish to find out the display depth of this Game Object and all of its ancestors.
Returns:
Description:
An array of display list position indexes.
Type:
- Array.<number>
Description:
Takes the given x and y coordinates and converts them into local space for this
Game Object, taking into account parent and local transforms, and the Display Origin.
The returned Vector2 contains the translated point in its properties.
A Camera needs to be provided in order to handle modified scroll factors. If no
camera is specified, it will use the main camera from the Scene to which this
Game Object belongs.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| x | number |
The x position to translate. |
|
| y | number |
The y position to translate. |
|
| point | Phaser.Math.Vector2 | <optional> |
A Vector2, or point-like object, to store the results in. |
| camera | Phaser.Cameras.Scene2D.Camera | <optional> |
The Camera which is being tested against. If not given will use the Scene default camera. |
Returns:
Description:
The translated point.
Type:
Description:
Gets the local transform matrix for this Game Object.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| tempMatrix | Phaser.GameObjects.Components.TransformMatrix | <optional> |
The matrix to populate with the values from this Game Object. |
Returns:
Description:
The populated Transform Matrix.
Description:
Gets the sum total rotation of all of this Game Objects parent Containers.
The returned value is in radians and will be zero if this Game Object has no parent container.
Returns:
Description:
The sum total rotation, in radians, of all parent containers of this Game Object.
Type:
- number
Description:
Gets the name of the WebGL Pipeline this Game Object is currently using.
Returns:
Description:
The string-based name of the pipeline being used by this Game Object.
Type:
- string
Description:
Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.
Parameters:
| name | type | description |
|---|---|---|
| pipeline | string | function | Phaser.Renderer.WebGL.Pipelines.PostFXPipeline |
The string-based name of the pipeline, or a pipeline class. |
Returns:
Description:
The Post Pipeline/s matching the name, or undefined if no match. If more than one match they are returned in an array.
Type:
Description:
Gets all active particle processors (gravity wells).
Returns:
Description:
- The active gravity wells.
Type:
Description:
Gets the world transform matrix for this Game Object, factoring in any parent Containers.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| tempMatrix | Phaser.GameObjects.Components.TransformMatrix | <optional> |
The matrix to populate with the values from this Game Object. |
| parentMatrix | Phaser.GameObjects.Components.TransformMatrix | <optional> |
A temporary matrix to hold parent values during the calculations. |
Returns:
Description:
The populated Transform Matrix.
Description:
Increase a value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is increased from 0.
If the Game Object has not been enabled for data (via setDataEnabled) then it will be enabled
before setting the value.
If the key doesn't already exist in the Data Manager then it is created.
When the value is first set, a setdata event is emitted from this Game Object.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| key | string | object |
The key to increase the value for. |
|
| data | * | <optional> |
The value to increase for the given key. |
Returns:
Description:
This GameObject.
Description:
Sets the initial WebGL Pipeline of this Game Object.
This should only be called during the instantiation of the Game Object. After that, use setPipeline.
Parameters:
| name | type | description |
|---|---|---|
| pipeline | string | Phaser.Renderer.WebGL.WebGLPipeline |
Either the string-based name of the pipeline, or a pipeline instance to set. |
Returns:
Description:
true if the pipeline was set successfully, otherwise false.
Type:
- boolean
Description:
Return the number of listeners listening to a given event.
Parameters:
| name | type | description |
|---|---|---|
| event | string | symbol |
The event name. |
Returns:
Description:
The number of listeners.
Type:
- number
Description:
Return the listeners registered for a given event.
Parameters:
| name | type | description |
|---|---|---|
| event | string | symbol |
The event name. |
Returns:
Description:
The registered listeners.
Type:
- Array.<function()>
Description:
Remove the listeners of a given event.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| event | string | symbol |
The event name. |
|
| fn | function | <optional> |
Only remove the listeners that match this function. |
| context | * | <optional> |
Only remove the listeners that have this context. |
| once | boolean | <optional> |
Only remove one-time listeners. |
Returns:
Description:
this.
Description:
Add a listener for a given event.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| event | string | symbol |
The event name. |
||
| fn | function |
The listener function. |
||
| context | * | <optional> | this |
The context to invoke the listener with. |
Returns:
Description:
this.
Description:
Add a one-time listener for a given event.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| event | string | symbol |
The event name. |
||
| fn | function |
The listener function. |
||
| context | * | <optional> | this |
The context to invoke the listener with. |
Returns:
Description:
this.
Description:
Pauses this Emitter Manager.
This has the effect of pausing all emitters, and all particles of those emitters, currently under its control.
The particles will still render, but they will not have any of their logic updated.
Returns:
Description:
This Emitter Manager.
Description:
Updates all active emitters.
Parameters:
| name | type | description |
|---|---|---|
| time | number |
The current timestamp as generated by the Request Animation Frame or SetTimeout. |
| delta | number |
The delta time, in ms, elapsed since the last frame. |
Description:
Remove all listeners, or those of the specified event.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| event | string | symbol | <optional> |
The event name. |
Returns:
Description:
this.
Description:
Removes a Particle Emitter from this Emitter Manager, if the Emitter belongs to this Manager.
Parameters:
| name | type |
|---|---|
| emitter | Phaser.GameObjects.Particles.ParticleEmitter |
Returns:
Description:
The Particle Emitter if it was removed or null if it was not.
Description:
If this Game Object has previously been enabled for input, this will queue it for removal, causing it to no longer be interactive. The removal happens on the next game step, it is not immediate.
The Interactive Object that was assigned to this Game Object will be destroyed, removed from the Input Manager and cleared from this Game Object.
If you wish to re-enable this Game Object at a later date you will need to
re-create its InteractiveObject by calling setInteractive again.
If you wish to only temporarily stop an object from receiving input then use
disableInteractive instead, as that toggles the interactive state, where-as
this erases it completely.
If you wish to resize a hit area, don't remove and then set it as being
interactive. Instead, access the hitarea object directly and resize the shape
being used. I.e.: sprite.input.hitArea.setSize(width, height) (assuming the
shape is a Rectangle, which it is by default.)
Returns:
Description:
This GameObject.
Description:
Remove the listeners of a given event.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| event | string | symbol |
The event name. |
|
| fn | function | <optional> |
Only remove the listeners that match this function. |
| context | * | <optional> |
Only remove the listeners that have this context. |
| once | boolean | <optional> |
Only remove one-time listeners. |
Returns:
Description:
this.
Description:
Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.
If you wish to remove all Post Pipelines use the resetPostPipeline method instead.
Parameters:
| name | type | description |
|---|---|---|
| pipeline | string | Phaser.Renderer.WebGL.Pipelines.PostFXPipeline |
The string-based name of the pipeline, or a pipeline class. |
Returns:
Description:
This Game Object.
Description:
This callback is invoked when this Game Object is removed from a Scene.
Can be overriden by custom Game Objects, but be aware of some Game Objects that will use this, such as Sprites, to removed themselves from the Update List.
You can also listen for the REMOVED_FROM_SCENE event from this Game Object.
Description:
Resets the WebGL Pipeline of this Game Object back to the default it was created with.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| resetPostPipelines | boolean | <optional> | false |
Reset all of the post pipelines? |
| resetData | boolean | <optional> | false |
Reset the |
Returns:
Description:
true if the pipeline was reset successfully, otherwise false.
Type:
- boolean
Description:
Resets the WebGL Post Pipelines of this Game Object. It does this by calling
the destroy method on each post pipeline and then clearing the local array.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| resetData | boolean | <optional> | false |
Reset the |
Description:
Resumes this Emitter Manager, should it have been previously paused.
Returns:
Description:
This Emitter Manager.
Description:
Sets the active property of this Game Object and returns this Game Object for further chaining.
A Game Object with its active property set to true will be updated by the Scenes UpdateList.
Parameters:
| name | type | description |
|---|---|---|
| value | boolean |
True if this Game Object should be set as active, false if not. |
Returns:
Description:
This GameObject.
Description:
Sets the angle of this Game Object.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| degrees | number | <optional> |
The rotation of this Game Object, in degrees. |
Returns:
Description:
This Game Object instance.
Description:
Allows you to store a key value pair within this Game Objects Data Manager.
If the Game Object has not been enabled for data (via setDataEnabled) then it will be enabled
before setting the value.
If the key doesn't already exist in the Data Manager then it is created.
sprite.setData('name', 'Red Gem Stone');
You can also pass in an object of key value pairs as the first argument:
sprite.setData({ name: 'Red Gem Stone', level: 2, owner: 'Link', gold: 50 });
To get a value back again you can call getData:
sprite.getData('gold');
Or you can access the value directly via the values property, where it works like any other variable:
sprite.data.values.gold += 50;
When the value is first set, a setdata event is emitted from this Game Object.
If the key already exists, a changedata event is emitted instead, along an event named after the key.
For example, if you updated an existing key called PlayerLives then it would emit the event changedata-PlayerLives.
These events will be emitted regardless if you use this method to set the value, or the direct values setter.
Please note that the data keys are case-sensitive and must be valid JavaScript Object property strings.
This means the keys gold and Gold are treated as two unique values within the Data Manager.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| key | string | object |
The key to set the value for. Or an object of key value pairs. If an object the |
|
| data | * | <optional> |
The value to set for the given key. If an object is provided as the key this argument is ignored. |
Returns:
Description:
This GameObject.
Description:
Adds a Data Manager component to this Game Object.
Returns:
Description:
This GameObject.
Description:
The depth of this Game Object within the Scene.
The depth is also known as the 'z-index' in some environments, and allows you to change the rendering order of Game Objects, without actually moving their position in the display list.
The default depth is zero. A Game Object with a higher depth value will always render in front of one with a lower value.
Setting the depth will queue a depth sort event within the Scene.
Parameters:
| name | type | description |
|---|---|---|
| value | number |
The depth of this Game Object. |
Returns:
Description:
This Game Object instance.
Description:
Assigns texture frames to an emitter.
Parameters:
| name | type | description |
|---|---|---|
| frames | Phaser.Textures.Frame | Array.<Phaser.Textures.Frame> |
The texture frames. |
| emitter | Phaser.GameObjects.Particles.ParticleEmitter |
The particle emitter to modify. |
Returns:
Description:
This Emitter Manager.
Description:
Sets the frame this Emitter Manager will use to render with.
The Frame has to belong to the current Texture being used.
It can be either a string or an index.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| frame | string | number | <optional> |
The name or index of the frame within the Texture. |
Returns:
Description:
This Emitter Manager.
Description:
Pass this Game Object to the Input Manager to enable it for Input.
Input works by using hit areas, these are nearly always geometric shapes, such as rectangles or circles, that act as the hit area for the Game Object. However, you can provide your own hit area shape and callback, should you wish to handle some more advanced input detection.
If no arguments are provided it will try and create a rectangle hit area based on the texture frame the Game Object is using. If this isn't a texture-bound object, such as a Graphics or BitmapText object, this will fail, and you'll need to provide a specific shape for it to use.
You can also provide an Input Configuration Object as the only argument to this method.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| hitArea | any | Phaser.Types.Input.InputConfiguration | <optional> |
Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not given it will try to create a Rectangle based on the texture frame. |
|
| callback | Phaser.Types.Input.HitAreaCallback | <optional> |
The callback that determines if the pointer is within the Hit Area shape or not. If you provide a shape you must also provide a callback. |
|
| dropZone | boolean | <optional> | false |
Should this Game Object be treated as a drop zone target? |
Returns:
Description:
This GameObject.
sprite.setInteractive();
sprite.setInteractive(new Phaser.Geom.Circle(45, 46, 45), Phaser.Geom.Circle.Contains);
graphics.setInteractive(new Phaser.Geom.Rectangle(0, 0, 128, 128), Phaser.Geom.Rectangle.Contains);
Description:
Sets the mask that this Game Object will use to render with.
The mask must have been previously created and can be either a GeometryMask or a BitmapMask. Note: Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.
If a mask is already set on this Game Object it will be immediately replaced.
Masks are positioned in global space and are not relative to the Game Object to which they are applied. The reason for this is that multiple Game Objects can all share the same mask.
Masks have no impact on physics or input detection. They are purely a rendering component that allows you to limit what is visible during the render pass.
Parameters:
| name | type | description |
|---|---|---|
| mask | Phaser.Display.Masks.BitmapMask | Phaser.Display.Masks.GeometryMask |
The mask this Game Object will use when rendering. |
Returns:
Description:
This Game Object instance.
Description:
Sets the name property of this Game Object and returns this Game Object for further chaining.
The name property is not populated by Phaser and is presented for your own use.
Parameters:
| name | type | description |
|---|---|---|
| value | string |
The name to be given to this Game Object. |
Returns:
Description:
This GameObject.
Description:
Sets the main WebGL Pipeline of this Game Object.
Also sets the pipelineData property, if the parameter is given.
Both the pipeline and post pipelines share the same pipeline data object.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| pipeline | string | Phaser.Renderer.WebGL.WebGLPipeline |
Either the string-based name of the pipeline, or a pipeline instance to set. |
||
| pipelineData | object | <optional> |
Optional pipeline data object that is deep copied into the |
|
| copyData | boolean | <optional> | true |
Should the pipeline data object be deep copied into the |
Returns:
Description:
This Game Object instance.
Description:
Adds an entry to the pipelineData object belonging to this Game Object.
If the 'key' already exists, its value is updated. If it doesn't exist, it is created.
If value is undefined, and key exists, key is removed from the data object.
Both the pipeline and post pipelines share the pipeline data object together.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| key | string |
The key of the pipeline data to set, update, or delete. |
|
| value | any | <optional> |
The value to be set with the key. If |
Returns:
Description:
This Game Object instance.
Description:
Sets the position of this Game Object.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| x | number | <optional> | 0 |
The x position of this Game Object. |
| y | number | <optional> | x |
The y position of this Game Object. If not set it will use the |
| z | number | <optional> | 0 |
The z position of this Game Object. |
| w | number | <optional> | 0 |
The w position of this Game Object. |
Returns:
Description:
This Game Object instance.
Description:
Sets one, or more, Post Pipelines on this Game Object.
Post Pipelines are invoked after this Game Object has rendered to its target and are commonly used for post-fx.
The post pipelines are appended to the postPipelines array belonging to this
Game Object. When the renderer processes this Game Object, it iterates through the post
pipelines in the order in which they appear in the array. If you are stacking together
multiple effects, be aware that the order is important.
If you call this method multiple times, the new pipelines will be appended to any existing
post pipelines already set. Use the resetPostPipeline method to clear them first, if required.
You can optionally also sets the pipelineData property, if the parameter is given.
Both the pipeline and post pipelines share the pipeline data object together.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| pipelines | string | Array.<string> | function | Array.<function()> | Phaser.Renderer.WebGL.Pipelines.PostFXPipeline | Array.<Phaser.Renderer.WebGL.Pipelines.PostFXPipeline> |
Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them. |
||
| pipelineData | object | <optional> |
Optional pipeline data object that is deep copied into the |
|
| copyData | boolean | <optional> | true |
Should the pipeline data object be deep copied into the |
Returns:
Description:
This Game Object instance.
Description:
Sets the position of this Game Object to be a random position within the confines of the given area.
If no area is specified a random position between 0 x 0 and the game width x height is used instead.
The position does not factor in the size of this Game Object, meaning that only the origin is guaranteed to be within the area.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| x | number | <optional> |
The x position of the top-left of the random area. |
| y | number | <optional> |
The y position of the top-left of the random area. |
| width | number | <optional> |
The width of the random area. |
| height | number | <optional> |
The height of the random area. |
Returns:
Description:
This Game Object instance.
Description:
Sets the rotation of this Game Object.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| radians | number | <optional> |
The rotation of this Game Object, in radians. |
Returns:
Description:
This Game Object instance.
Description:
Sets the scale of this Game Object.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| x | number |
The horizontal scale of this Game Object. |
||
| y | number | <optional> | x |
The vertical scale of this Game Object. If not set it will use the |
Returns:
Description:
This Game Object instance.
Description:
Sets the current state of this Game Object.
Phaser itself will never modify the State of a Game Object, although plugins may do so.
For example, a Game Object could change from a state of 'moving', to 'attacking', to 'dead'. The state value should typically be an integer (ideally mapped to a constant in your game code), but could also be a string. It is recommended to keep it light and simple. If you need to store complex data about your Game Object, look at using the Data Component instead.
Parameters:
| name | type | description |
|---|---|---|
| value | number | string |
The state of the Game Object. |
Returns:
Description:
This GameObject.
Description:
Sets the texture and frame this Emitter Manager will use to render with.
Textures are referenced by their string-based keys, as stored in the Texture Manager.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| key | string |
The key of the texture to be used, as stored in the Texture Manager. |
|
| frame | string | number | <optional> |
The name or index of the frame within the Texture. |
Returns:
Description:
This Emitter Manager.
Description:
Sets the visibility of this Game Object.
An invisible Game Object will skip rendering, but will still process update logic.
Parameters:
| name | type | description |
|---|---|---|
| value | boolean |
The visible state of the Game Object. |
Returns:
Description:
This Game Object instance.
Description:
Sets the w position of this Game Object.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| value | number | <optional> |
The w position of this Game Object. |
Returns:
Description:
This Game Object instance.
Description:
Sets the x position of this Game Object.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| value | number | <optional> |
The x position of this Game Object. |
Returns:
Description:
This Game Object instance.
Description:
Sets the y position of this Game Object.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| value | number | <optional> |
The y position of this Game Object. |
Returns:
Description:
This Game Object instance.
Description:
Sets the z position of this Game Object.
Note: The z position does not control the rendering order of 2D Game Objects. Use Phaser.GameObjects.Components.Depth#setDepth instead.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| value | number | <optional> |
The z position of this Game Object. |
Returns:
Description:
This Game Object instance.
Description:
Removes all listeners.
Description:
Returns a JSON representation of the Game Object.
Returns:
Description:
A JSON representation of the Game Object.
Description:
Toggle a boolean value for the given key within this Game Objects Data Manager. If the key doesn't already exist in the Data Manager then it is toggled from false.
If the Game Object has not been enabled for data (via setDataEnabled) then it will be enabled
before setting the value.
If the key doesn't already exist in the Data Manager then it is created.
When the value is first set, a setdata event is emitted from this Game Object.
Parameters:
| name | type | description |
|---|---|---|
| key | string | object |
The key to toggle the value for. |
Returns:
Description:
This GameObject.
Description:
To be overridden by custom GameObjects. Allows base objects to be used in a Pool.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| args | * | <optional> |
args |
Description:
Compares the renderMask with the renderFlags to see if this Game Object will render or not. Also checks the Game Object against the given Cameras exclusion list.
Parameters:
| name | type | description |
|---|---|---|
| camera | Phaser.Cameras.Scene2D.Camera |
The Camera to check against this Game Object. |
Returns:
Description:
True if the Game Object should be rendered, otherwise false.
Type:
- boolean