random-mirrors/pokerogue
1
0
Fork 0
mirror of https://github.com/pagefaultgames/pokerogue.git synced 2024-12-02 11:46:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

improve jsdocs in myster-encounter.ts

Browse Source
This commit is contained in:
Felix Staud 2024-07-11 07:50:58 -07:00
parent 5ff1ae617d
commit 0f9c0c5d24
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/data/mystery-encounters/mystery-encounter.ts
View File

@ -356,6 +356,7 @@ export class MysteryEncounterBuilder implements Partial<MysteryEncounter> {
doEncounterExp?: (scene: BattleScene) => boolean; doEncounterExp?: (scene: BattleScene) => boolean;
doEncounterRewards?: (scene: BattleScene) => boolean; doEncounterRewards?: (scene: BattleScene) => boolean;
onInit?: (scene: BattleScene) => boolean; onInit?: (scene: BattleScene) => boolean;
onDone?: (scene: BattleScene) => boolean;
hideBattleIntroMessage?: boolean; hideBattleIntroMessage?: boolean;
hideIntroVisuals?: boolean; hideIntroVisuals?: boolean;
enemyPartyConfigs?: EnemyPartyConfig[] = []; enemyPartyConfigs?: EnemyPartyConfig[] = [];
@ -374,8 +375,11 @@ export class MysteryEncounterBuilder implements Partial<MysteryEncounter> {
} }
/** /**
* Defines an option for the encounter * Defines an option for the encounter.
* There should be at least 2 options defined and no more than 4 * Use for complex options.
* There should be at least 2 options defined and no more than 4.
* If easy/streamlined use {@linkcode MysteryEncounterBuilder.withOptionPhase}
*
* @param option - MysteryEncounterOption to add, can use MysteryEncounterOptionBuilder to create instance * @param option - MysteryEncounterOption to add, can use MysteryEncounterOptionBuilder to create instance
* @returns * @returns
*/ */
@ -391,8 +395,10 @@ export class MysteryEncounterBuilder implements Partial<MysteryEncounter> {
} }
/** /**
* Adds a streamlined option phase. * Defines an option + phasefor the encounter.
* Only use if no pre-/post-options or condtions necessary. * Use for easy/streamlined options.
* There should be at least 2 options defined and no more than 4.
* If complex use {@linkcode MysteryEncounterBuilder.withOption}
* *
* @param callback - OptionPhaseCallback * @param callback - OptionPhaseCallback
* @returns * @returns