Filter
The Barrel FX Controller.
This FX controller manages the barrel distortion effect for a Game Object.
A barrel effect allows you to apply either a 'pinch' or 'expand' distortion to a Game Object. The amount of the effect can be modified in real-time.
A Barrel effect is added to a Game Object via the FX component:
const sprite = this.add.sprite();
sprite.preFX.addBarrel();
sprite.postFX.addBarrel();
Constructor:
new Barrel(gameObject, [amount])
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| gameObject | Phaser.GameObjects.GameObject |
A reference to the Game Object that has this fx. |
||
| amount | number | <optional> | 1 |
The amount of distortion applied to the barrel effect. A value of 1 is no distortion. Typically keep this within +- 1. |
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 amount of distortion applied to the barrel effect.
Typically keep this within the range 1 (no distortion) to +- 1.
Type:
Description:
A reference to the Game Object that owns this effect.
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: