hide

Type Event
Revision Release 2022.3683
Keywords composer, scene, hide, event
See also composer.*
composer.gotoScene()
composer.hideOverlay()

Overview

This event is dispatched to the currently active scene when a new scene is called via composer.gotoScene() or an overlay scene is hidden via composer.hideOverlay().

For this event, event.phase is the string value of "will" when the scene is on screen (but is about to go off screen). In contrast, event.phase will be the string value of "did" immediately after the scene goes off screen. If a scene transition effect is specified for the new scene or the overlay, the "will" phase is dispatched before the effect begins execution and the "did" phase is dispatched after the effect is finished.

Properties

event.phase