Phaser API Documentation

  Version: 
addShine([speed], [lineWidth], [gradient], [reveal])

Description:

Adds a Shine effect.

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.

Parameters:

name type arguments Default description
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?

Returns:
Description:

The Shine FX Controller.

Since: 3.60.0