Filter
The Glow FX Controller.
This FX controller manages the glow effect for a Game Object.
The glow effect is a visual technique that creates a soft, luminous halo around game objects, characters, or UI elements. This effect is used to emphasize importance, enhance visual appeal, or convey a sense of energy, magic, or otherworldly presence. The effect can also be set on the inside of the Game Object. The color and strength of the glow can be modified.
A Glow effect is added to a Game Object via the FX component:
const sprite = this.add.sprite();
sprite.preFX.addGlow();
sprite.postFX.addGlow();
Constructor:
new Glow(gameObject, [color], [outerStrength], [innerStrength], [knockout])
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| gameObject | Phaser.GameObjects.GameObject |
A reference to the Game Object that has this fx. |
||
| color | number | <optional> | 0xffffff |
The color of the glow effect as a number value. |
| outerStrength | number | <optional> | 4 |
The strength of the glow outward from the edge of the Sprite. |
| innerStrength | number | <optional> | 0 |
The strength of the glow inward from the edge of the Sprite. |
| knockout | boolean | <optional> | false |
If |
Extends
Members
Description:
Toggle this boolean to enable or disable this effect, without removing and adding it from the Game Object.
Only works for Pre FX.
Post FX are always active.
Type:
Description:
The color of the glow as a number value.
Type:
Description:
A reference to the Game Object that owns this effect.
Description:
A 4 element array of gl color values.
Type:
Description:
The strength of the glow inward from the edge of the Sprite.
Type:
Description:
If true only the glow is drawn, not the texture itself.
Type:
Description:
The strength of the glow outward from the edge of the Sprite.
Type:
Description:
The FX_CONST type of this effect.
Type:
Methods
Description:
Destroys this FX Controller.
Description:
Sets the active state of this FX Controller.
A disabled FX Controller will not be updated.
Parameters:
| name | type | description |
|---|---|---|
| value | boolean |
|
Returns:
Description:
This FX Controller instance.
Type: