Phaser API Documentation

  Version: 
disable([clear])

Description:

Disables this FX Component.

This will reset the pipeline on the Game Object that owns this component back to its default and flag this component as disabled.

You can re-enable it again by calling enable for Pre FX or by adding an FX for Post FX.

Optionally, set clear to destroy all current FX Controllers.

Parameters:

name type arguments Default description
clear boolean <optional> false

Destroy and remove all FX Controllers that are part of this component.

Returns:
Description:

This Game Object instance.

Since: 3.60.0