mika/pokerogue
1
0
Fork 0
mirror of https://github.com/pagefaultgames/pokerogue.git synced 2025-09-10 00:29:29 +02:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation based on suggestions

Browse Source 
Co-authored-by: NightKev <34855794+DayKev@users.noreply.github.com>
This commit is contained in:
MokaStitcher 2024-09-16 17:39:52 +02:00 committed by GitHub
parent 9e3ca62b97
commit 6fa97fb745
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/overrides.ts
View File

@ -70,7 +70,7 @@ class DefaultOverrides {
[PokeballType.MASTER_BALL]: 0, [PokeballType.MASTER_BALL]: 0,
}, },
}; };
/** Set to true to show all tutorials */ /** Set to `true` to show all tutorials */
readonly BYPASS_TUTORIAL_SKIP: boolean = false; readonly BYPASS_TUTORIAL_SKIP: boolean = false;
// ---------------- // ----------------

6
src/tutorial.ts
View File

@ -71,7 +71,7 @@ const tutorialHandlers = {
* The main menu will also get disabled while the tutorial is running * The main menu will also get disabled while the tutorial is running
* @param scene the current {@linkcode BattleScene} * @param scene the current {@linkcode BattleScene}
* @param tutorial the {@linkcode Tutorial} to play * @param tutorial the {@linkcode Tutorial} to play
* @returns a promise with result true is the tutorial was run and finished, false otherwise * @returns a promise with result `true` if 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) {
@ -109,7 +109,7 @@ export async function handleTutorial(scene: BattleScene, tutorial: Tutorial): Pr
* Show the tutorial overlay if there is one * Show the tutorial overlay if there is one
* @param scene the current BattleScene * @param scene the current BattleScene
* @param handler the current UiHandler * @param handler the current UiHandler
* @returns true once the overlay has finished appearing, or if there is no overlay * @returns `true` once the overlay has finished appearing, or if there is no overlay
*/ */
async function showTutorialOverlay(scene: BattleScene, handler: UiHandler) { async function showTutorialOverlay(scene: BattleScene, handler: UiHandler) {
if (handler instanceof AwaitableUiHandler && handler.tutorialOverlay) { if (handler instanceof AwaitableUiHandler && handler.tutorialOverlay) {
@ -131,7 +131,7 @@ async function showTutorialOverlay(scene: BattleScene, handler: UiHandler) {
* Hide the tutorial overlay if there is one * Hide the tutorial overlay if there is one
* @param scene the current BattleScene * @param scene the current BattleScene
* @param handler the current UiHandler * @param handler the current UiHandler
* @returns true once the overlay has finished disappearing, or if there is no overlay * @returns `true` once the overlay has finished disappearing, or if there is no overlay
*/ */
async function hideTutorialOverlay(scene: BattleScene, handler: UiHandler) { async function hideTutorialOverlay(scene: BattleScene, handler: UiHandler) {
if (handler instanceof AwaitableUiHandler && handler.tutorialOverlay) { if (handler instanceof AwaitableUiHandler && handler.tutorialOverlay) {