173 lines
190 KiB
HTML
173 lines
190 KiB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MysteryEncounterBuilder | pokemon-rogue-battle</title><meta name="description" content="Documentation for pokemon-rogue-battle"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">pokemon-rogue-battle</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">pokemon-rogue-battle</a></li><li><a href="../modules/data_mystery_encounters_mystery_encounter.html">data/mystery-encounters/mystery-encounter</a></li><li><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html">MysteryEncounterBuilder</a></li></ul><h1>Class MysteryEncounterBuilder</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Builder class for creating a MysteryEncounter
|
||
must call <code>build()</code> at the end after specifying all params for the MysteryEncounter</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">></span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L533">src/data/mystery-encounters/mystery-encounter.ts:533</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
||
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#autoHideIntroVisuals" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Hide<wbr/>Intro<wbr/>Visuals</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#catchAllowed" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>catch<wbr/>Allowed</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#continuousEncounter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>continuous<wbr/>Encounter</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#dialogue" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dialogue</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#dialogueTokens" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dialogue<wbr/>Tokens</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#enemyPartyConfigs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enemy<wbr/>Party<wbr/>Configs</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#enterIntroVisualsFromRight" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enter<wbr/>Intro<wbr/>Visuals<wbr/>From<wbr/>Right</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#excludePrimaryFromSupportRequirements" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>exclude<wbr/>Primary<wbr/>From<wbr/>Support<wbr/>Requirements</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#expMultiplier" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>exp<wbr/>Multiplier</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#fleeAllowed" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>flee<wbr/>Allowed</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#hasBattleAnimationsWithoutTargets" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has<wbr/>Battle<wbr/>Animations<wbr/>Without<wbr/>Targets</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#hideBattleIntroMessage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hide<wbr/>Battle<wbr/>Intro<wbr/>Message</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#localizationKey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>localization<wbr/>Key</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#lockEncounterRewardTiers" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>lock<wbr/>Encounter<wbr/>Reward<wbr/>Tiers</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#maxAllowedEncounters" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Allowed<wbr/>Encounters</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#options" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#preventGameStatsUpdates" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prevent<wbr/>Game<wbr/>Stats<wbr/>Updates</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#primaryPokemonRequirements" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>primary<wbr/>Pokemon<wbr/>Requirements</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#requirements" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>requirements</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#secondaryPokemonRequirements" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>secondary<wbr/>Pokemon<wbr/>Requirements</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#skipEnemyBattleTurns" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>skip<wbr/>Enemy<wbr/>Battle<wbr/>Turns</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#skipToFightInput" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>skip<wbr/>To<wbr/>Fight<wbr/>Input</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#startOfBattleEffectsComplete" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>start<wbr/>Of<wbr/>Battle<wbr/>Effects<wbr/>Complete</span></a>
|
||
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#build" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#setLocalizationKey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Localization<wbr/>Key</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withAnimations" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Animations</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withAutoHideIntroVisuals" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Auto<wbr/>Hide<wbr/>Intro<wbr/>Visuals</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withBattleAnimationsWithoutTargets" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Battle<wbr/>Animations<wbr/>Without<wbr/>Targets</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withCatchAllowed" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Catch<wbr/>Allowed</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withContinuousEncounter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Continuous<wbr/>Encounter</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withDescription" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Description</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withDisallowedChallenges" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Disallowed<wbr/>Challenges</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withDisallowedGameModes" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Disallowed<wbr/>Game<wbr/>Modes</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withEncounterTier" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Encounter<wbr/>Tier</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withEnterIntroVisualsFromRight" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Enter<wbr/>Intro<wbr/>Visuals<wbr/>From<wbr/>Right</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withExp" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Exp</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withFleeAllowed" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Flee<wbr/>Allowed</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withHideWildIntroMessage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Hide<wbr/>Wild<wbr/>Intro<wbr/>Message</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withIntro" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Intro</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withIntroDialogue" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Intro<wbr/>Dialogue</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withIntroSpriteConfigs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Intro<wbr/>Sprite<wbr/>Configs</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withMaxAllowedEncounters" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Max<wbr/>Allowed<wbr/>Encounters</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withOnInit" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>On<wbr/>Init</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withOnVisualsStart" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>On<wbr/>Visuals<wbr/>Start</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withOption" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Option</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withOutroDialogue" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Outro<wbr/>Dialogue</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withPreventGameStatsUpdates" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Prevent<wbr/>Game<wbr/>Stats<wbr/>Updates</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withPrimaryPokemonHealthRatioRequirement" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Primary<wbr/>Pokemon<wbr/>Health<wbr/>Ratio<wbr/>Requirement</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withPrimaryPokemonRequirement" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Primary<wbr/>Pokemon<wbr/>Requirement</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withPrimaryPokemonStatusEffectRequirement" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Primary<wbr/>Pokemon<wbr/>Status<wbr/>Effect<wbr/>Requirement</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withQuery" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Query</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withRewards" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Rewards</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withScenePartySizeRequirement" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Scene<wbr/>Party<wbr/>Size<wbr/>Requirement</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withSceneRequirement" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Scene<wbr/>Requirement</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withSceneWaveRangeRequirement" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Scene<wbr/>Wave<wbr/>Range<wbr/>Requirement</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withSecondaryPokemonRequirement" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Secondary<wbr/>Pokemon<wbr/>Requirement</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withSimpleDexProgressOption" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Simple<wbr/>Dex<wbr/>Progress<wbr/>Option</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withSimpleOption" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Simple<wbr/>Option</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withSkipEnemyBattleTurns" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Skip<wbr/>Enemy<wbr/>Battle<wbr/>Turns</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withSkipToFightInput" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Skip<wbr/>To<wbr/>Fight<wbr/>Input</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withTitle" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Title</span></a>
|
||
<a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withEncounterType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Encounter<wbr/>Type</span></a>
|
||
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_MysteryEncounterBuilder" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Mystery<wbr/>Encounter<wbr/>Builder</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><a href="#constructor.new_MysteryEncounterBuilder" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a></h4></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="autoHideIntroVisuals" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>auto<wbr/>Hide<wbr/>Intro<wbr/>Visuals</span><a href="#autoHideIntroVisuals" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">auto<wbr/>Hide<wbr/>Intro<wbr/>Visuals</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div><aside class="tsd-sources"><p>Implementation of Partial.autoHideIntroVisuals</p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L546">src/data/mystery-encounters/mystery-encounter.ts:546</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="catchAllowed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>catch<wbr/>Allowed</span><a href="#catchAllowed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">catch<wbr/>Allowed</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><p>Implementation of Partial.catchAllowed</p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L549">src/data/mystery-encounters/mystery-encounter.ts:549</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="continuousEncounter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>continuous<wbr/>Encounter</span><a href="#continuousEncounter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">continuous<wbr/>Encounter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><p>Implementation of Partial.continuousEncounter</p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L548">src/data/mystery-encounters/mystery-encounter.ts:548</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="dialogue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>dialogue</span><a href="#dialogue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">dialogue</span><span class="tsd-signature-symbol">:</span> <a href="data_mystery_encounters_mystery_encounter_dialogue.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol"> = {}</span></div><aside class="tsd-sources"><p>Implementation of Partial.dialogue</p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L538">src/data/mystery-encounters/mystery-encounter.ts:538</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="dialogueTokens" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>dialogue<wbr/>Tokens</span><a href="#dialogueTokens" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">dialogue<wbr/>Tokens</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = {}</span></div><aside class="tsd-sources"><p>Implementation of Partial.dialogueTokens</p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L543">src/data/mystery-encounters/mystery-encounter.ts:543</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="enemyPartyConfigs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>enemy<wbr/>Party<wbr/>Configs</span><a href="#enemyPartyConfigs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">enemy<wbr/>Party<wbr/>Configs</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/data_mystery_encounters_utils_encounter_phase_utils.EnemyPartyConfig.html" class="tsd-signature-type tsd-kind-interface">EnemyPartyConfig</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><aside class="tsd-sources"><p>Implementation of Partial.enemyPartyConfigs</p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L535">src/data/mystery-encounters/mystery-encounter.ts:535</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="enterIntroVisualsFromRight" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>enter<wbr/>Intro<wbr/>Visuals<wbr/>From<wbr/>Right</span><a href="#enterIntroVisualsFromRight" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">enter<wbr/>Intro<wbr/>Visuals<wbr/>From<wbr/>Right</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><p>Implementation of Partial.enterIntroVisualsFromRight</p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L547">src/data/mystery-encounters/mystery-encounter.ts:547</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="excludePrimaryFromSupportRequirements" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>exclude<wbr/>Primary<wbr/>From<wbr/>Support<wbr/>Requirements</span><a href="#excludePrimaryFromSupportRequirements" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">exclude<wbr/>Primary<wbr/>From<wbr/>Support<wbr/>Requirements</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div><aside class="tsd-sources"><p>Implementation of Partial.excludePrimaryFromSupportRequirements</p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L542">src/data/mystery-encounters/mystery-encounter.ts:542</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="expMultiplier" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>exp<wbr/>Multiplier</span><a href="#expMultiplier" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">exp<wbr/>Multiplier</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></div><aside class="tsd-sources"><p>Implementation of Partial.expMultiplier</p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L558">src/data/mystery-encounters/mystery-encounter.ts:558</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fleeAllowed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>flee<wbr/>Allowed</span><a href="#fleeAllowed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">flee<wbr/>Allowed</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div><aside class="tsd-sources"><p>Implementation of Partial.fleeAllowed</p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L550">src/data/mystery-encounters/mystery-encounter.ts:550</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="hasBattleAnimationsWithoutTargets" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has<wbr/>Battle<wbr/>Animations<wbr/>Without<wbr/>Targets</span><a href="#hasBattleAnimationsWithoutTargets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">has<wbr/>Battle<wbr/>Animations<wbr/>Without<wbr/>Targets</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><p>Implementation of Partial.hasBattleAnimationsWithoutTargets</p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L553">src/data/mystery-encounters/mystery-encounter.ts:553</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="hideBattleIntroMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>hide<wbr/>Battle<wbr/>Intro<wbr/>Message</span><a href="#hideBattleIntroMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hide<wbr/>Battle<wbr/>Intro<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><p>Implementation of Partial.hideBattleIntroMessage</p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L545">src/data/mystery-encounters/mystery-encounter.ts:545</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="localizationKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>localization<wbr/>Key</span><a href="#localizationKey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">localization<wbr/>Key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L537">src/data/mystery-encounters/mystery-encounter.ts:537</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="lockEncounterRewardTiers" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>lock<wbr/>Encounter<wbr/>Reward<wbr/>Tiers</span><a href="#lockEncounterRewardTiers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">lock<wbr/>Encounter<wbr/>Reward<wbr/>Tiers</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L551">src/data/mystery-encounters/mystery-encounter.ts:551</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="maxAllowedEncounters" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>max<wbr/>Allowed<wbr/>Encounters</span><a href="#maxAllowedEncounters" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">max<wbr/>Allowed<wbr/>Encounters</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 3</span></div><aside class="tsd-sources"><p>Implementation of Partial.maxAllowedEncounters</p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L557">src/data/mystery-encounters/mystery-encounter.ts:557</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="options" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>options</span><a href="#options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><a href="data_mystery_encounters_mystery_encounter_option.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">, </span><a href="data_mystery_encounters_mystery_encounter_option.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">...</span><a href="data_mystery_encounters_mystery_encounter_option.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">]</span></div><aside class="tsd-sources"><p>Implementation of Partial.options</p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L534">src/data/mystery-encounters/mystery-encounter.ts:534</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="preventGameStatsUpdates" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>prevent<wbr/>Game<wbr/>Stats<wbr/>Updates</span><a href="#preventGameStatsUpdates" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prevent<wbr/>Game<wbr/>Stats<wbr/>Updates</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><p>Implementation of Partial.preventGameStatsUpdates</p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L556">src/data/mystery-encounters/mystery-encounter.ts:556</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="primaryPokemonRequirements" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>primary<wbr/>Pokemon<wbr/>Requirements</span><a href="#primaryPokemonRequirements" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">primary<wbr/>Pokemon<wbr/>Requirements</span><span class="tsd-signature-symbol">:</span> <a href="data_mystery_encounters_mystery_encounter_requirements.EncounterPokemonRequirement.html" class="tsd-signature-type tsd-kind-class">EncounterPokemonRequirement</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><aside class="tsd-sources"><p>Implementation of Partial.primaryPokemonRequirements</p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L540">src/data/mystery-encounters/mystery-encounter.ts:540</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="requirements" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>requirements</span><a href="#requirements" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">requirements</span><span class="tsd-signature-symbol">:</span> <a href="data_mystery_encounters_mystery_encounter_requirements.EncounterSceneRequirement.html" class="tsd-signature-type tsd-kind-class">EncounterSceneRequirement</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><aside class="tsd-sources"><p>Implementation of Partial.requirements</p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L539">src/data/mystery-encounters/mystery-encounter.ts:539</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="secondaryPokemonRequirements" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>secondary<wbr/>Pokemon<wbr/>Requirements</span><a href="#secondaryPokemonRequirements" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">secondary<wbr/>Pokemon<wbr/>Requirements</span><span class="tsd-signature-symbol">:</span> <a href="data_mystery_encounters_mystery_encounter_requirements.EncounterPokemonRequirement.html" class="tsd-signature-type tsd-kind-class">EncounterPokemonRequirement</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><aside class="tsd-sources"><p>Implementation of Partial.secondaryPokemonRequirements</p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L541">src/data/mystery-encounters/mystery-encounter.ts:541</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="skipEnemyBattleTurns" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>skip<wbr/>Enemy<wbr/>Battle<wbr/>Turns</span><a href="#skipEnemyBattleTurns" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">skip<wbr/>Enemy<wbr/>Battle<wbr/>Turns</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><p>Implementation of Partial.skipEnemyBattleTurns</p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L554">src/data/mystery-encounters/mystery-encounter.ts:554</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="skipToFightInput" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>skip<wbr/>To<wbr/>Fight<wbr/>Input</span><a href="#skipToFightInput" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">skip<wbr/>To<wbr/>Fight<wbr/>Input</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><p>Implementation of Partial.skipToFightInput</p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L555">src/data/mystery-encounters/mystery-encounter.ts:555</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="startOfBattleEffectsComplete" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>start<wbr/>Of<wbr/>Battle<wbr/>Effects<wbr/>Complete</span><a href="#startOfBattleEffectsComplete" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">start<wbr/>Of<wbr/>Battle<wbr/>Effects<wbr/>Complete</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L552">src/data/mystery-encounters/mystery-encounter.ts:552</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="build" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>build</span><a href="#build" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="build.build-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">build</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.default.html" class="tsd-signature-type tsd-kind-class">default</a><a href="#build.build-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Builds the mystery encounter</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">this</span>: <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.default.html" class="tsd-signature-type tsd-kind-class">default</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L1020">src/data/mystery-encounters/mystery-encounter.ts:1020</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setLocalizationKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Localization<wbr/>Key</span><a href="#setLocalizationKey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setLocalizationKey.setLocalizationKey-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Localization<wbr/>Key</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">localizationKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#setLocalizationKey.setLocalizationKey-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the localization key used by the encounter</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">localizationKey</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the string used as the key</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code></p>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L648">src/data/mystery-encounters/mystery-encounter.ts:648</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withAnimations" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Animations</span><a href="#withAnimations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withAnimations.withAnimations-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Animations</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">encounterAnimations</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"encounterAnimations"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#withAnimations.withAnimations-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Defines any EncounterAnim animations that are intended to be used during the encounter
|
||
EncounterAnims are custom battle animations (think Ice Beam) that can be played at any point during an encounter or callback
|
||
They just need to be specified here so that resources are loaded on encounter init</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">encounterAnimations</span>: <a href="../enums/enums_encounter_anims.EncounterAnim.html" class="tsd-signature-type tsd-kind-enum">EncounterAnim</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"encounterAnimations"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L680">src/data/mystery-encounters/mystery-encounter.ts:680</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withAutoHideIntroVisuals" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Auto<wbr/>Hide<wbr/>Intro<wbr/>Visuals</span><a href="#withAutoHideIntroVisuals" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withAutoHideIntroVisuals.withAutoHideIntroVisuals-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Auto<wbr/>Hide<wbr/>Intro<wbr/>Visuals</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">autoHideIntroVisuals</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"autoHideIntroVisuals"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#withAutoHideIntroVisuals.withAutoHideIntroVisuals-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">autoHideIntroVisuals</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>If <code>false</code>, will not hide the intro visuals that are displayed at the beginning of encounter</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"autoHideIntroVisuals"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L931">src/data/mystery-encounters/mystery-encounter.ts:931</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withBattleAnimationsWithoutTargets" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Battle<wbr/>Animations<wbr/>Without<wbr/>Targets</span><a href="#withBattleAnimationsWithoutTargets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withBattleAnimationsWithoutTargets.withBattleAnimationsWithoutTargets-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Battle<wbr/>Animations<wbr/>Without<wbr/>Targets</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">hasBattleAnimationsWithoutTargets</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"hasBattleAnimationsWithoutTargets"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#withBattleAnimationsWithoutTargets.withBattleAnimationsWithoutTargets-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>If true, encounter will not animate the target Pokemon as part of battle animations
|
||
Used for encounters where it is not a "real" battle, but still uses battle animations and commands (see FunAndGamesEncounter for an example)
|
||
Default false</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">hasBattleAnimationsWithoutTargets</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"hasBattleAnimationsWithoutTargets"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L721">src/data/mystery-encounters/mystery-encounter.ts:721</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withCatchAllowed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Catch<wbr/>Allowed</span><a href="#withCatchAllowed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withCatchAllowed.withCatchAllowed-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Catch<wbr/>Allowed</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">catchAllowed</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"catchAllowed"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#withCatchAllowed.withCatchAllowed-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Can set whether catching is allowed or not on the encounter
|
||
This flag can also be programmatically set inside option event functions or elsewhere</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">catchAllowed</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>If <code>true</code>, allows enemy pokemon to be caught during the encounter</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"catchAllowed"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L906">src/data/mystery-encounters/mystery-encounter.ts:906</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withContinuousEncounter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Continuous<wbr/>Encounter</span><a href="#withContinuousEncounter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withContinuousEncounter.withContinuousEncounter-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Continuous<wbr/>Encounter</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">continuousEncounter</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"continuousEncounter"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#withContinuousEncounter.withContinuousEncounter-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>If true, encounter will continuously run through multiple battles/puzzles/etc. instead of going to next wave
|
||
MUST EVENTUALLY BE DISABLED TO CONTINUE TO NEXT WAVE
|
||
Default false</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">continuousEncounter</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"continuousEncounter"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L711">src/data/mystery-encounters/mystery-encounter.ts:711</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withDescription" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Description</span><a href="#withDescription" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withDescription.withDescription-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Description</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#withDescription.withDescription-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Add a description of the encounter</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Description of the encounter</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L970">src/data/mystery-encounters/mystery-encounter.ts:970</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withDisallowedChallenges" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Disallowed<wbr/>Challenges</span><a href="#withDisallowedChallenges" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withDisallowedChallenges.withDisallowedChallenges-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Disallowed<wbr/>Challenges</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">disallowedChallenges</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"disallowedChallenges"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#withDisallowedChallenges.withDisallowedChallenges-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Defines any challenges (from Challenge game mode) where the Mystery Encounter should <em>NOT</em> spawn</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">disallowedChallenges</span>: <a href="../enums/enums_challenges.Challenges.html" class="tsd-signature-type tsd-kind-enum">Challenges</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"disallowedChallenges"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L700">src/data/mystery-encounters/mystery-encounter.ts:700</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withDisallowedGameModes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Disallowed<wbr/>Game<wbr/>Modes</span><a href="#withDisallowedGameModes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withDisallowedGameModes.withDisallowedGameModes-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Disallowed<wbr/>Game<wbr/>Modes</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">disallowedGameModes</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"disallowedGameModes"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#withDisallowedGameModes.withDisallowedGameModes-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Defines any game modes where the Mystery Encounter should <em>NOT</em> spawn</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">disallowedGameModes</span>: <a href="../enums/game_mode.GameModes.html" class="tsd-signature-type tsd-kind-enum">GameModes</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"disallowedGameModes"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L690">src/data/mystery-encounters/mystery-encounter.ts:690</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withEncounterTier" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Encounter<wbr/>Tier</span><a href="#withEncounterTier" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withEncounterTier.withEncounterTier-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Encounter<wbr/>Tier</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">encounterTier</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"encounterTier"</span><span class="tsd-signature-symbol">></span><a href="#withEncounterTier.withEncounterTier-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the rarity tier for an encounter
|
||
If not specified, defaults to COMMON
|
||
Tiers are:
|
||
COMMON 32/64 odds
|
||
GREAT 16/64 odds
|
||
ULTRA 10/64 odds
|
||
ROGUE 6/64 odds
|
||
ULTRA_RARE Not currently used</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">encounterTier</span>: <a href="../enums/enums_mystery_encounter_tier.MysteryEncounterTier.html" class="tsd-signature-type tsd-kind-enum">MysteryEncounterTier</a></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"encounterTier"</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L669">src/data/mystery-encounters/mystery-encounter.ts:669</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withEnterIntroVisualsFromRight" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Enter<wbr/>Intro<wbr/>Visuals<wbr/>From<wbr/>Right</span><a href="#withEnterIntroVisualsFromRight" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withEnterIntroVisualsFromRight.withEnterIntroVisualsFromRight-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Enter<wbr/>Intro<wbr/>Visuals<wbr/>From<wbr/>Right</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">enterIntroVisualsFromRight</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"enterIntroVisualsFromRight"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#withEnterIntroVisualsFromRight.withEnterIntroVisualsFromRight-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">enterIntroVisualsFromRight</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>If <code>true</code>, will slide in intro visuals from the right side of the screen. If false, slides in from left, as normal
|
||
Default false</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"enterIntroVisualsFromRight"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L940">src/data/mystery-encounters/mystery-encounter.ts:940</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withExp" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Exp</span><a href="#withExp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withExp.withExp-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Exp</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">doEncounterExp</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"doEncounterExp"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#withExp.withExp-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Can set custom encounter exp via this callback function
|
||
If exp always deterministic for an encounter, this is a good way to set them</p>
|
||
<p>NOTE: If rewards are dependent on options selected, runtime data, etc.,
|
||
It may be better to programmatically set doEncounterExp elsewhere.
|
||
There is a helper function in mystery-encounter utils, setEncounterExp(), which can be called programmatically to set rewards</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">doEncounterExp</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span><span class="tsd-signature-symbol">: </span><a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span></span><div class="tsd-comment tsd-typography"><p>Synchronous callback function to perform during rewards phase of the encounter</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">scene</span>: <a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"doEncounterExp"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L875">src/data/mystery-encounters/mystery-encounter.ts:875</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withFleeAllowed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Flee<wbr/>Allowed</span><a href="#withFleeAllowed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withFleeAllowed.withFleeAllowed-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Flee<wbr/>Allowed</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fleeAllowed</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"fleeAllowed"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#withFleeAllowed.withFleeAllowed-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Can set whether fleeing is allowed or not on the encounter</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fleeAllowed</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>If <code>false</code>, prevents fleeing from a wild battle (trainer battle MEs already have flee disabled)</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"fleeAllowed"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L915">src/data/mystery-encounters/mystery-encounter.ts:915</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withHideWildIntroMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Hide<wbr/>Wild<wbr/>Intro<wbr/>Message</span><a href="#withHideWildIntroMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withHideWildIntroMessage.withHideWildIntroMessage-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Hide<wbr/>Wild<wbr/>Intro<wbr/>Message</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">hideBattleIntroMessage</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"hideBattleIntroMessage"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#withHideWildIntroMessage.withHideWildIntroMessage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">hideBattleIntroMessage</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>If <code>true</code>, will not show the trainerAppeared/wildAppeared/bossAppeared message for an encounter</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"hideBattleIntroMessage"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L923">src/data/mystery-encounters/mystery-encounter.ts:923</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withIntro" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Intro</span><a href="#withIntro" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withIntro.withIntro-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Intro</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><a href="#withIntro.withIntro-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">__namedParameters</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">dialogue</span><span class="tsd-signature-symbol">?: </span><a href="data_mystery_encounters_mystery_encounter_dialogue.TextDisplay.html" class="tsd-signature-type tsd-kind-class">TextDisplay</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">spriteConfigs</span><span class="tsd-signature-symbol">: </span><a href="field_mystery_encounter_intro.MysteryEncounterSpriteConfig.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterSpriteConfig</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">dialogue</span><span class="tsd-signature-symbol">?: </span><a href="data_mystery_encounters_mystery_encounter_dialogue.TextDisplay.html" class="tsd-signature-type tsd-kind-class">TextDisplay</a><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">sprite<wbr/>Configs</span><span class="tsd-signature-symbol">: </span><a href="field_mystery_encounter_intro.MysteryEncounterSpriteConfig.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterSpriteConfig</a><span class="tsd-signature-symbol">[]</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L639">src/data/mystery-encounters/mystery-encounter.ts:639</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withIntroDialogue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Intro<wbr/>Dialogue</span><a href="#withIntroDialogue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withIntroDialogue.withIntroDialogue-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Intro<wbr/>Dialogue</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dialogue</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#withIntroDialogue.withIntroDialogue-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">dialogue</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="data_mystery_encounters_mystery_encounter_dialogue.TextDisplay.html" class="tsd-signature-type tsd-kind-class">TextDisplay</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L634">src/data/mystery-encounters/mystery-encounter.ts:634</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withIntroSpriteConfigs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Intro<wbr/>Sprite<wbr/>Configs</span><a href="#withIntroSpriteConfigs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withIntroSpriteConfigs.withIntroSpriteConfigs-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Intro<wbr/>Sprite<wbr/>Configs</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">spriteConfigs</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"spriteConfigs"</span><span class="tsd-signature-symbol">></span><a href="#withIntroSpriteConfigs.withIntroSpriteConfigs-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Defines the sprites that will be shown on the enemy field when the encounter spawns
|
||
Can be one or more sprites, recommended not to exceed 4</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">spriteConfigs</span>: <a href="field_mystery_encounter_intro.MysteryEncounterSpriteConfig.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterSpriteConfig</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"spriteConfigs"</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L630">src/data/mystery-encounters/mystery-encounter.ts:630</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withMaxAllowedEncounters" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Max<wbr/>Allowed<wbr/>Encounters</span><a href="#withMaxAllowedEncounters" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withMaxAllowedEncounters.withMaxAllowedEncounters-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Max<wbr/>Allowed<wbr/>Encounters</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">maxAllowedEncounters</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"maxAllowedEncounters"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#withMaxAllowedEncounters.withMaxAllowedEncounters-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the maximum number of times that an encounter can spawn in a given Classic run</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">maxAllowedEncounters</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"maxAllowedEncounters"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L757">src/data/mystery-encounters/mystery-encounter.ts:757</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withOnInit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>On<wbr/>Init</span><a href="#withOnInit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withOnInit.withOnInit-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>On<wbr/>Init</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">onInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"onInit"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#withOnInit.withOnInit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Can be used to perform init logic before intro visuals are shown and before the MysteryEncounterPhase begins
|
||
Useful for performing things like procedural generation of intro sprites, etc.</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">onInit</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span><span class="tsd-signature-symbol">: </span><a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span></span><div class="tsd-comment tsd-typography"><p>Synchronous callback function to perform as soon as the encounter is selected for the next phase</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">scene</span>: <a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"onInit"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L886">src/data/mystery-encounters/mystery-encounter.ts:886</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withOnVisualsStart" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>On<wbr/>Visuals<wbr/>Start</span><a href="#withOnVisualsStart" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withOnVisualsStart.withOnVisualsStart-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>On<wbr/>Visuals<wbr/>Start</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">onVisualsStart</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"onVisualsStart"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#withOnVisualsStart.withOnVisualsStart-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Can be used to perform some extra logic (usually animations) when the enemy field is finished sliding in</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">onVisualsStart</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span><span class="tsd-signature-symbol">: </span><a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span></span><div class="tsd-comment tsd-typography"><p>Synchronous callback function to perform as soon as the enemy field finishes sliding in</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">scene</span>: <a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"onVisualsStart"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L896">src/data/mystery-encounters/mystery-encounter.ts:896</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withOption" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Option</span><a href="#withOption" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withOption.withOption-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Option</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">option</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"options"</span><span class="tsd-signature-symbol">></span><a href="#withOption.withOption-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Defines an option for the encounter.
|
||
Use for complex options.
|
||
There should be at least 2 options defined and no more than 4.</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">option</span>: <a href="data_mystery_encounters_mystery_encounter_option.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"><p>MysteryEncounterOption to add, can use MysteryEncounterOptionBuilder to create instance</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"options"</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L582">src/data/mystery-encounters/mystery-encounter.ts:582</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withOutroDialogue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Outro<wbr/>Dialogue</span><a href="#withOutroDialogue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withOutroDialogue.withOutroDialogue-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Outro<wbr/>Dialogue</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dialogue</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#withOutroDialogue.withOutroDialogue-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Add outro dialogue/s for the encounter</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">dialogue</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="data_mystery_encounters_mystery_encounter_dialogue.TextDisplay.html" class="tsd-signature-type tsd-kind-class">TextDisplay</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></span><div class="tsd-comment tsd-typography"><p>Outro dialogue(s)</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L1010">src/data/mystery-encounters/mystery-encounter.ts:1010</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withPreventGameStatsUpdates" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Prevent<wbr/>Game<wbr/>Stats<wbr/>Updates</span><a href="#withPreventGameStatsUpdates" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withPreventGameStatsUpdates.withPreventGameStatsUpdates-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Prevent<wbr/>Game<wbr/>Stats<wbr/>Updates</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">preventGameStatsUpdates</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"preventGameStatsUpdates"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#withPreventGameStatsUpdates.withPreventGameStatsUpdates-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>If true, will prevent updating GameStats for encountering and/or defeating Pokemon
|
||
Default <code>false</code></p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">preventGameStatsUpdates</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"preventGameStatsUpdates"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L748">src/data/mystery-encounters/mystery-encounter.ts:748</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withPrimaryPokemonHealthRatioRequirement" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Primary<wbr/>Pokemon<wbr/>Health<wbr/>Ratio<wbr/>Requirement</span><a href="#withPrimaryPokemonHealthRatioRequirement" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withPrimaryPokemonHealthRatioRequirement.withPrimaryPokemonHealthRatioRequirement-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Primary<wbr/>Pokemon<wbr/>Health<wbr/>Ratio<wbr/>Requirement</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">requiredHealthRange</span>, <span class="tsd-kind-parameter">minNumberOfPokemon</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">invertQuery</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"primaryPokemonRequirements"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#withPrimaryPokemonHealthRatioRequirement.withPrimaryPokemonHealthRatioRequirement-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Add a primary pokemon health ratio requirement</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">requiredHealthRange</span>: <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span></span><div class="tsd-comment tsd-typography"><p>the health range to check</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">minNumberOfPokemon</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></span><div class="tsd-comment tsd-typography"><p>minimum number of pokemon to have the health range</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">invertQuery</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>if true will invert the query</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"primaryPokemonRequirements"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L834">src/data/mystery-encounters/mystery-encounter.ts:834</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withPrimaryPokemonRequirement" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Primary<wbr/>Pokemon<wbr/>Requirement</span><a href="#withPrimaryPokemonRequirement" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withPrimaryPokemonRequirement.withPrimaryPokemonRequirement-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Primary<wbr/>Pokemon<wbr/>Requirement</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">requirement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"primaryPokemonRequirements"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#withPrimaryPokemonRequirement.withPrimaryPokemonRequirement-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Add a primary pokemon requirement</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">requirement</span>: <a href="data_mystery_encounters_mystery_encounter_requirements.EncounterPokemonRequirement.html" class="tsd-signature-type tsd-kind-class">EncounterPokemonRequirement</a></span><div class="tsd-comment tsd-typography"><p><a href="data_mystery_encounters_mystery_encounter_requirements.EncounterPokemonRequirement.html" class="tsd-kind-class"><code>EncounterPokemonRequirement</code></a></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"primaryPokemonRequirements"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L805">src/data/mystery-encounters/mystery-encounter.ts:805</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withPrimaryPokemonStatusEffectRequirement" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Primary<wbr/>Pokemon<wbr/>Status<wbr/>Effect<wbr/>Requirement</span><a href="#withPrimaryPokemonStatusEffectRequirement" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withPrimaryPokemonStatusEffectRequirement.withPrimaryPokemonStatusEffectRequirement-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Primary<wbr/>Pokemon<wbr/>Status<wbr/>Effect<wbr/>Requirement</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">statusEffect</span>, <span class="tsd-kind-parameter">minNumberOfPokemon</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">invertQuery</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"primaryPokemonRequirements"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#withPrimaryPokemonStatusEffectRequirement.withPrimaryPokemonStatusEffectRequirement-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Add a primary pokemon status effect requirement</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">statusEffect</span>: <a href="../enums/enums_status_effect.StatusEffect.html" class="tsd-signature-type tsd-kind-enum">StatusEffect</a><span class="tsd-signature-symbol"> | </span><a href="../enums/enums_status_effect.StatusEffect.html" class="tsd-signature-type tsd-kind-enum">StatusEffect</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>the status effect/s to check</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">minNumberOfPokemon</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></span><div class="tsd-comment tsd-typography"><p>minimum number of pokemon to have the effect</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">invertQuery</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>if true will invert the query</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"primaryPokemonRequirements"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L822">src/data/mystery-encounters/mystery-encounter.ts:822</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withQuery" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Query</span><a href="#withQuery" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withQuery.withQuery-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Query</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#withQuery.withQuery-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Add a query for the encounter</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Query to use for the encounter</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L990">src/data/mystery-encounters/mystery-encounter.ts:990</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withRewards" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Rewards</span><a href="#withRewards" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withRewards.withRewards-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Rewards</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">doEncounterRewards</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"doEncounterRewards"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#withRewards.withRewards-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Can set custom encounter rewards via this callback function
|
||
If rewards are always deterministic for an encounter, this is a good way to set them</p>
|
||
<p>NOTE: If rewards are dependent on options selected, runtime data, etc.,
|
||
It may be better to programmatically set doEncounterRewards elsewhere.
|
||
There is a helper function in mystery-encounter utils, setEncounterRewards(), which can be called programmatically to set rewards</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">doEncounterRewards</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span><span class="tsd-signature-symbol">: </span><a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span></span><div class="tsd-comment tsd-typography"><p>Synchronous callback function to perform during rewards phase of the encounter</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">scene</span>: <a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"doEncounterRewards"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L861">src/data/mystery-encounters/mystery-encounter.ts:861</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withScenePartySizeRequirement" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Scene<wbr/>Party<wbr/>Size<wbr/>Requirement</span><a href="#withScenePartySizeRequirement" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withScenePartySizeRequirement.withScenePartySizeRequirement-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Scene<wbr/>Party<wbr/>Size<wbr/>Requirement</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">min</span>, <span class="tsd-kind-parameter">max</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">excludeDisallowedPokemon</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"requirements"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#withScenePartySizeRequirement.withScenePartySizeRequirement-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Specifies a party size requirement for an encounter.</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">min</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>min wave (or exact size if only min is given)</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">max</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>optional max size. If not given, defaults to min => exact wave</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">excludeDisallowedPokemon</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>if true, only counts allowed (legal in Challenge/unfainted) mons</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"requirements"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L795">src/data/mystery-encounters/mystery-encounter.ts:795</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withSceneRequirement" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Scene<wbr/>Requirement</span><a href="#withSceneRequirement" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withSceneRequirement.withSceneRequirement-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Scene<wbr/>Requirement</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">requirement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"requirements"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#withSceneRequirement.withSceneRequirement-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Specifies a requirement for an encounter
|
||
For example, passing requirement as "new WaveCountRequirement([2, 180])" would create a requirement that the encounter can only be spawned between waves 2 and 180
|
||
Existing Requirement objects are defined in mystery-encounter-requirements.ts, and more can always be created to meet a requirement need</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">requirement</span>: <a href="data_mystery_encounters_mystery_encounter_requirements.EncounterSceneRequirement.html" class="tsd-signature-type tsd-kind-class">EncounterSceneRequirement</a></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"requirements"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L768">src/data/mystery-encounters/mystery-encounter.ts:768</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withSceneWaveRangeRequirement" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Scene<wbr/>Wave<wbr/>Range<wbr/>Requirement</span><a href="#withSceneWaveRangeRequirement" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withSceneWaveRangeRequirement.withSceneWaveRangeRequirement-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Scene<wbr/>Wave<wbr/>Range<wbr/>Requirement</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">min</span>, <span class="tsd-kind-parameter">max</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"requirements"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#withSceneWaveRangeRequirement.withSceneWaveRangeRequirement-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Specifies a wave range requirement for an encounter.</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">min</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>min wave (or exact wave if only min is given)</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">max</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>optional max wave. If not given, defaults to min => exact wave</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"requirements"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L783">src/data/mystery-encounters/mystery-encounter.ts:783</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withSecondaryPokemonRequirement" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Secondary<wbr/>Pokemon<wbr/>Requirement</span><a href="#withSecondaryPokemonRequirement" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withSecondaryPokemonRequirement.withSecondaryPokemonRequirement-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Secondary<wbr/>Pokemon<wbr/>Requirement</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">requirement</span>, <span class="tsd-kind-parameter">excludePrimaryFromSecondaryRequirements</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"secondaryPokemonRequirements"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#withSecondaryPokemonRequirement.withSecondaryPokemonRequirement-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">requirement</span>: <a href="data_mystery_encounters_mystery_encounter_requirements.EncounterPokemonRequirement.html" class="tsd-signature-type tsd-kind-class">EncounterPokemonRequirement</a></span></li><li><span><span class="tsd-kind-parameter">excludePrimaryFromSecondaryRequirements</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"secondaryPokemonRequirements"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L841">src/data/mystery-encounters/mystery-encounter.ts:841</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withSimpleDexProgressOption" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Simple<wbr/>Dex<wbr/>Progress<wbr/>Option</span><a href="#withSimpleDexProgressOption" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withSimpleDexProgressOption.withSimpleDexProgressOption-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Simple<wbr/>Dex<wbr/>Progress<wbr/>Option</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dialogue</span>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"options"</span><span class="tsd-signature-symbol">></span><a href="#withSimpleDexProgressOption.withSimpleDexProgressOption-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Defines an option + phasefor the encounter.
|
||
Use for easy/streamlined options.
|
||
There should be at least 2 options defined and no more than 4.
|
||
If complex use <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withOption" class="tsd-kind-method"><code>MysteryEncounterBuilder.withOption</code></a></p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">dialogue</span>: <a href="data_mystery_encounters_mystery_encounter_dialogue.OptionTextDisplay.html" class="tsd-signature-type tsd-kind-class">OptionTextDisplay</a></span><div class="tsd-comment tsd-typography"><p><a href="data_mystery_encounters_mystery_encounter_dialogue.OptionTextDisplay.html" class="tsd-kind-class"><code>OptionTextDisplay</code></a></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">callback</span>: <a href="../types/data_mystery_encounters_mystery_encounter_option.OptionPhaseCallback.html" class="tsd-signature-type tsd-kind-type-alias">OptionPhaseCallback</a></span><div class="tsd-comment tsd-typography"><p><a href="../types/data_mystery_encounters_mystery_encounter_option.OptionPhaseCallback.html" class="tsd-kind-type-alias"><code>OptionPhaseCallback</code></a></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"options"</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L616">src/data/mystery-encounters/mystery-encounter.ts:616</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withSimpleOption" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Simple<wbr/>Option</span><a href="#withSimpleOption" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withSimpleOption.withSimpleOption-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Simple<wbr/>Option</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dialogue</span>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"options"</span><span class="tsd-signature-symbol">></span><a href="#withSimpleOption.withSimpleOption-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Defines an option + phasefor the encounter.
|
||
Use for easy/streamlined options.
|
||
There should be at least 2 options defined and no more than 4.
|
||
If complex use <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withOption" class="tsd-kind-method"><code>MysteryEncounterBuilder.withOption</code></a></p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">dialogue</span>: <a href="data_mystery_encounters_mystery_encounter_dialogue.OptionTextDisplay.html" class="tsd-signature-type tsd-kind-class">OptionTextDisplay</a></span><div class="tsd-comment tsd-typography"><p><a href="data_mystery_encounters_mystery_encounter_dialogue.OptionTextDisplay.html" class="tsd-kind-class"><code>OptionTextDisplay</code></a></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">callback</span>: <a href="../types/data_mystery_encounters_mystery_encounter_option.OptionPhaseCallback.html" class="tsd-signature-type tsd-kind-type-alias">OptionPhaseCallback</a></span><div class="tsd-comment tsd-typography"><p><a href="../types/data_mystery_encounters_mystery_encounter_option.OptionPhaseCallback.html" class="tsd-kind-type-alias"><code>OptionPhaseCallback</code></a></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"options"</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L602">src/data/mystery-encounters/mystery-encounter.ts:602</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withSkipEnemyBattleTurns" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Skip<wbr/>Enemy<wbr/>Battle<wbr/>Turns</span><a href="#withSkipEnemyBattleTurns" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withSkipEnemyBattleTurns.withSkipEnemyBattleTurns-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Skip<wbr/>Enemy<wbr/>Battle<wbr/>Turns</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">skipEnemyBattleTurns</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"skipEnemyBattleTurns"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#withSkipEnemyBattleTurns.withSkipEnemyBattleTurns-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>If true, encounter will not animate the target Pokemon as part of battle animations
|
||
Used for encounters where it is not a "real" battle, but still uses battle animations and commands (see FunAndGamesEncounter for an example)
|
||
Default false</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">skipEnemyBattleTurns</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"skipEnemyBattleTurns"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L731">src/data/mystery-encounters/mystery-encounter.ts:731</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withSkipToFightInput" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Skip<wbr/>To<wbr/>Fight<wbr/>Input</span><a href="#withSkipToFightInput" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withSkipToFightInput.withSkipToFightInput-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Skip<wbr/>To<wbr/>Fight<wbr/>Input</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">skipToFightInput</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"skipToFightInput"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#withSkipToFightInput.withSkipToFightInput-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>If true, will skip COMMAND input and go straight to FIGHT (move select) input menu
|
||
Default false</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">skipToFightInput</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"skipToFightInput"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L740">src/data/mystery-encounters/mystery-encounter.ts:740</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withTitle" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Title</span><a href="#withTitle" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withTitle.withTitle-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Title</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">title</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#withTitle.withTitle-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Add a title for the encounter</p>
|
||
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">title</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Title of the encounter</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L950">src/data/mystery-encounters/mystery-encounter.ts:950</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withEncounterType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>with<wbr/>Encounter<wbr/>Type</span><a href="#withEncounterType" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withEncounterType.withEncounterType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">with<wbr/>Encounter<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">encounterType</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"encounterType"</span><span class="tsd-signature-symbol">></span><a href="#withEncounterType.withEncounterType-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">encounterType</span>: <a href="../enums/enums_mystery_encounter_type.MysteryEncounterType.html" class="tsd-signature-type tsd-kind-enum">MysteryEncounterType</a></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"encounterType"</span><span class="tsd-signature-symbol">></span></h4><p>this</p>
|
||
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Statif" class="tsd-anchor"></a>Statif<a href="#Statif" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Defines the type of encounter which is used as an identifier, should be tied to a unique MysteryEncounterType
|
||
NOTE: if new functions are added to <a href="data_mystery_encounters_mystery_encounter.default.html" class="tsd-kind-class"><code>MysteryEncounter</code></a> class</p>
|
||
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L570">src/data/mystery-encounters/mystery-encounter.ts:570</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#autoHideIntroVisuals" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Hide<wbr/>Intro<wbr/>Visuals</span></a><a href="#catchAllowed" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>catch<wbr/>Allowed</span></a><a href="#continuousEncounter" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>continuous<wbr/>Encounter</span></a><a href="#dialogue" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dialogue</span></a><a href="#dialogueTokens" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dialogue<wbr/>Tokens</span></a><a href="#enemyPartyConfigs" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enemy<wbr/>Party<wbr/>Configs</span></a><a href="#enterIntroVisualsFromRight" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enter<wbr/>Intro<wbr/>Visuals<wbr/>From<wbr/>Right</span></a><a href="#excludePrimaryFromSupportRequirements" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>exclude<wbr/>Primary<wbr/>From<wbr/>Support<wbr/>Requirements</span></a><a href="#expMultiplier" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>exp<wbr/>Multiplier</span></a><a href="#fleeAllowed" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>flee<wbr/>Allowed</span></a><a href="#hasBattleAnimationsWithoutTargets" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has<wbr/>Battle<wbr/>Animations<wbr/>Without<wbr/>Targets</span></a><a href="#hideBattleIntroMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hide<wbr/>Battle<wbr/>Intro<wbr/>Message</span></a><a href="#localizationKey" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>localization<wbr/>Key</span></a><a href="#lockEncounterRewardTiers" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>lock<wbr/>Encounter<wbr/>Reward<wbr/>Tiers</span></a><a href="#maxAllowedEncounters" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Allowed<wbr/>Encounters</span></a><a href="#options" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a><a href="#preventGameStatsUpdates" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prevent<wbr/>Game<wbr/>Stats<wbr/>Updates</span></a><a href="#primaryPokemonRequirements" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>primary<wbr/>Pokemon<wbr/>Requirements</span></a><a href="#requirements" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>requirements</span></a><a href="#secondaryPokemonRequirements" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>secondary<wbr/>Pokemon<wbr/>Requirements</span></a><a href="#skipEnemyBattleTurns" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>skip<wbr/>Enemy<wbr/>Battle<wbr/>Turns</span></a><a href="#skipToFightInput" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>skip<wbr/>To<wbr/>Fight<wbr/>Input</span></a><a href="#startOfBattleEffectsComplete" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>start<wbr/>Of<wbr/>Battle<wbr/>Effects<wbr/>Complete</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#build" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build</span></a><a href="#setLocalizationKey" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Localization<wbr/>Key</span></a><a href="#withAnimations" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Animations</span></a><a href="#withAutoHideIntroVisuals" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Auto<wbr/>Hide<wbr/>Intro<wbr/>Visuals</span></a><a href="#withBattleAnimationsWithoutTargets" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Battle<wbr/>Animations<wbr/>Without<wbr/>Targets</span></a><a href="#withCatchAllowed" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Catch<wbr/>Allowed</span></a><a href="#withContinuousEncounter" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Continuous<wbr/>Encounter</span></a><a href="#withDescription" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Description</span></a><a href="#withDisallowedChallenges" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Disallowed<wbr/>Challenges</span></a><a href="#withDisallowedGameModes" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Disallowed<wbr/>Game<wbr/>Modes</span></a><a href="#withEncounterTier" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Encounter<wbr/>Tier</span></a><a href="#withEnterIntroVisualsFromRight" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Enter<wbr/>Intro<wbr/>Visuals<wbr/>From<wbr/>Right</span></a><a href="#withExp" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Exp</span></a><a href="#withFleeAllowed" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Flee<wbr/>Allowed</span></a><a href="#withHideWildIntroMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Hide<wbr/>Wild<wbr/>Intro<wbr/>Message</span></a><a href="#withIntro" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Intro</span></a><a href="#withIntroDialogue" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Intro<wbr/>Dialogue</span></a><a href="#withIntroSpriteConfigs" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Intro<wbr/>Sprite<wbr/>Configs</span></a><a href="#withMaxAllowedEncounters" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Max<wbr/>Allowed<wbr/>Encounters</span></a><a href="#withOnInit" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>On<wbr/>Init</span></a><a href="#withOnVisualsStart" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>On<wbr/>Visuals<wbr/>Start</span></a><a href="#withOption" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Option</span></a><a href="#withOutroDialogue" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Outro<wbr/>Dialogue</span></a><a href="#withPreventGameStatsUpdates" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Prevent<wbr/>Game<wbr/>Stats<wbr/>Updates</span></a><a href="#withPrimaryPokemonHealthRatioRequirement" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Primary<wbr/>Pokemon<wbr/>Health<wbr/>Ratio<wbr/>Requirement</span></a><a href="#withPrimaryPokemonRequirement" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Primary<wbr/>Pokemon<wbr/>Requirement</span></a><a href="#withPrimaryPokemonStatusEffectRequirement" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Primary<wbr/>Pokemon<wbr/>Status<wbr/>Effect<wbr/>Requirement</span></a><a href="#withQuery" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Query</span></a><a href="#withRewards" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Rewards</span></a><a href="#withScenePartySizeRequirement" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Scene<wbr/>Party<wbr/>Size<wbr/>Requirement</span></a><a href="#withSceneRequirement" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Scene<wbr/>Requirement</span></a><a href="#withSceneWaveRangeRequirement" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Scene<wbr/>Wave<wbr/>Range<wbr/>Requirement</span></a><a href="#withSecondaryPokemonRequirement" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Secondary<wbr/>Pokemon<wbr/>Requirement</span></a><a href="#withSimpleDexProgressOption" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Simple<wbr/>Dex<wbr/>Progress<wbr/>Option</span></a><a href="#withSimpleOption" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Simple<wbr/>Option</span></a><a href="#withSkipEnemyBattleTurns" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Skip<wbr/>Enemy<wbr/>Battle<wbr/>Turns</span></a><a href="#withSkipToFightInput" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Skip<wbr/>To<wbr/>Fight<wbr/>Input</span></a><a href="#withTitle" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Title</span></a><a href="#withEncounterType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Encounter<wbr/>Type</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>pokemon-rogue-battle</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|