Phaser API Documentation

  Version: 
Filter

The Shine FX Controller.

This FX controller manages the shift effect for a Game Object.

The shine effect is a visual technique that simulates the appearance of reflective or glossy surfaces by passing a light beam across a Game Object. This effect is used to enhance visual appeal, emphasize certain features, and create a sense of depth or material properties.

A Shine effect is added to a Game Object via the FX component:

const sprite = this.add.sprite();

sprite.preFX.addShine();
sprite.postFX.addShine();

Constructor:

new Shine(gameObject, [speed], [lineWidth], [gradient], [reveal])

Parameters:

name type arguments Default description
gameObject Phaser.GameObjects.GameObject

A reference to the Game Object that has this fx.

speed number <optional> 0.5

The speed of the Shine effect.

lineWidth number <optional> 0.5

The line width of the Shine effect.

gradient number <optional> 3

The gradient of the Shine effect.

reveal boolean <optional> false

Does this Shine effect reveal or get added to its target?

Since: 3.60.0
Source: src/fx/Shine.js (Line 11)

Extends


Members

active: boolean
Focus
Focus

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
Inherited from: Phaser.FX.Controller#active
Since: 3.60.0
Source: src/fx/Controller.js (Line 47)
Focus
Focus

Description:

A reference to the Game Object that owns this effect.

Type:
Inherited from: Phaser.FX.Controller#gameObject
Since: 3.60.0
Source: src/fx/Controller.js (Line 38)
Focus
Focus
gradient: number
Focus
Focus

Description:

The gradient of the Shine effect.

Type:
number
Since: 3.60.0
Source: src/fx/Shine.js (Line 76)
Focus
Focus
lineWidth: number
Focus
Focus

Description:

The line width of the Shine effect.

Type:
number
Since: 3.60.0
Source: src/fx/Shine.js (Line 67)
Focus
Focus
reveal: boolean
Focus
Focus

Description:

Does this Shine effect reveal or get added to its target?

Type:
boolean
Since: 3.60.0
Source: src/fx/Shine.js (Line 85)
Focus
Focus
speed: number
Focus
Focus

Description:

The speed of the Shine effect.

Type:
number
Since: 3.60.0
Source: src/fx/Shine.js (Line 58)
Focus
Focus
type: number
Focus
Focus

Description:

The FX_CONST type of this effect.

Type:
number
Inherited from: Phaser.FX.Controller#type
Since: 3.60.0
Source: src/fx/Controller.js (Line 29)
Focus
Focus

Methods

destroy()
Focus
Focus

Description:

Destroys this FX Controller.

Inherited from: Phaser.FX.Controller#destroy
Since: 3.60.0
Source: src/fx/Controller.js (Line 81)
Focus
Focus
setActive(value)
Focus
Focus

Description:

Sets the active state of this FX Controller.

A disabled FX Controller will not be updated.

Parameters:

name type description
value boolean

true to enable this FX Controller, or false to disable it.

Returns:
Description:

This FX Controller instance.

Inherited from: Phaser.FX.Controller#setActive
Since: 3.60.0
Source: src/fx/Controller.js (Line 62)
Focus
Focus