You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/scene/typedefs/SceneTransitionConfig.js
+2-1Lines changed: 2 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -5,10 +5,11 @@
5
5
* @property {string} target - The Scene key to transition to.
6
6
* @property {integer} [duration=1000] - The duration, in ms, for the transition to last.
7
7
* @property {boolean} [sleep=false] - Will the Scene responsible for the transition be sent to sleep on completion (`true`), or stopped? (`false`)
8
+
* @property {boolean} [remove=false] - Will the Scene responsible for the transition be removed from the Scene Manager after the transition completes?
8
9
* @property {boolean} [allowInput=false] - Will the Scenes Input system be able to process events while it is transitioning in or out?
9
10
* @property {boolean} [moveAbove] - Move the target Scene to be above this one before the transition starts.
10
11
* @property {boolean} [moveBelow] - Move the target Scene to be below this one before the transition starts.
11
12
* @property {function} [onUpdate] - This callback is invoked every frame for the duration of the transition.
12
13
* @property {any} [onUpdateScope] - The context in which the callback is invoked.
13
-
* @property {any} [data] - An object containing any data you wish to be passed to the target Scenes init / create methods.
14
+
* @property {any} [data] - An object containing any data you wish to be passed to the target scene's init / create methods (if sleep is false) or to the target scene's wake event callback (if sleep is true).
0 commit comments