Filter
Phaser . FX . Controller
Phaser . FX . Controller
FX Controller is the base class that all built-in FX use.
You should not normally create an instance of this class directly, but instead use one of the built-in FX that extend it.
Constructor:
new Controller(type, gameObject)
Parameters:
| name | type | description |
|---|---|---|
| type | number |
The FX Type constant. |
| gameObject | Phaser.GameObjects.GameObject |
A reference to the Game Object that has this fx. |
Since: 3.60.0
Members
active: boolean
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:
boolean
Since: 3.60.0
gameObject: Phaser.GameObjects.GameObject
Description:
A reference to the Game Object that owns this effect.
Since: 3.60.0
type: number
Description:
The FX_CONST type of this effect.
Type:
number
Since: 3.60.0
Methods
destroy()
Description:
Destroys this FX Controller.
Since: 3.60.0
setActive(value)
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:
Since: 3.60.0
Possible examples