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 | optional | default | description |
|---|---|---|---|---|
gameObject | No | A reference to the Game Object that has this fx. | ||
speed | number | Yes | 0.5 | The speed of the Shine effect. |
lineWidth | number | Yes | 0.5 | The line width of the Shine effect. |
gradient | number | Yes | 3 | The gradient of the Shine effect. |
reveal | boolean | Yes | false | Does this Shine effect reveal or get added to its target? |
Scope: static
Extends
Source: src/fx/Shine.js#L11
Since: 3.60.0
Public Members
active
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.
Inherits: Phaser.FX.Controller#active
Source: src/fx/Controller.js#L47
Since: 3.60.0
gameObject
gameObject: Phaser.GameObjects.GameObject
Description:
A reference to the Game Object that owns this effect.
Inherits: Phaser.FX.Controller#gameObject
Source: src/fx/Controller.js#L38
Since: 3.60.0
gradient
gradient: number
Description:
The gradient of the Shine effect.
Source: src/fx/Shine.js#L76
Since: 3.60.0
lineWidth
lineWidth: number
Description:
The line width of the Shine effect.
Source: src/fx/Shine.js#L67
Since: 3.60.0
reveal
reveal: boolean
Description:
Does this Shine effect reveal or get added to its target?
Source: src/fx/Shine.js#L85
Since: 3.60.0
speed
speed: number
Description:
The speed of the Shine effect.
Source: src/fx/Shine.js#L58
Since: 3.60.0
type
type: number
Description:
The FX_CONST type of this effect.
Inherits: Phaser.FX.Controller#type
Source: src/fx/Controller.js#L29
Since: 3.60.0
Public Methods
destroy
<instance> destroy()
Description:
Destroys this FX Controller.
Inherits: Phaser.FX.Controller#destroy
Source: src/fx/Controller.js#L81
Since: 3.60.0
setActive
<instance> setActive(value)
Description:
Sets the active state of this FX Controller.
A disabled FX Controller will not be updated.
Parameters:
name | type | optional | description |
|---|---|---|---|
value | boolean | No |
|
Returns: Phaser.FX.Shine - This FX Controller instance.
Inherits: Phaser.FX.Controller#setActive
Source: src/fx/Controller.js#L62
Since: 3.60.0