<!DOCTYPE html><htmlclass="default"lang="en"><head><metacharset="utf-8"/><metahttp-equiv="x-ua-compatible"content="IE=edge"/><title>MysteryEncounterBuilder | pokemon-rogue-battle</title><metaname="description"content="Documentation for pokemon-rogue-battle"/><metaname="viewport"content="width=device-width, initial-scale=1"/><linkrel="stylesheet"href="../assets/style.css"/><linkrel="stylesheet"href="../assets/highlight.css"/><scriptdefersrc="../assets/main.js"></script><scriptasyncsrc="../assets/icons.js"id="tsd-icons-script"></script><scriptasyncsrc="../assets/search.js"id="tsd-search-script"></script><scriptasyncsrc="../assets/navigation.js"id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme=localStorage.getItem("tsd-theme")||"os";document.body.style.display="none";setTimeout(()=>app?app.showPage():document.body.style.removeProperty("display"),500)</script><headerclass="tsd-page-toolbar"><divclass="tsd-toolbar-contents container"><divclass="table-cell"id="tsd-search"data-base=".."><divclass="field"><labelfor="tsd-search-field"class="tsd-widget tsd-toolbar-icon search no-caption"><svgwidth="16"height="16"viewBox="0 0 16 16"fill="none"><usehref="../assets/icons.svg#icon-search"></use></svg></label><inputtype="text"id="tsd-search-field"aria-label="Search"/></div><divclass="field"><divid="tsd-toolbar-links"></div></div><ulclass="results"><liclass="state loading">Preparing search index...</li><liclass="state failure">The search index is not available</li></ul><ahref="../index.html"class="title">pokemon-rogue-battle</a></div><divclass="table-cell"id="tsd-widgets"><ahref="#"class="tsd-widget tsd-toolbar-icon menu no-caption"data-toggle="menu"aria-label="Menu"><svgwidth="16"height="16"viewBox="0 0 16 16"fill="none"><usehref="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><divclass="container container-main"><divclass="col-content"><divclass="tsd-page-title"><ulclass="tsd-breadcrumb"><li><ahref="../index.html">pokemon-rogue-battle</a></li><li><ahref="../modules/data_mystery_encounters_mystery_encounter.html">data/mystery-encounters/mystery-encounter</a></li><li><ahref="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html">MysteryEncounterBuilder</a></li></ul><h1>Class MysteryEncounterBuilder</h1></div><sectionclass="tsd-panel tsd-comment"><divclass="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><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">this</span>: <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html"class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a></span></li></ul></div><h4class="tsd-returns-title">Returns <ahref="data_mystery_encounters_mystery_encounter.default.html"class="tsd-signature-type tsd-kind-class">default</a></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L1020">src/data/mystery-encounters/mystery-encounter.ts:1020</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="setLocalizationKey"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Localization<wbr/>Key</span><ahref="#setLocalizationKey"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="setLocalizationKey.setLocalizationKey-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Localization<wbr/>Key</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">localizationKey</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setLocalizationKey.setLocalizationKey-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Sets the localization key used by the encounter</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">localizationKey</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>the string used as the key</p>
<divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L648">src/data/mystery-encounters/mystery-encounter.ts:648</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="withAnimations"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>with<wbr/>Animations</span><ahref="#withAnimations"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="withAnimations.withAnimations-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">with<wbr/>Animations</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">encounterAnimations</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><ahref="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html"class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><spanclass="tsd-signature-symbol">&</span><spanclass="tsd-signature-type">Required</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">Pick</span><spanclass="tsd-signature-symbol"><</span><ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html"class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><spanclass="tsd-signature-symbol">, </span><spanclass="tsd-signature-type">"encounterAnimations"</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#withAnimations.withAnimations-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Defines any EncounterAnim animations that are intended to be used during the encounter
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag">Rest</code><spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">encounterAnimations</span>: <ahref="../enums/enums_encounter_anims.EncounterAnim.html"class="tsd-signature-type tsd-kind-enum">EncounterAnim</a><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <ahref="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html"class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><spanclass="tsd-signature-symbol">&</span><spanclass="tsd-signature-type">Required</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">Pick</span><spanclass="tsd-signature-symbol"><</span><ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html"class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><spanclass="tsd-signature-symbol">, </span><spanclass="tsd-signature-type">"encounterAnimations"</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L680">src/data/mystery-encounters/mystery-encounter.ts:680</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="withAutoHideIntroVisuals"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>with<wbr/>Auto<wbr/>Hide<wbr/>Intro<wbr/>Visuals</span><ahref="#withAutoHideIntroVisuals"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="withAutoHideIntroVisuals.withAutoHideIntroVisuals-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">with<wbr/>Auto<wbr/>Hide<wbr/>Intro<wbr/>Visuals</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">autoHideIntroVisuals</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><ahref="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html"class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><spanclass="tsd-signature-symbol">&</span><spanclass="tsd-signature-type">Required</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">Pick</span><spanclass="tsd-signature-symbol"><</span><ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html"class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><spanclass="tsd-signature-symbol">, </span><spanclass="tsd-signature-type">"autoHideIntroVisuals"</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#withAutoHideIntroVisuals.withAutoHideIntroVisuals-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">autoHideIntroVisuals</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="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><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <ahref="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html"class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><spanclass="tsd-signature-symbol">&</span><spanclass="tsd-signature-type">Required</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">Pick</span><spanclass="tsd-signature-symbol"><</span><ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html"class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><spanclass="tsd-signature-symbol">, </span><spanclass="tsd-signature-type">"autoHideIntroVisuals"</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L931">src/data/mystery-encounters/mystery-encounter.ts:931</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="withBattleAnimationsWithoutTargets"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>with<wbr/>Battle<wbr/>Animations<wbr/>Without<wbr/>Targets</span><ahref="#withBattleAnimationsWithoutTargets"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="withBattleAnimationsWithoutTargets.withBattleAnimationsWithoutTargets-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">with<wbr/>Battle<wbr/>Animations<wbr/>Without<wbr/>Targets</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">hasBattleAnimationsWithoutTargets</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><ahref="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html"class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><spanclass="tsd-signature-symbol">&</span><spanclass="tsd-signature-type">Required</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">Pick</span><spanclass="tsd-signature-symbol"><</span><ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html"class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><spanclass="tsd-signature-symbol">, </span><spanclass="tsd-signature-type">"hasBattleAnimationsWithoutTargets"</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#withBattleAnimationsWithoutTargets.withBattleAnimationsWithoutTargets-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>If true, encounter will not animate the target Pokemon as part of battle animations
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">hasBattleAnimationsWithoutTargets</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <ahref="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html"class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><spanclass="tsd-signature-symbol">&</span><spanclass="tsd-signature-type">Required</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">Pick</span><spanclass="tsd-signature-symbol"><</span><ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html"class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><spanclass="tsd-signature-symbol">, </span><spanclass="tsd-signature-type">"hasBattleAnimationsWithoutTargets"</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L721">src/data/mystery-encounters/mystery-encounter.ts:721</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="withCatchAllowed"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>with<wbr/>Catch<wbr/>Allowed</span><ahref="#withCatchAllowed"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="withCatchAllowed.withCatchAllowed-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">with<wbr/>Catch<wbr/>Allowed</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">catchAllowed</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><ahref="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html"class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><spanclass="tsd-signature-symbol">&</span><spanclass="tsd-signature-type">Required</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">Pick</span><spanclass="tsd-signature-symbol"><</span><ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html"class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><spanclass="tsd-signature-symbol">, </span><spanclass="tsd-signature-type">"catchAllowed"</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#withCatchAllowed.withCatchAllowed-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="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><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">catchAllowed</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>If <code>true</code>, allows enemy pokemon to be caught during the encounter</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">description</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>Description of the encounter</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">encounterTier</span>: <ahref="../enums/enums_mystery_encounter_tier.MysteryEncounterTier.html"class="tsd-signature-type tsd-kind-enum">MysteryEncounterTier</a></span><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <ahref="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html"class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><spanclass="tsd-signature-symbol">&</span><spanclass="tsd-signature-type">Pick</span><spanclass="tsd-signature-symbol"><</span><ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html"class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><spanclass="tsd-signature-symbol">, </span><spanclass="tsd-signature-type">"encounterTier"</span><spanclass="tsd-signature-symbol">></span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L669">src/data/mystery-encounters/mystery-encounter.ts:669</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="withEnterIntroVisualsFromRight"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>with<wbr/>Enter<wbr/>Intro<wbr/>Visuals<wbr/>From<wbr/>Right</span><ahref="#withEnterIntroVisualsFromRight"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="withEnterIntroVisualsFromRight.withEnterIntroVisualsFromRight-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">with<wbr/>Enter<wbr/>Intro<wbr/>Visuals<wbr/>From<wbr/>Right</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">enterIntroVisualsFromRight</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><ahref="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html"class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><spanclass="tsd-signature-symbol">&</span><spanclass="tsd-signature-type">Required</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">Pick</span><spanclass="tsd-signature-symbol"><</span><ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html"class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><spanclass="tsd-signature-symbol">, </span><spanclass="tsd-signature-type">"enterIntroVisualsFromRight"</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#withEnterIntroVisualsFromRight.withEnterIntroVisualsFromRight-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">enterIntroVisualsFromRight</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="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
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><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">doEncounterExp</span>: <spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">scene</span><spanclass="tsd-signature-symbol">: </span><ahref="battle_scene.default.html"class="tsd-signature-type tsd-kind-class">default</a><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol"> =></span><spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol">)</span></span><divclass="tsd-comment tsd-typography"><p>Synchronous callback function to perform during rewards phase of the encounter</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">fleeAllowed</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>If <code>false</code>, prevents fleeing from a wild battle (trainer battle MEs already have flee disabled)</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <ahref="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html"class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><spanclass="tsd-signature-symbol">&</span><spanclass="tsd-signature-type">Required</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">Pick</span><spanclass="tsd-signature-symbol"><</span><ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html"class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><spanclass="tsd-signature-symbol">, </span><spanclass="tsd-signature-type">"fleeAllowed"</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L915">src/data/mystery-encounters/mystery-encounter.ts:915</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="withHideWildIntroMessage"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>with<wbr/>Hide<wbr/>Wild<wbr/>Intro<wbr/>Message</span><ahref="#withHideWildIntroMessage"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="withHideWildIntroMessage.withHideWildIntroMessage-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">with<wbr/>Hide<wbr/>Wild<wbr/>Intro<wbr/>Message</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">hideBattleIntroMessage</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><ahref="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html"class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><spanclass="tsd-signature-symbol">&</span><spanclass="tsd-signature-type">Required</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">Pick</span><spanclass="tsd-signature-symbol"><</span><ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html"class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><spanclass="tsd-signature-symbol">, </span><spanclass="tsd-signature-type">"hideBattleIntroMessage"</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#withHideWildIntroMessage.withHideWildIntroMessage-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">hideBattleIntroMessage</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>If <code>true</code>, will not show the trainerAppeared/wildAppeared/bossAppeared message for an encounter</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">spriteConfigs</span>: <ahref="field_mystery_encounter_intro.MysteryEncounterSpriteConfig.html"class="tsd-signature-type tsd-kind-class">MysteryEncounterSpriteConfig</a><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <ahref="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html"class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><spanclass="tsd-signature-symbol">&</span><spanclass="tsd-signature-type">Pick</span><spanclass="tsd-signature-symbol"><</span><ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html"class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><spanclass="tsd-signature-symbol">, </span><spanclass="tsd-signature-type">"spriteConfigs"</span><spanclass="tsd-signature-symbol">></span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L630">src/data/mystery-encounters/mystery-encounter.ts:630</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="withMaxAllowedEncounters"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>with<wbr/>Max<wbr/>Allowed<wbr/>Encounters</span><ahref="#withMaxAllowedEncounters"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="withMaxAllowedEncounters.withMaxAllowedEncounters-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">with<wbr/>Max<wbr/>Allowed<wbr/>Encounters</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">maxAllowedEncounters</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><ahref="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html"class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><spanclass="tsd-signature-symbol">&</span><spanclass="tsd-signature-type">Required</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">Pick</span><spanclass="tsd-signature-symbol"><</span><ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html"class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><spanclass="tsd-signature-symbol">, </span><spanclass="tsd-signature-type">"maxAllowedEncounters"</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#withMaxAllowedEncounters.withMaxAllowedEncounters-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Sets the maximum number of times that an encounter can spawn in a given Classic run</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">maxAllowedEncounters</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <ahref="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html"class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><spanclass="tsd-signature-symbol">&</span><spanclass="tsd-signature-type">Required</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">Pick</span><spanclass="tsd-signature-symbol"><</span><ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html"class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><spanclass="tsd-signature-symbol">, </span><spanclass="tsd-signature-type">"maxAllowedEncounters"</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L757">src/data/mystery-encounters/mystery-encounter.ts:757</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="withOnInit"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>with<wbr/>On<wbr/>Init</span><ahref="#withOnInit"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="withOnInit.withOnInit-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">with<wbr/>On<wbr/>Init</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">onInit</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><ahref="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html"class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><spanclass="tsd-signature-symbol">&</span><spanclass="tsd-signature-type">Required</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">Pick</span><spanclass="tsd-signature-symbol"><</span><ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html"class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><spanclass="tsd-signature-symbol">, </span><spanclass="tsd-signature-type">"onInit"</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#withOnInit.withOnInit-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="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><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">onInit</span>: <spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">scene</span><spanclass="tsd-signature-symbol">: </span><ahref="battle_scene.default.html"class="tsd-signature-type tsd-kind-class">default</a><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol"> =></span><spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol">)</span></span><divclass="tsd-comment tsd-typography"><p>Synchronous callback function to perform as soon as the encounter is selected for the next phase</p>
</div><divclass="tsd-comment tsd-typography"></div><ulclass="tsd-parameters"><liclass="tsd-parameter-signature"><ulclass="tsd-signatures"><liclass="tsd-signature"><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">scene</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">boolean</span></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">scene</span>: <ahref="battle_scene.default.html"class="tsd-signature-type tsd-kind-class">default</a></span></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4></li></ul></li></ul></li></ul></div><h4class="tsd-returns-title">Returns <ahref="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html"class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><spanclass="tsd-signature-symbol">&</span><spanclass="tsd-signature-type">Required</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">Pick</span><spanclass="tsd-signature-symbol"><</span><ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html"class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><spanclass="tsd-signature-symbol">, </span><spanclass="tsd-signature-type">"onInit"</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L886">src/data/mystery-encounters/mystery-encounter.ts:886</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="withOnVisualsStart"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>with<wbr/>On<wbr/>Visuals<wbr/>Start</span><ahref="#withOnVisualsStart"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="withOnVisualsStart.withOnVisualsStart-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">with<wbr/>On<wbr/>Visuals<wbr/>Start</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">onVisualsStart</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><ahref="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html"class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><spanclass="tsd-signature-symbol">&</span><spanclass="tsd-signature-type">Required</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">Pick</span><spanclass="tsd-signature-symbol"><</span><ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html"class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><spanclass="tsd-signature-symbol">, </span><spanclass="tsd-signature-type">"onVisualsStart"</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#withOnVisualsStart.withOnVisualsStart-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="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><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">onVisualsStart</span>: <spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">scene</span><spanclass="tsd-signature-symbol">: </span><ahref="battle_scene.default.html"class="tsd-signature-type tsd-kind-class">default</a><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol"> =></span><spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol">)</span></span><divclass="tsd-comment tsd-typography"><p>Synchronous callback function to perform as soon as the enemy field finishes sliding in</p>
There should be at least 2 options defined and no more than 4.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">option</span>: <ahref="data_mystery_encounters_mystery_encounter_option.default.html"class="tsd-signature-type tsd-kind-class">default</a></span><divclass="tsd-comment tsd-typography"><p>MysteryEncounterOption to add, can use MysteryEncounterOptionBuilder to create instance</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">requiredHealthRange</span>: <spanclass="tsd-signature-symbol">[</span><spanclass="tsd-signature-type">number</span><spanclass="tsd-signature-symbol">, </span><spanclass="tsd-signature-type">number</span><spanclass="tsd-signature-symbol">]</span></span><divclass="tsd-comment tsd-typography"><p>the health range to check</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">minNumberOfPokemon</span>: <spanclass="tsd-signature-type">number</span><spanclass="tsd-signature-symbol"> = 1</span></span><divclass="tsd-comment tsd-typography"><p>minimum number of pokemon to have the health range</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">invertQuery</span>: <spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol"> = false</span></span><divclass="tsd-comment tsd-typography"><p>if true will invert the query</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">statusEffect</span>: <ahref="../enums/enums_status_effect.StatusEffect.html"class="tsd-signature-type tsd-kind-enum">StatusEffect</a><spanclass="tsd-signature-symbol"> | </span><ahref="../enums/enums_status_effect.StatusEffect.html"class="tsd-signature-type tsd-kind-enum">StatusEffect</a><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>the status effect/s to check</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">minNumberOfPokemon</span>: <spanclass="tsd-signature-type">number</span><spanclass="tsd-signature-symbol"> = 1</span></span><divclass="tsd-comment tsd-typography"><p>minimum number of pokemon to have the effect</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">invertQuery</span>: <spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol"> = false</span></span><divclass="tsd-comment tsd-typography"><p>if true will invert the query</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">query</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>Query to use for the encounter</p>
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><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">doEncounterRewards</span>: <spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">scene</span><spanclass="tsd-signature-symbol">: </span><ahref="battle_scene.default.html"class="tsd-signature-type tsd-kind-class">default</a><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol"> =></span><spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol">)</span></span><divclass="tsd-comment tsd-typography"><p>Synchronous callback function to perform during rewards phase of the encounter</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">min</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>min wave (or exact size if only min is given)</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">max</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>optional max size. If not given, defaults to min => exact wave</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">excludeDisallowedPokemon</span>: <spanclass="tsd-signature-type">boolean</span><spanclass="tsd-signature-symbol"> = false</span></span><divclass="tsd-comment tsd-typography"><p>if true, only counts allowed (legal in Challenge/unfainted) mons</p>
For example, passing requirement as "new WaveCountRequirement([2, 180])" would create a requirement that the encounter can only be spawned between waves 2 and 180
Existing Requirement objects are defined in mystery-encounter-requirements.ts, and more can always be created to meet a requirement need</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">min</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>min wave (or exact wave if only min is given)</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag">Optional</code><spanclass="tsd-kind-parameter">max</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>optional max wave. If not given, defaults to min => exact wave</p>
There should be at least 2 options defined and no more than 4.
If complex use <ahref="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withOption"class="tsd-kind-method"><code>MysteryEncounterBuilder.withOption</code></a></p>
There should be at least 2 options defined and no more than 4.
If complex use <ahref="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html#withOption"class="tsd-kind-method"><code>MysteryEncounterBuilder.withOption</code></a></p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <ahref="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html"class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><spanclass="tsd-signature-symbol">&</span><spanclass="tsd-signature-type">Pick</span><spanclass="tsd-signature-symbol"><</span><ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html"class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><spanclass="tsd-signature-symbol">, </span><spanclass="tsd-signature-type">"options"</span><spanclass="tsd-signature-symbol">></span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L602">src/data/mystery-encounters/mystery-encounter.ts:602</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="withSkipEnemyBattleTurns"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>with<wbr/>Skip<wbr/>Enemy<wbr/>Battle<wbr/>Turns</span><ahref="#withSkipEnemyBattleTurns"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="withSkipEnemyBattleTurns.withSkipEnemyBattleTurns-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">with<wbr/>Skip<wbr/>Enemy<wbr/>Battle<wbr/>Turns</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">skipEnemyBattleTurns</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><ahref="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html"class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><spanclass="tsd-signature-symbol">&</span><spanclass="tsd-signature-type">Required</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">Pick</span><spanclass="tsd-signature-symbol"><</span><ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html"class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><spanclass="tsd-signature-symbol">, </span><spanclass="tsd-signature-type">"skipEnemyBattleTurns"</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span><ahref="#withSkipEnemyBattleTurns.withSkipEnemyBattleTurns-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>If true, encounter will not animate the target Pokemon as part of battle animations
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">skipToFightInput</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <ahref="data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html"class="tsd-signature-type tsd-kind-class">MysteryEncounterBuilder</a><spanclass="tsd-signature-symbol">&</span><spanclass="tsd-signature-type">Required</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">Pick</span><spanclass="tsd-signature-symbol"><</span><ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html"class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a><spanclass="tsd-signature-symbol">, </span><spanclass="tsd-signature-type">"skipToFightInput"</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">></span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/data/mystery-encounters/mystery-encounter.ts#L740">src/data/mystery-encounters/mystery-encounter.ts:740</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="withTitle"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>with<wbr/>Title</span><ahref="#withTitle"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="withTitle.withTitle-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">with<wbr/>Title</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">title</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#withTitle.withTitle-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Add a title for the encounter</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">title</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>Title of the encounter</p>
<divclass="tsd-comment tsd-typography"><h4class="tsd-anchor-link"><aid="Statif"class="tsd-anchor"></a>Statif<ahref="#Statif"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../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 <ahref="data_mystery_encounters_mystery_encounter.default.html"class="tsd-kind-class"><code>MysteryEncounter</code></a> class</p>
