Phaser API Documentation

  Version: 
Event: FLASH_START
Phaser.Cameras.Scene2D.Events.FLASH_START
FLASH_START

Description:

The Camera Flash Start Event.

This event is dispatched by a Camera instance when the Flash Effect starts.

Listen for it via either of the following:

this.cameras.main.on('cameraflashstart', () => {});

or use the constant, to avoid having to remember the correct event string:

this.cameras.main.on(Phaser.Cameras.Scene2D.Events.FLASH_START, () => {});

Parameters:

name type description
camera Phaser.Cameras.Scene2D.Camera

The camera that the effect began on.

effect Phaser.Cameras.Scene2D.Effects.Flash

A reference to the effect instance.

duration number

The duration of the effect.

red number

The red color channel value.

green number

The green color channel value.

blue number

The blue color channel value.

Since: 3.3.0