Flash
A Camera Flash effect.
This effect will flash the camera viewport to the given color, over the duration specified.
Only the camera viewport is flashed. None of the objects it is displaying are impacted, i.e. their colors do
not change.
The effect will dispatch several events on the Camera itself and you can also specify an onUpdate callback,
which is invoked each frame for the duration of the effect, if required.
Constructor
new Flash(camera)
Parameters
| name | type | optional | description |
|---|---|---|---|
| camera | Phaser.Cameras.Scene2D.Camera | No | The camera this effect is acting upon. |
Scope: static
Source: src/cameras/2d/effects/Flash.js#L11
Since: 3.5.0
Public Members
alpha
alpha: number
Description:
The value of the alpha channel used during the flash effect.
A value between 0 and 1.
Source: src/cameras/2d/effects/Flash.js#L101
Since: 3.5.0
camera
camera: Phaser.Cameras.Scene2D.Camera
Description:
The Camera this effect belongs to.
Source: src/cameras/2d/effects/Flash.js#L36
Since: 3.5.0
duration
duration: number
Description:
The duration of the effect, in milliseconds.
Source: src/cameras/2d/effects/Flash.js#L57
Since: 3.5.0
isRunning
isRunning: boolean
Description:
Is this effect actively running?
Source: src/cameras/2d/effects/Flash.js#L46
Since: 3.5.0
progress
progress: number
Description:
If this effect is running this holds the current percentage of the progress, a value between 0 and 1.
Source: src/cameras/2d/effects/Flash.js#L111
Since: 3.5.0
Public Methods
destroy
<instance> destroy()
Description:
Destroys this effect, releasing it from the Camera.
Source: src/cameras/2d/effects/Flash.js#L322
Since: 3.5.0
effectComplete
<instance> effectComplete()
Description:
Called internally when the effect completes.
Fires: Phaser.Cameras.Scene2D.Events#event:FLASH_COMPLETE
Source: src/cameras/2d/effects/Flash.js#L289
Since: 3.5.0
postRenderCanvas
<instance> postRenderCanvas(ctx)
Description:
Called internally by the Canvas Renderer.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| ctx | CanvasRenderingContext2D | No | The Canvas context to render to. |
Returns: boolean - true if the effect drew to the renderer, otherwise false.
Source: src/cameras/2d/effects/Flash.js#L251
Since: 3.5.0
postRenderWebGL
<instance> postRenderWebGL()
Description:
Called internally by the WebGL Renderer.
Returns: boolean - true if the effect should draw to the renderer, otherwise false.
Source: src/cameras/2d/effects/Flash.js#L276
Since: 3.5.0
reset
<instance> reset()
Description:
Resets this camera effect.
If it was previously running, it stops instantly without calling its onComplete callback or emitting an event.
Source: src/cameras/2d/effects/Flash.js#L307
Since: 3.5.0
start
<instance> start([duration], [red], [green], [blue], [force], [callback], [context])
Description:
Flashes the Camera to or from the given color over the duration specified.
Parameters:
| name | type | optional | default | description |
|---|---|---|---|---|
| duration | number | Yes | 250 | The duration of the effect in milliseconds. |
| red | number | Yes | 255 | The amount to flash the red channel towards. A value between 0 and 255. |
| green | number | Yes | 255 | The amount to flash the green channel towards. A value between 0 and 255. |
| blue | number | Yes | 255 | The amount to flash the blue channel towards. A value between 0 and 255. |
| force | boolean | Yes | false | Force the effect to start immediately, even if already running. |
| callback | Phaser.Types.Cameras.Scene2D.CameraFlashCallback | Yes | This callback will be invoked every frame for the duration of the effect. It is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is. | |
| context | any | Yes | The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs. |
Returns: Phaser.Cameras.Scene2D.Camera - The Camera on which the effect was started.
Fires: Phaser.Cameras.Scene2D.Events#event:FLASH_START, Phaser.Cameras.Scene2D.Events#event:FLASH_COMPLETE
Source: src/cameras/2d/effects/Flash.js#L163
Since: 3.5.0
update
<instance> update(time, delta)
Description:
The main update loop for this effect. Called automatically by the Camera.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| time | number | No | The current timestamp as generated by the Request Animation Frame or SetTimeout. |
| delta | number | No | The delta time, in ms, elapsed since the last frame. |
Source: src/cameras/2d/effects/Flash.js#L216
Since: 3.5.0