Phaser API Documentation

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

Description:

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:

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

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

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

Parameters:

name type description
camera Phaser.Cameras.Scene2D.Camera

The camera that the effect began on.

effect Phaser.Cameras.Scene2D.Effects.Shake

A reference to the effect instance.

duration number

The duration of the effect.

intensity number

The intensity of the effect.

Since: 3.3.0