Class 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.

Hierarchy (View Summary)

Controller

Index

Constructors

Properties

active gameObject type

Methods

destroy setActive

Constructors

constructor

new Controller(type: number, gameObject: GameObject): Controller
Parameters
- type: number
  The FX Type constant.
- gameObject: GameObject
  A reference to the Game Object that has this fx.
Returns Controller
- Defined in types/phaser.d.ts:10507

Properties

active

active: boolean

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.

gameObject

gameObject: GameObject

A reference to the Game Object that owns this effect.

type

type: number

The FX_CONST type of this effect.

Methods

destroy

destroy(): void
Destroys this FX Controller.

Returns void
- Defined in types/phaser.d.ts:10540

setActive

setActive(value: boolean): this
Sets the active state of this FX Controller.

A disabled FX Controller will not be updated.
Parameters
- value: boolean
  true to enable this FX Controller, or false to disable it.
Returns this
- Defined in types/phaser.d.ts:10535