mirror of
https://github.com/pagefaultgames/pokerogue.git
synced 2025-09-10 00:29:29 +02:00
add missing doc
This commit is contained in:
parent
256cc56daf
commit
5a4c13e70d
@ -65,6 +65,14 @@ const tutorialHandlers = {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Run through the specified tutorial if it hasn't been seen before and mark it as seen once done
|
||||||
|
* This will show a tutorial overlay if defined in the current {@linkcode AwaitableUiHandler}
|
||||||
|
* The main menu will also get disabled while the tutorial is running
|
||||||
|
* @param scene the current {@linkcode BattleScene}
|
||||||
|
* @param tutorial the {@linkcode Tutorial} to play
|
||||||
|
* @returns a promise with result true is the tutorial was run and finished, false otherwise
|
||||||
|
*/
|
||||||
export async function handleTutorial(scene: BattleScene, tutorial: Tutorial): Promise<boolean> {
|
export async function handleTutorial(scene: BattleScene, tutorial: Tutorial): Promise<boolean> {
|
||||||
if (!scene.enableTutorials && !Overrides.BYPASS_TUTORIAL_SKIP) {
|
if (!scene.enableTutorials && !Overrides.BYPASS_TUTORIAL_SKIP) {
|
||||||
return false;
|
return false;
|
||||||
|
Loading…
Reference in New Issue
Block a user