-
Notifications
You must be signed in to change notification settings - Fork 7.1k
/
SHAKE_START_EVENT.js
33 lines (32 loc) · 1 KB
/
SHAKE_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
/**
* @author Richard Davey <rich@phaser.io>
* @copyright 2013-2024 Phaser Studio Inc.
* @license {@link https://opensource.org/licenses/MIT|MIT License}
*/
/**
* The Camera Shake Start Event.
*
* This event is dispatched by a Camera instance when the Shake Effect starts.
*
* Listen for it via either of the following:
*
* ```js
* this.cameras.main.on('camerashakestart', () => {});
* ```
*
* or use the constant, to avoid having to remember the correct event string:
*
* ```js
* this.cameras.main.on(Phaser.Cameras.Scene2D.Events.SHAKE_START, () => {});
* ```
*
* @event Phaser.Cameras.Scene2D.Events#SHAKE_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.Shake} effect - A reference to the effect instance.
* @param {number} duration - The duration of the effect.
* @param {number} intensity - The intensity of the effect.
*/
module.exports = 'camerashakestart';