Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-12-23 03:23:42 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add typedef of onStart parameter

Browse source
This commit is contained in:
Rex 2022-02-28 22:44:18 +08:00
parent 558589f851
commit b1916a9d14
2 changed files with 10 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/scene/typedefs/SceneTransitionConfig.js
View file

@ -11,7 +11,7 @@
* @property {boolean} [moveBelow] - Move the target Scene to be below this one before the transition starts.
* @property {function} [onUpdate] - This callback is invoked every frame for the duration of the transition.
* @property {any} [onUpdateScope] - The context in which the callback is invoked.
* @property {function} [onStart] - This callback is invoked when transition starting.
* @property {Phaser.Types.Scenes.SceneTransitionStartCallback} [onStart] - This callback is invoked when transition starting.
* @property {any} [onStartScope] - The context in which the callback is invoked.
* @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).
*/

9
src/scene/typedefs/SceneTransitionStartCallback.js Normal file
View file

@ -0,0 +1,9 @@
/**
* @callback Phaser.Types.Scenes.SceneTransitionOnStartCallback
* @since 3.60.0
*
* @this Phaser.Scene
* @param {Phaser.Scene} fromScene - Scene instance to transition from.
* @param {Phaser.Scene} toScene - Scene instance to transition to.
* @property {number} [duration=1000] - The duration, in ms, for the transition to last.
*/