mika/pokerogue
1
0
Fork 0
mirror of https://github.com/pagefaultgames/pokerogue.git synced 2025-08-09 08:59:29 +02:00
Code Issues Packages Projects Releases Wiki Activity
gh-pages
pokerogue/main/classes/data_mystery-encounters_mystery-encounter.MysteryEncounterBuilder.html
github-actions[bot] 48f7010711 [skip ci] Deploy docs
2025-06-19 01:22:42 +00:00

173 lines
188 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html class="default" lang="en" data-base="../"><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">pokemon-rogue-battle</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/data_mystery-encounters_mystery-encounter.html">data/mystery-encounters/mystery-encounter</a></li><li><a href="" aria-current="page">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">&lt;</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">&gt;</span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L547">src/data/mystery-encounters/mystery-encounter.ts:547</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"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg><h5 class="tsd-index-heading uppercase">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="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><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="#autohideintrovisuals" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Hide<wbr/>Intro<wbr/>Visuals</span></a>
<a href="#catchallowed" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>catch<wbr/>Allowed</span></a>
<a href="#continuousencounter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>continuous<wbr/>Encounter</span></a>
<a href="#dialogue" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dialogue</span></a>
<a href="#dialoguetokens" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dialogue<wbr/>Tokens</span></a>
<a href="#enemypartyconfigs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enemy<wbr/>Party<wbr/>Configs</span></a>
<a href="#enterintrovisualsfromright" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><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="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><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="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>exp<wbr/>Multiplier</span></a>
<a href="#fleeallowed" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>flee<wbr/>Allowed</span></a>
<a href="#hasbattleanimationswithouttargets" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><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="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hide<wbr/>Battle<wbr/>Intro<wbr/>Message</span></a>
<a href="#localizationkey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>localization<wbr/>Key</span></a>
<a href="#lockencounterrewardtiers" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>lock<wbr/>Encounter<wbr/>Reward<wbr/>Tiers</span></a>
<a href="#maxallowedencounters" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Allowed<wbr/>Encounters</span></a>
<a href="#options" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a>
<a href="#preventgamestatsupdates" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prevent<wbr/>Game<wbr/>Stats<wbr/>Updates</span></a>
<a href="#primarypokemonrequirements" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>primary<wbr/>Pokemon<wbr/>Requirements</span></a>
<a href="#requirements" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>requirements</span></a>
<a href="#secondarypokemonrequirements" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>secondary<wbr/>Pokemon<wbr/>Requirements</span></a>
<a href="#skipenemybattleturns" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>skip<wbr/>Enemy<wbr/>Battle<wbr/>Turns</span></a>
<a href="#skiptofightinput" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>skip<wbr/>To<wbr/>Fight<wbr/>Input</span></a>
<a href="#startofbattleeffectscomplete" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><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="#build" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build</span></a>
<a href="#setlocalizationkey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Localization<wbr/>Key</span></a>
<a href="#withanimations" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Animations</span></a>
<a href="#withautohideintrovisuals" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Catch<wbr/>Allowed</span></a>
<a href="#withcontinuousencounter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Continuous<wbr/>Encounter</span></a>
<a href="#withdescription" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Description</span></a>
<a href="#withdisallowedchallenges" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Disallowed<wbr/>Challenges</span></a>
<a href="#withdisallowedgamemodes" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Disallowed<wbr/>Game<wbr/>Modes</span></a>
<a href="#withencountertier" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Encounter<wbr/>Tier</span></a>
<a href="#withenterintrovisualsfromright" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Exp</span></a>
<a href="#withfleeallowed" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Flee<wbr/>Allowed</span></a>
<a href="#withhidewildintromessage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Intro</span></a>
<a href="#withintrodialogue" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Intro<wbr/>Dialogue</span></a>
<a href="#withintrospriteconfigs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Intro<wbr/>Sprite<wbr/>Configs</span></a>
<a href="#withmaxallowedencounters" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Max<wbr/>Allowed<wbr/>Encounters</span></a>
<a href="#withoninit" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>On<wbr/>Init</span></a>
<a href="#withonvisualsstart" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>On<wbr/>Visuals<wbr/>Start</span></a>
<a href="#withoption" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Option</span></a>
<a href="#withoutrodialogue" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Outro<wbr/>Dialogue</span></a>
<a href="#withpreventgamestatsupdates" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Primary<wbr/>Pokemon<wbr/>Requirement</span></a>
<a href="#withprimarypokemonstatuseffectrequirement" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Query</span></a>
<a href="#withrewards" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Rewards</span></a>
<a href="#withscenepartysizerequirement" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Scene<wbr/>Requirement</span></a>
<a href="#withscenewaverangerequirement" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Secondary<wbr/>Pokemon<wbr/>Requirement</span></a>
<a href="#withsimpledexprogressoption" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Simple<wbr/>Option</span></a>
<a href="#withskipenemybattleturns" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Title</span></a>
<a href="#withencountertype" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructormysteryencounterbuilder"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">MysteryEncounterBuilder</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><a href="#constructormysteryencounterbuilder" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a></h4></div></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="autohideintrovisuals"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">autoHideIntroVisuals</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L560">src/data/mystery-encounters/mystery-encounter.ts:560</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="catchallowed"><span>catch<wbr/>Allowed</span><a href="#catchallowed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">catchAllowed</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L563">src/data/mystery-encounters/mystery-encounter.ts:563</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="continuousencounter"><span>continuous<wbr/>Encounter</span><a href="#continuousencounter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">continuousEncounter</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L562">src/data/mystery-encounters/mystery-encounter.ts:562</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="dialogue"><span>dialogue</span><a href="#dialogue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L552">src/data/mystery-encounters/mystery-encounter.ts:552</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="dialoguetokens"><span>dialogue<wbr/>Tokens</span><a href="#dialoguetokens" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">dialogueTokens</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</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">&gt;</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/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"><h3 class="tsd-anchor-link" id="enemypartyconfigs"><span>enemy<wbr/>Party<wbr/>Configs</span><a href="#enemypartyconfigs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">enemyPartyConfigs</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/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"><h3 class="tsd-anchor-link" id="enterintrovisualsfromright"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">enterIntroVisualsFromRight</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L561">src/data/mystery-encounters/mystery-encounter.ts:561</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="excludeprimaryfromsupportrequirements"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">excludePrimaryFromSupportRequirements</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/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"><h3 class="tsd-anchor-link" id="expmultiplier"><span>exp<wbr/>Multiplier</span><a href="#expmultiplier" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">expMultiplier</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L572">src/data/mystery-encounters/mystery-encounter.ts:572</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="fleeallowed"><span>flee<wbr/>Allowed</span><a href="#fleeallowed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">fleeAllowed</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L564">src/data/mystery-encounters/mystery-encounter.ts:564</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hasbattleanimationswithouttargets"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hasBattleAnimationsWithoutTargets</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L567">src/data/mystery-encounters/mystery-encounter.ts:567</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hidebattleintromessage"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hideBattleIntroMessage</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L559">src/data/mystery-encounters/mystery-encounter.ts:559</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="localizationkey"><span>localization<wbr/>Key</span><a href="#localizationkey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">localizationKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/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"><h3 class="tsd-anchor-link" id="lockencounterrewardtiers"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">lockEncounterRewardTiers</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L565">src/data/mystery-encounters/mystery-encounter.ts:565</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="maxallowedencounters"><span>max<wbr/>Allowed<wbr/>Encounters</span><a href="#maxallowedencounters" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">maxAllowedEncounters</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L571">src/data/mystery-encounters/mystery-encounter.ts:571</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="options"><span>options</span><a href="#options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/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"><h3 class="tsd-anchor-link" id="preventgamestatsupdates"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">preventGameStatsUpdates</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L570">src/data/mystery-encounters/mystery-encounter.ts:570</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="primarypokemonrequirements"><span>primary<wbr/>Pokemon<wbr/>Requirements</span><a href="#primarypokemonrequirements" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">primaryPokemonRequirements</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/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"><h3 class="tsd-anchor-link" id="requirements"><span>requirements</span><a href="#requirements" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/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"><h3 class="tsd-anchor-link" id="secondarypokemonrequirements"><span>secondary<wbr/>Pokemon<wbr/>Requirements</span><a href="#secondarypokemonrequirements" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">secondaryPokemonRequirements</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/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"><h3 class="tsd-anchor-link" id="skipenemybattleturns"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">skipEnemyBattleTurns</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L568">src/data/mystery-encounters/mystery-encounter.ts:568</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="skiptofightinput"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">skipToFightInput</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L569">src/data/mystery-encounters/mystery-encounter.ts:569</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="startofbattleeffectscomplete"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">startOfBattleEffectsComplete</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L566">src/data/mystery-encounters/mystery-encounter.ts:566</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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="build"><span>build</span><a href="#build" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="build-1"><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> <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-symbol">:</span> <a href="data_mystery-encounters_mystery-encounter.default.html" class="tsd-signature-type tsd-kind-class">default</a><a href="#build-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L1110">src/data/mystery-encounters/mystery-encounter.ts:1110</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setlocalizationkey"><span>set<wbr/>Localization<wbr/>Key</span><a href="#setlocalizationkey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="setlocalizationkey-1"><span class="tsd-kind-call-signature">setLocalizationKey</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">localizationKey</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> <span class="tsd-signature-type">this</span><a href="#setlocalizationkey-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L684">src/data/mystery-encounters/mystery-encounter.ts:684</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withanimations"><span>with<wbr/>Animations</span><a href="#withanimations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withanimations-1"><span class="tsd-kind-call-signature">withAnimations</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">encounterAnimations</span><span class="tsd-signature-symbol">:</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 class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;encounterAnimations&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><a href="#withanimations-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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><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="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;encounterAnimations&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L716">src/data/mystery-encounters/mystery-encounter.ts:716</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withautohideintrovisuals"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withautohideintrovisuals-1"><span class="tsd-kind-call-signature">withAutoHideIntroVisuals</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">autoHideIntroVisuals</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;autoHideIntroVisuals&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><a href="#withautohideintrovisuals-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;autoHideIntroVisuals&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L1015">src/data/mystery-encounters/mystery-encounter.ts:1015</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withbattleanimationswithouttargets"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withbattleanimationswithouttargets-1"><span class="tsd-kind-call-signature">withBattleAnimationsWithoutTargets</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">hasBattleAnimationsWithoutTargets</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;hasBattleAnimationsWithoutTargets&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><a href="#withbattleanimationswithouttargets-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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 &quot;real&quot; 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="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;hasBattleAnimationsWithoutTargets&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L765">src/data/mystery-encounters/mystery-encounter.ts:765</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withcatchallowed"><span>with<wbr/>Catch<wbr/>Allowed</span><a href="#withcatchallowed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withcatchallowed-1"><span class="tsd-kind-call-signature">withCatchAllowed</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">catchAllowed</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;catchAllowed&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><a href="#withcatchallowed-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;catchAllowed&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L986">src/data/mystery-encounters/mystery-encounter.ts:986</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withcontinuousencounter"><span>with<wbr/>Continuous<wbr/>Encounter</span><a href="#withcontinuousencounter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withcontinuousencounter-1"><span class="tsd-kind-call-signature">withContinuousEncounter</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">continuousEncounter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;continuousEncounter&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><a href="#withcontinuousencounter-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;continuousEncounter&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L753">src/data/mystery-encounters/mystery-encounter.ts:753</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withdescription"><span>with<wbr/>Description</span><a href="#withdescription" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withdescription-1"><span class="tsd-kind-call-signature">withDescription</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">description</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> <span class="tsd-signature-type">this</span><a href="#withdescription-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L1060">src/data/mystery-encounters/mystery-encounter.ts:1060</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withdisallowedchallenges"><span>with<wbr/>Disallowed<wbr/>Challenges</span><a href="#withdisallowedchallenges" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withdisallowedchallenges-1"><span class="tsd-kind-call-signature">withDisallowedChallenges</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">disallowedChallenges</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_challenges.Challenges.html" class="tsd-signature-type tsd-kind-enum">Challenges</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;disallowedChallenges&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><a href="#withdisallowedchallenges-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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><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="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;disallowedChallenges&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L740">src/data/mystery-encounters/mystery-encounter.ts:740</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withdisallowedgamemodes"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withdisallowedgamemodes-1"><span class="tsd-kind-call-signature">withDisallowedGameModes</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">disallowedGameModes</span><span class="tsd-signature-symbol">:</span> <a href="../enums/game-mode.GameModes.html" class="tsd-signature-type tsd-kind-enum">GameModes</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;disallowedGameModes&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><a href="#withdisallowedgamemodes-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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><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="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;disallowedGameModes&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L728">src/data/mystery-encounters/mystery-encounter.ts:728</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withencountertier"><span>with<wbr/>Encounter<wbr/>Tier</span><a href="#withencountertier" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withencountertier-1"><span class="tsd-kind-call-signature">withEncounterTier</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">encounterTier</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_mystery-encounter-tier.MysteryEncounterTier.html" class="tsd-signature-type tsd-kind-enum">MysteryEncounterTier</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;encounterTier&quot;</span><span class="tsd-signature-symbol">&gt;</span><a href="#withencountertier-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;encounterTier&quot;</span><span class="tsd-signature-symbol">&gt;</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L705">src/data/mystery-encounters/mystery-encounter.ts:705</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withenterintrovisualsfromright"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withenterintrovisualsfromright-1"><span class="tsd-kind-call-signature">withEnterIntroVisualsFromRight</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">enterIntroVisualsFromRight</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;enterIntroVisualsFromRight&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><a href="#withenterintrovisualsfromright-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;enterIntroVisualsFromRight&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L1026">src/data/mystery-encounters/mystery-encounter.ts:1026</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withexp"><span>with<wbr/>Exp</span><a href="#withexp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withexp-1"><span class="tsd-kind-call-signature">withExp</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">doEncounterExp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;doEncounterExp&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><a href="#withexp-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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">=&gt;</span> <span class="tsd-signature-type">boolean</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></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;doEncounterExp&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L955">src/data/mystery-encounters/mystery-encounter.ts:955</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withfleeallowed"><span>with<wbr/>Flee<wbr/>Allowed</span><a href="#withfleeallowed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withfleeallowed-1"><span class="tsd-kind-call-signature">withFleeAllowed</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">fleeAllowed</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;fleeAllowed&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><a href="#withfleeallowed-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;fleeAllowed&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L995">src/data/mystery-encounters/mystery-encounter.ts:995</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withhidewildintromessage"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withhidewildintromessage-1"><span class="tsd-kind-call-signature">withHideWildIntroMessage</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">hideBattleIntroMessage</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;hideBattleIntroMessage&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><a href="#withhidewildintromessage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;hideBattleIntroMessage&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L1003">src/data/mystery-encounters/mystery-encounter.ts:1003</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withintro"><span>with<wbr/>Intro</span><a href="#withintro" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withintro-1"><span class="tsd-kind-call-signature">withIntro</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>        <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 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 class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><a href="#withintro-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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> <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> <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></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" 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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L669">src/data/mystery-encounters/mystery-encounter.ts:669</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withintrodialogue"><span>with<wbr/>Intro<wbr/>Dialogue</span><a href="#withintrodialogue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withintrodialogue-1"><span class="tsd-kind-call-signature">withIntroDialogue</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dialogue</span><span class="tsd-signature-symbol">?:</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 class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#withintrodialogue-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L664">src/data/mystery-encounters/mystery-encounter.ts:664</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withintrospriteconfigs"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withintrospriteconfigs-1"><span class="tsd-kind-call-signature">withIntroSpriteConfigs</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">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 class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;spriteConfigs&quot;</span><span class="tsd-signature-symbol">&gt;</span><a href="#withintrospriteconfigs-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;spriteConfigs&quot;</span><span class="tsd-signature-symbol">&gt;</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L658">src/data/mystery-encounters/mystery-encounter.ts:658</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withmaxallowedencounters"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withmaxallowedencounters-1"><span class="tsd-kind-call-signature">withMaxAllowedEncounters</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">maxAllowedEncounters</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;maxAllowedEncounters&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><a href="#withmaxallowedencounters-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;maxAllowedEncounters&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L807">src/data/mystery-encounters/mystery-encounter.ts:807</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withoninit"><span>with<wbr/>On<wbr/>Init</span><a href="#withoninit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withoninit-1"><span class="tsd-kind-call-signature">withOnInit</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">onInit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;onInit&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#withoninit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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">=&gt;</span> <span class="tsd-signature-type">boolean</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></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;onInit&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L966">src/data/mystery-encounters/mystery-encounter.ts:966</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withonvisualsstart"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withonvisualsstart-1"><span class="tsd-kind-call-signature">withOnVisualsStart</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">onVisualsStart</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;onVisualsStart&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><a href="#withonvisualsstart-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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">=&gt;</span> <span class="tsd-signature-type">boolean</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></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;onVisualsStart&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L976">src/data/mystery-encounters/mystery-encounter.ts:976</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withoption"><span>with<wbr/>Option</span><a href="#withoption" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withoption-1"><span class="tsd-kind-call-signature">withOption</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">option</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><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;options&quot;</span><span class="tsd-signature-symbol">&gt;</span><a href="#withoption-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;options&quot;</span><span class="tsd-signature-symbol">&gt;</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L598">src/data/mystery-encounters/mystery-encounter.ts:598</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withoutrodialogue"><span>with<wbr/>Outro<wbr/>Dialogue</span><a href="#withoutrodialogue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withoutrodialogue-1"><span class="tsd-kind-call-signature">withOutroDialogue</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dialogue</span><span class="tsd-signature-symbol">?:</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 class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#withoutrodialogue-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L1100">src/data/mystery-encounters/mystery-encounter.ts:1100</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withpreventgamestatsupdates"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withpreventgamestatsupdates-1"><span class="tsd-kind-call-signature">withPreventGameStatsUpdates</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">preventGameStatsUpdates</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;preventGameStatsUpdates&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><a href="#withpreventgamestatsupdates-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;preventGameStatsUpdates&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L796">src/data/mystery-encounters/mystery-encounter.ts:796</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withprimarypokemonhealthratiorequirement"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withprimarypokemonhealthratiorequirement-1"><span class="tsd-kind-call-signature">withPrimaryPokemonHealthRatioRequirement</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">requiredHealthRange</span><span class="tsd-signature-symbol">:</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 class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">minNumberOfPokemon</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">invertQuery</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;primaryPokemonRequirements&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><a href="#withprimarypokemonhealthratiorequirement-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;primaryPokemonRequirements&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L902">src/data/mystery-encounters/mystery-encounter.ts:902</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withprimarypokemonrequirement"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withprimarypokemonrequirement-1"><span class="tsd-kind-call-signature">withPrimaryPokemonRequirement</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">requirement</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><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;primaryPokemonRequirements&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><a href="#withprimarypokemonrequirement-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;primaryPokemonRequirements&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L863">src/data/mystery-encounters/mystery-encounter.ts:863</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withprimarypokemonstatuseffectrequirement"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withprimarypokemonstatuseffectrequirement-1"><span class="tsd-kind-call-signature">withPrimaryPokemonStatusEffectRequirement</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">statusEffect</span><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> <a href="../enums/enums_status-effect.StatusEffect.html" class="tsd-signature-type tsd-kind-enum">StatusEffect</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">minNumberOfPokemon</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">invertQuery</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;primaryPokemonRequirements&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><a href="#withprimarypokemonstatuseffectrequirement-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;primaryPokemonRequirements&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L884">src/data/mystery-encounters/mystery-encounter.ts:884</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withquery"><span>with<wbr/>Query</span><a href="#withquery" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withquery-1"><span class="tsd-kind-call-signature">withQuery</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</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> <span class="tsd-signature-type">this</span><a href="#withquery-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L1080">src/data/mystery-encounters/mystery-encounter.ts:1080</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withrewards"><span>with<wbr/>Rewards</span><a href="#withrewards" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withrewards-1"><span class="tsd-kind-call-signature">withRewards</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">doEncounterRewards</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;doEncounterRewards&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><a href="#withrewards-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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">=&gt;</span> <span class="tsd-signature-type">boolean</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></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;doEncounterRewards&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L941">src/data/mystery-encounters/mystery-encounter.ts:941</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withscenepartysizerequirement"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withscenepartysizerequirement-1"><span class="tsd-kind-call-signature">withScenePartySizeRequirement</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">min</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">max</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">excludeDisallowedPokemon</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;requirements&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><a href="#withscenepartysizerequirement-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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 =&gt; 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="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;requirements&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L849">src/data/mystery-encounters/mystery-encounter.ts:849</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withscenerequirement"><span>with<wbr/>Scene<wbr/>Requirement</span><a href="#withscenerequirement" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withscenerequirement-1"><span class="tsd-kind-call-signature">withSceneRequirement</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">requirement</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><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;requirements&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><a href="#withscenerequirement-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Specifies a requirement for an encounter
For example, passing requirement as &quot;new WaveCountRequirement([2, 180])&quot; 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="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;requirements&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L820">src/data/mystery-encounters/mystery-encounter.ts:820</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withscenewaverangerequirement"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withscenewaverangerequirement-1"><span class="tsd-kind-call-signature">withSceneWaveRangeRequirement</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">min</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">max</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;requirements&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><a href="#withscenewaverangerequirement-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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 =&gt; exact wave</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;requirements&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L837">src/data/mystery-encounters/mystery-encounter.ts:837</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withsecondarypokemonrequirement"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withsecondarypokemonrequirement-1"><span class="tsd-kind-call-signature">withSecondaryPokemonRequirement</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">requirement</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><br/>    <span class="tsd-kind-parameter">excludePrimaryFromSecondaryRequirements</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;secondaryPokemonRequirements&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><a href="#withsecondarypokemonrequirement-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;secondaryPokemonRequirements&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L915">src/data/mystery-encounters/mystery-encounter.ts:915</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withsimpledexprogressoption"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withsimpledexprogressoption-1"><span class="tsd-kind-call-signature">withSimpleDexProgressOption</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">dialogue</span><span class="tsd-signature-symbol">:</span> <a href="data_mystery-encounters_mystery-encounter-dialogue.OptionTextDisplay.html" class="tsd-signature-type tsd-kind-class">OptionTextDisplay</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <a href="../types/data_mystery-encounters_mystery-encounter-option.OptionPhaseCallback.html" class="tsd-signature-type tsd-kind-type-alias">OptionPhaseCallback</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;options&quot;</span><span class="tsd-signature-symbol">&gt;</span><a href="#withsimpledexprogressoption-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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="#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="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;options&quot;</span><span class="tsd-signature-symbol">&gt;</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L639">src/data/mystery-encounters/mystery-encounter.ts:639</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withsimpleoption"><span>with<wbr/>Simple<wbr/>Option</span><a href="#withsimpleoption" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withsimpleoption-1"><span class="tsd-kind-call-signature">withSimpleOption</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">dialogue</span><span class="tsd-signature-symbol">:</span> <a href="data_mystery-encounters_mystery-encounter-dialogue.OptionTextDisplay.html" class="tsd-signature-type tsd-kind-class">OptionTextDisplay</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <a href="../types/data_mystery-encounters_mystery-encounter-option.OptionPhaseCallback.html" class="tsd-signature-type tsd-kind-type-alias">OptionPhaseCallback</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;options&quot;</span><span class="tsd-signature-symbol">&gt;</span><a href="#withsimpleoption-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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="#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="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;options&quot;</span><span class="tsd-signature-symbol">&gt;</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L617">src/data/mystery-encounters/mystery-encounter.ts:617</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withskipenemybattleturns"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withskipenemybattleturns-1"><span class="tsd-kind-call-signature">withSkipEnemyBattleTurns</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">skipEnemyBattleTurns</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;skipEnemyBattleTurns&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><a href="#withskipenemybattleturns-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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 &quot;real&quot; 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="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;skipEnemyBattleTurns&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L777">src/data/mystery-encounters/mystery-encounter.ts:777</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withskiptofightinput"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withskiptofightinput-1"><span class="tsd-kind-call-signature">withSkipToFightInput</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">skipToFightInput</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;skipToFightInput&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><a href="#withskiptofightinput-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;skipToFightInput&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L788">src/data/mystery-encounters/mystery-encounter.ts:788</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withtitle"><span>with<wbr/>Title</span><a href="#withtitle" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withtitle-1"><span class="tsd-kind-call-signature">withTitle</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">title</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> <span class="tsd-signature-type">this</span><a href="#withtitle-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L1040">src/data/mystery-encounters/mystery-encounter.ts:1040</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="withencountertype"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="withencountertype-1"><span class="tsd-kind-call-signature">withEncounterType</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">encounterType</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_mystery-encounter-type.MysteryEncounterType.html" class="tsd-signature-type tsd-kind-enum">MysteryEncounterType</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;encounterType&quot;</span><span class="tsd-signature-symbol">&gt;</span><a href="#withencountertype-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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="" class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</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">&quot;encounterType&quot;</span><span class="tsd-signature-symbol">&gt;</span></h4><p>this</p>
<div class="tsd-comment tsd-typography"><div class="tsd-tag-statif"><h4 class="tsd-anchor-link" id="statif">Statif<a href="#statif" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><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></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter.ts#L584">src/data/mystery-encounters/mystery-encounter.ts:584</a></li></ul></aside></div></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><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="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#autohideintrovisuals"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Hide<wbr/>Intro<wbr/>Visuals</span></a><a href="#catchallowed"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>catch<wbr/>Allowed</span></a><a href="#continuousencounter"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>continuous<wbr/>Encounter</span></a><a href="#dialogue"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dialogue</span></a><a href="#dialoguetokens"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dialogue<wbr/>Tokens</span></a><a href="#enemypartyconfigs"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enemy<wbr/>Party<wbr/>Configs</span></a><a href="#enterintrovisualsfromright"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enter<wbr/>Intro<wbr/>Visuals<wbr/>From<wbr/>Right</span></a><a href="#excludeprimaryfromsupportrequirements"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>exclude<wbr/>Primary<wbr/>From<wbr/>Support<wbr/>Requirements</span></a><a href="#expmultiplier"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>exp<wbr/>Multiplier</span></a><a href="#fleeallowed"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>flee<wbr/>Allowed</span></a><a href="#hasbattleanimationswithouttargets"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has<wbr/>Battle<wbr/>Animations<wbr/>Without<wbr/>Targets</span></a><a href="#hidebattleintromessage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hide<wbr/>Battle<wbr/>Intro<wbr/>Message</span></a><a href="#localizationkey"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>localization<wbr/>Key</span></a><a href="#lockencounterrewardtiers"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>lock<wbr/>Encounter<wbr/>Reward<wbr/>Tiers</span></a><a href="#maxallowedencounters"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Allowed<wbr/>Encounters</span></a><a href="#options"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a><a href="#preventgamestatsupdates"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prevent<wbr/>Game<wbr/>Stats<wbr/>Updates</span></a><a href="#primarypokemonrequirements"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>primary<wbr/>Pokemon<wbr/>Requirements</span></a><a href="#requirements"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>requirements</span></a><a href="#secondarypokemonrequirements"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>secondary<wbr/>Pokemon<wbr/>Requirements</span></a><a href="#skipenemybattleturns"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>skip<wbr/>Enemy<wbr/>Battle<wbr/>Turns</span></a><a href="#skiptofightinput"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>skip<wbr/>To<wbr/>Fight<wbr/>Input</span></a><a href="#startofbattleeffectscomplete"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><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="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#build"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build</span></a><a href="#setlocalizationkey"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Localization<wbr/>Key</span></a><a href="#withanimations"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Animations</span></a><a href="#withautohideintrovisuals"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Auto<wbr/>Hide<wbr/>Intro<wbr/>Visuals</span></a><a href="#withbattleanimationswithouttargets"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Battle<wbr/>Animations<wbr/>Without<wbr/>Targets</span></a><a href="#withcatchallowed"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Catch<wbr/>Allowed</span></a><a href="#withcontinuousencounter"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Continuous<wbr/>Encounter</span></a><a href="#withdescription"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Description</span></a><a href="#withdisallowedchallenges"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Disallowed<wbr/>Challenges</span></a><a href="#withdisallowedgamemodes"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Disallowed<wbr/>Game<wbr/>Modes</span></a><a href="#withencountertier"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Encounter<wbr/>Tier</span></a><a href="#withenterintrovisualsfromright"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Exp</span></a><a href="#withfleeallowed"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Flee<wbr/>Allowed</span></a><a href="#withhidewildintromessage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Hide<wbr/>Wild<wbr/>Intro<wbr/>Message</span></a><a href="#withintro"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Intro</span></a><a href="#withintrodialogue"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Intro<wbr/>Dialogue</span></a><a href="#withintrospriteconfigs"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Intro<wbr/>Sprite<wbr/>Configs</span></a><a href="#withmaxallowedencounters"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Max<wbr/>Allowed<wbr/>Encounters</span></a><a href="#withoninit"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>On<wbr/>Init</span></a><a href="#withonvisualsstart"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>On<wbr/>Visuals<wbr/>Start</span></a><a href="#withoption"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Option</span></a><a href="#withoutrodialogue"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Outro<wbr/>Dialogue</span></a><a href="#withpreventgamestatsupdates"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Prevent<wbr/>Game<wbr/>Stats<wbr/>Updates</span></a><a href="#withprimarypokemonhealthratiorequirement"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Primary<wbr/>Pokemon<wbr/>Requirement</span></a><a href="#withprimarypokemonstatuseffectrequirement"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Query</span></a><a href="#withrewards"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Rewards</span></a><a href="#withscenepartysizerequirement"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Scene<wbr/>Party<wbr/>Size<wbr/>Requirement</span></a><a href="#withscenerequirement"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Scene<wbr/>Requirement</span></a><a href="#withscenewaverangerequirement"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Scene<wbr/>Wave<wbr/>Range<wbr/>Requirement</span></a><a href="#withsecondarypokemonrequirement"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Secondary<wbr/>Pokemon<wbr/>Requirement</span></a><a href="#withsimpledexprogressoption"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Simple<wbr/>Dex<wbr/>Progress<wbr/>Option</span></a><a href="#withsimpleoption"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Simple<wbr/>Option</span></a><a href="#withskipenemybattleturns"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Skip<wbr/>Enemy<wbr/>Battle<wbr/>Turns</span></a><a href="#withskiptofightinput"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Skip<wbr/>To<wbr/>Fight<wbr/>Input</span></a><a href="#withtitle"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Title</span></a><a href="#withencountertype"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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="../modules.html">pokemon-rogue-battle</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><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>
Reference in New Issue View Git Blame Copy Permalink