The Particle Bounds Processor.
Defines a rectangular region, in world space, within which particle movement is restrained.
Use the properties collideLeft, collideRight, collideTop and
collideBottom to control if a particle will rebound off the sides
of this boundary, or not.
This happens when the particles worldPosition x/y coordinate hits the boundary.
The strength of the rebound is determined by the Particle.bounce property.
Constructor
new ParticleBounds(x, y, width, height, [collideLeft], [collideRight], [collideTop], [collideBottom])
Parameters
name | type | optional | default | description |
|---|---|---|---|---|
x | number | No | The x position (top-left) of the bounds, in world space. | |
y | number | No | The y position (top-left) of the bounds, in world space. | |
width | number | No | The width of the bounds. | |
height | number | No | The height of the bounds. | |
collideLeft | boolean | Yes | true | Whether particles interact with the left edge of the bounds. |
collideRight | boolean | Yes | true | Whether particles interact with the right edge of the bounds. |
collideTop | boolean | Yes | true | Whether particles interact with the top edge of the bounds. |
collideBottom | boolean | Yes | true | Whether particles interact with the bottom edge of the bounds. |
Scope: static
Extends
Source: src/gameobjects/particles/ParticleBounds.js#L11
Since: 3.60.0
Public Members
active
active: boolean
Description:
The active state of the Particle Processor.
An inactive Particle Processor will be skipped for processing by its parent Emitter.
Inherits: Phaser.GameObjects.Particles.ParticleProcessor#active
Source: src/gameobjects/particles/ParticleProcessor.js#L66
Since: 3.60.0
bounds
bounds: Phaser.Geom.Rectangle
Description:
A rectangular boundary constraining particle movement. Use the Emitter properties collideLeft,
collideRight, collideTop and collideBottom to control if a particle will rebound off
the sides of this boundary, or not. This happens when the particles x/y coordinate hits
the boundary.
Source: src/gameobjects/particles/ParticleBounds.js#L56
Since: 3.60.0
collideBottom
collideBottom: boolean
Description:
Whether particles interact with the bottom edge of the emitter Phaser.GameObjects.Particles.ParticleBounds#bounds.
Source: src/gameobjects/particles/ParticleBounds.js#L98
Since: 3.60.0
collideLeft
collideLeft: boolean
Description:
Whether particles interact with the left edge of the emitter Phaser.GameObjects.Particles.ParticleEmitter#bounds.
Source: src/gameobjects/particles/ParticleBounds.js#L68
Since: 3.60.0
collideRight
collideRight: boolean
Description:
Whether particles interact with the right edge of the emitter Phaser.GameObjects.Particles.ParticleBounds#bounds.
Source: src/gameobjects/particles/ParticleBounds.js#L78
Since: 3.60.0
collideTop
collideTop: boolean
Description:
Whether particles interact with the top edge of the emitter Phaser.GameObjects.Particles.ParticleBounds#bounds.
Source: src/gameobjects/particles/ParticleBounds.js#L88
Since: 3.60.0
manager
manager: Phaser.GameObjects.Particles.ParticleEmitter
Description:
A reference to the Particle Emitter that owns this Processor. This is set automatically when the Processor is added to an Emitter and nulled when removed or destroyed.
Inherits: Phaser.GameObjects.Particles.ParticleProcessor#manager
Source: src/gameobjects/particles/ParticleProcessor.js#L37
Since: 3.60.0
x
x: number
Description:
The x coordinate of the Particle Processor, in world space.
Inherits: Phaser.GameObjects.Particles.ParticleProcessor#x
Source: src/gameobjects/particles/ParticleProcessor.js#L48
Since: 3.60.0
y
y: number
Description:
The y coordinate of the Particle Processor, in world space.
Inherits: Phaser.GameObjects.Particles.ParticleProcessor#y
Source: src/gameobjects/particles/ParticleProcessor.js#L57
Since: 3.60.0
Public Methods
destroy
<instance> destroy()
Description:
Destroys this Particle Processor by removing all external references.
This is called automatically when the owning Particle Emitter is destroyed.
Inherits: Phaser.GameObjects.Particles.ParticleProcessor#destroy
Source: src/gameobjects/particles/ParticleProcessor.js#L96
Since: 3.60.0
update
<instance> update(particle)
Description:
Takes a Particle and updates it against the bounds.
Parameters:
name | type | optional | description |
|---|---|---|---|
particle | No | The Particle to update. |
Overrides: Phaser.GameObjects.Particles.ParticleProcessor#update
Source: src/gameobjects/particles/ParticleBounds.js#L109
Since: 3.0.0