Phaser API Documentation

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

Description:

The Camera Fade Out Start Event.

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

Listen to it from a Camera instance using Camera.on('camerafadeoutstart', listener).

Parameters:

name type description
camera Phaser.Cameras.Scene2D.Camera

The camera that the effect began on.

effect Phaser.Cameras.Scene2D.Effects.Fade

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