-
Notifications
You must be signed in to change notification settings - Fork 7.1k
/
FLASH_START_EVENT.js
35 lines (34 loc) · 1.11 KB
/
FLASH_START_EVENT.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
/**
* @author Richard Davey <rich@phaser.io>
* @copyright 2013-2024 Phaser Studio Inc.
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
/**
* 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:
*
* ```js
* this.cameras.main.on('cameraflashstart', () => {});
* ```
*
* or use the constant, to avoid having to remember the correct event string:
*
* ```js
* this.cameras.main.on(Phaser.Cameras.Scene2D.Events.FLASH_START, () => {});
* ```
*
* @event Phaser.Cameras.Scene2D.Events#FLASH_START
* @type {string}
* @since 3.3.0
*
* @param {Phaser.Cameras.Scene2D.Camera} camera - The camera that the effect began on.
* @param {Phaser.Cameras.Scene2D.Effects.Flash} effect - A reference to the effect instance.
* @param {number} duration - The duration of the effect.
* @param {number} red - The red color channel value.
* @param {number} green - The green color channel value.
* @param {number} blue - The blue color channel value.
*/
module.exports = 'cameraflashstart';