<!DOCTYPE html><htmlclass="default"lang="en"><head><metacharset="utf-8"/><metahttp-equiv="x-ua-compatible"content="IE=edge"/><title>default | 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.default.html">default</a></li></ul><h1>Class default</h1></div><sectionclass="tsd-panel tsd-comment"><divclass="tsd-comment tsd-typography"><p>MysteryEncounter class that defines the logic for a single encounter
These objects will be saved as part of session data any time the player is on a floor with an encounter
Unless you know what you're doing, you should use MysteryEncounterBuilder to create an instance for this class</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Implementation of <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#autoHideIntroVisuals">autoHideIntroVisuals</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L112">src/data/mystery-encounters/mystery-encounter.ts:112</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="catchAllowed"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>catch<wbr/>Allowed</span><ahref="#catchAllowed"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">catch<wbr/>Allowed</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span></div><divclass="tsd-comment tsd-typography"><p>If true, allows catching a wild pokemon during the encounter
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Implementation of <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#catchAllowed">catchAllowed</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L122">src/data/mystery-encounters/mystery-encounter.ts:122</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="continuousEncounter"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>continuous<wbr/>Encounter</span><ahref="#continuousEncounter"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">continuous<wbr/>Encounter</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span></div><divclass="tsd-comment tsd-typography"><p>If true, encounter will continuously run through multiple battles/puzzles/etc. instead of going to next wave
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Implementation of <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#continuousEncounter">continuousEncounter</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L133">src/data/mystery-encounters/mystery-encounter.ts:133</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="dialogue"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>dialogue</span><ahref="#dialogue"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">dialogue</span><spanclass="tsd-signature-symbol">:</span><ahref="data_mystery_encounters_mystery_encounter_dialogue.default.html"class="tsd-signature-type tsd-kind-class">default</a></div><divclass="tsd-comment tsd-typography"><p>Dialogue object containing all the dialogue, messages, tooltips, etc. for an encounter</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Implementation of <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#dialogue">dialogue</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L197">src/data/mystery-encounters/mystery-encounter.ts:197</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="dialogueTokens"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>dialogue<wbr/>Tokens</span><ahref="#dialogueTokens"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">dialogue<wbr/>Tokens</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">Record</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">, </span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">></span></div><divclass="tsd-comment tsd-typography"><p>Can be set for uses programatic dialogue during an encounter (storing the name of one of the party's pokemon, etc.)
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Implementation of <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#dialogueTokens">dialogueTokens</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L217">src/data/mystery-encounters/mystery-encounter.ts:217</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="disallowedChallenges"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag">Optional</code><span>disallowed<wbr/>Challenges</span><ahref="#disallowedChallenges"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">disallowed<wbr/>Challenges</span><spanclass="tsd-signature-symbol">?:</span><ahref="../enums/enums_challenges.Challenges.html"class="tsd-signature-type tsd-kind-enum">Challenges</a><spanclass="tsd-signature-symbol">[]</span></div><divclass="tsd-comment tsd-typography"><p>If specified, defines any challenges (from Challenge game mode) where the <ahref="data_mystery_encounters_mystery_encounter.default.html"class="tsd-kind-class"><code>MysteryEncounter</code></a> should <em>NOT</em> spawn</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Implementation of <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#disallowedChallenges">disallowedChallenges</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L102">src/data/mystery-encounters/mystery-encounter.ts:102</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="disallowedGameModes"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag">Optional</code><span>disallowed<wbr/>Game<wbr/>Modes</span><ahref="#disallowedGameModes"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">disallowed<wbr/>Game<wbr/>Modes</span><spanclass="tsd-signature-symbol">?:</span><ahref="../enums/game_mode.GameModes.html"class="tsd-signature-type tsd-kind-enum">GameModes</a><spanclass="tsd-signature-symbol">[]</span></div><divclass="tsd-comment tsd-typography"><p>If specified, defines any game modes where the <ahref="data_mystery_encounters_mystery_encounter.default.html"class="tsd-kind-class"><code>MysteryEncounter</code></a> should <em>NOT</em> spawn</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Implementation of <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#disallowedGameModes">disallowedGameModes</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L98">src/data/mystery-encounters/mystery-encounter.ts:98</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="doContinueEncounter"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag">Optional</code><span>do<wbr/>Continue<wbr/>Encounter</span><ahref="#doContinueEncounter"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">do<wbr/>Continue<wbr/>Encounter</span><spanclass="tsd-signature-symbol">?:</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">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">void</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">)</span></div><divclass="tsd-comment tsd-typography"><p>Will execute callback during VictoryPhase of a continuousEncounter</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Implementation of <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#doContinueEncounter">doContinueEncounter</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L169">src/data/mystery-encounters/mystery-encounter.ts:169</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="doEncounterExp"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag">Optional</code><span>do<wbr/>Encounter<wbr/>Exp</span><ahref="#doEncounterExp"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">do<wbr/>Encounter<wbr/>Exp</span><spanclass="tsd-signature-symbol">?:</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></div><divclass="tsd-comment tsd-typography"><p>Will provide the player party EXP before rewards are displayed for that wave</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Implementation of <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#doEncounterExp">doEncounterExp</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L165">src/data/mystery-encounters/mystery-encounter.ts:165</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="doEncounterRewards"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag">Optional</code><span>do<wbr/>Encounter<wbr/>Rewards</span><ahref="#doEncounterRewards"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">do<wbr/>Encounter<wbr/>Rewards</span><spanclass="tsd-signature-symbol">?:</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></div><divclass="tsd-comment tsd-typography"><p>Will provide the player a rewards shop for that wave</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Implementation of <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#doEncounterRewards">doEncounterRewards</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L167">src/data/mystery-encounters/mystery-encounter.ts:167</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="encounterAnimations"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag">Optional</code><span>encounter<wbr/>Animations</span><ahref="#encounterAnimations"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">encounter<wbr/>Animations</span><spanclass="tsd-signature-symbol">?:</span><ahref="../enums/enums_encounter_anims.EncounterAnim.html"class="tsd-signature-type tsd-kind-enum">EncounterAnim</a><spanclass="tsd-signature-symbol">[]</span></div><divclass="tsd-comment tsd-typography"><p>Custom battle animations that are configured for encounter effects and visuals
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Implementation of <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#encounterAnimations">encounterAnimations</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L94">src/data/mystery-encounters/mystery-encounter.ts:94</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="encounterMode"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>encounter<wbr/>Mode</span><ahref="#encounterMode"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">encounter<wbr/>Mode</span><spanclass="tsd-signature-symbol">:</span><ahref="../enums/enums_mystery_encounter_mode.MysteryEncounterMode.html"class="tsd-signature-type tsd-kind-enum">MysteryEncounterMode</a></div><divclass="tsd-comment tsd-typography"><p>Should be set depending upon option selected as part of an encounter
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L223">src/data/mystery-encounters/mystery-encounter.ts:223</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="encounterTier"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>encounter<wbr/>Tier</span><ahref="#encounterTier"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">encounter<wbr/>Tier</span><spanclass="tsd-signature-symbol">:</span><ahref="../enums/enums_mystery_encounter_tier.MysteryEncounterTier.html"class="tsd-signature-type tsd-kind-enum">MysteryEncounterTier</a></div><asideclass="tsd-sources"><p>Implementation of <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#encounterTier">encounterTier</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L89">src/data/mystery-encounters/mystery-encounter.ts:89</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="encounterType"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>encounter<wbr/>Type</span><ahref="#encounterType"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">encounter<wbr/>Type</span><spanclass="tsd-signature-symbol">:</span><ahref="../enums/enums_mystery_encounter_type.MysteryEncounterType.html"class="tsd-signature-type tsd-kind-enum">MysteryEncounterType</a></div><asideclass="tsd-sources"><p>Implementation of <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#encounterType">encounterType</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L83">src/data/mystery-encounters/mystery-encounter.ts:83</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="enemyPartyConfigs"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>enemy<wbr/>Party<wbr/>Configs</span><ahref="#enemyPartyConfigs"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">enemy<wbr/>Party<wbr/>Configs</span><spanclass="tsd-signature-symbol">:</span><ahref="../interfaces/data_mystery_encounters_utils_encounter_phase_utils.EnemyPartyConfig.html"class="tsd-signature-type tsd-kind-interface">EnemyPartyConfig</a><spanclass="tsd-signature-symbol">[]</span></div><divclass="tsd-comment tsd-typography"><p>Data used for setting up/initializing enemy party in battles
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Implementation of <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#enemyPartyConfigs">enemyPartyConfigs</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L203">src/data/mystery-encounters/mystery-encounter.ts:203</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="enterIntroVisualsFromRight"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>enter<wbr/>Intro<wbr/>Visuals<wbr/>From<wbr/>Right</span><ahref="#enterIntroVisualsFromRight"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">enter<wbr/>Intro<wbr/>Visuals<wbr/>From<wbr/>Right</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span></div><divclass="tsd-comment tsd-typography"><p>Intro visuals on the field will slide in from the right instead of the left
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Implementation of <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#enterIntroVisualsFromRight">enterIntroVisualsFromRight</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L117">src/data/mystery-encounters/mystery-encounter.ts:117</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="excludePrimaryFromSupportRequirements"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>exclude<wbr/>Primary<wbr/>From<wbr/>Support<wbr/>Requirements</span><ahref="#excludePrimaryFromSupportRequirements"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">exclude<wbr/>Primary<wbr/>From<wbr/>Support<wbr/>Requirements</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span></div><asideclass="tsd-sources"><p>Implementation of <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#excludePrimaryFromSupportRequirements">excludePrimaryFromSupportRequirements</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L188">src/data/mystery-encounters/mystery-encounter.ts:188</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="expMultiplier"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>exp<wbr/>Multiplier</span><ahref="#expMultiplier"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">exp<wbr/>Multiplier</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>Can be set higher or lower based on the type of battle or exp gained for an option/encounter
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Implementation of <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#expMultiplier">expMultiplier</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L246">src/data/mystery-encounters/mystery-encounter.ts:246</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="fleeAllowed"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>flee<wbr/>Allowed</span><ahref="#fleeAllowed"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">flee<wbr/>Allowed</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span></div><divclass="tsd-comment tsd-typography"><p>If true, allows fleeing from a wild encounter (trainer battle MEs auto-disable fleeing)
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Implementation of <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#fleeAllowed">fleeAllowed</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L127">src/data/mystery-encounters/mystery-encounter.ts:127</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="hasBattleAnimationsWithoutTargets"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>has<wbr/>Battle<wbr/>Animations<wbr/>Without<wbr/>Targets</span><ahref="#hasBattleAnimationsWithoutTargets"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">has<wbr/>Battle<wbr/>Animations<wbr/>Without<wbr/>Targets</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span></div><divclass="tsd-comment tsd-typography"><p>If true, encounter will not animate the target Pokemon as part of battle animations
Used for encounters where it is not a "real" battle, but still uses battle animations and commands (see FunAndGamesEncounter for an example)</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Implementation of <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#hasBattleAnimationsWithoutTargets">hasBattleAnimationsWithoutTargets</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L143">src/data/mystery-encounters/mystery-encounter.ts:143</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="hideBattleIntroMessage"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>hide<wbr/>Battle<wbr/>Intro<wbr/>Message</span><ahref="#hideBattleIntroMessage"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">hide<wbr/>Battle<wbr/>Intro<wbr/>Message</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span></div><divclass="tsd-comment tsd-typography"><p>If true, hides "A Wild X Appeared" etc. messages
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Implementation of <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#hideBattleIntroMessage">hideBattleIntroMessage</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L107">src/data/mystery-encounters/mystery-encounter.ts:107</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="introVisuals"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag">Optional</code><span>intro<wbr/>Visuals</span><ahref="#introVisuals"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">intro<wbr/>Visuals</span><spanclass="tsd-signature-symbol">?:</span><ahref="field_mystery_encounter_intro.default.html"class="tsd-signature-type tsd-kind-class">default</a></div><divclass="tsd-comment tsd-typography"><p>Object instance containing sprite data for an encounter when it is being spawned
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L209">src/data/mystery-encounters/mystery-encounter.ts:209</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="loadAssets"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>load<wbr/>Assets</span><ahref="#loadAssets"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">load<wbr/>Assets</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">void</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">[]</span></div><divclass="tsd-comment tsd-typography"><p>Can add any asset load promises here during onInit() to make sure the scene awaits the loads properly</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L250">src/data/mystery-encounters/mystery-encounter.ts:250</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="lockEncounterRewardTiers"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>lock<wbr/>Encounter<wbr/>Reward<wbr/>Tiers</span><ahref="#lockEncounterRewardTiers"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">lock<wbr/>Encounter<wbr/>Reward<wbr/>Tiers</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span></div><divclass="tsd-comment tsd-typography"><p>Flag for checking if it's the first time a shop is being shown for an encounter.
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L229">src/data/mystery-encounters/mystery-encounter.ts:229</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="maxAllowedEncounters"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>max<wbr/>Allowed<wbr/>Encounters</span><ahref="#maxAllowedEncounters"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">max<wbr/>Allowed<wbr/>Encounters</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>Maximum number of times the encounter can be seen per run
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Implementation of <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#maxAllowedEncounters">maxAllowedEncounters</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L138">src/data/mystery-encounters/mystery-encounter.ts:138</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="misc"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag">Optional</code><span>misc</span><ahref="#misc"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">misc</span><spanclass="tsd-signature-symbol">?:</span><spanclass="tsd-signature-type">any</span></div><divclass="tsd-comment tsd-typography"><p>Generic property to set any custom data required for the encounter
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L255">src/data/mystery-encounters/mystery-encounter.ts:255</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="onGameOver"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag">Optional</code><span>on<wbr/>Game<wbr/>Over</span><ahref="#onGameOver"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">on<wbr/>Game<wbr/>Over</span><spanclass="tsd-signature-symbol">?:</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></div><divclass="tsd-comment tsd-typography"><p>Can perform special logic when a ME battle is lost, before GameOver/battle retry prompt.
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L174">src/data/mystery-encounters/mystery-encounter.ts:174</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="onInit"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag">Optional</code><span>on<wbr/>Init</span><ahref="#onInit"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">on<wbr/>Init</span><spanclass="tsd-signature-symbol">?:</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></div><divclass="tsd-comment tsd-typography"><p>Event when Encounter is first loaded, use it for data conditioning</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Implementation of <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#onInit">onInit</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L157">src/data/mystery-encounters/mystery-encounter.ts:157</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="onRewards"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag">Optional</code><span>on<wbr/>Rewards</span><ahref="#onRewards"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">on<wbr/>Rewards</span><spanclass="tsd-signature-symbol">?:</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">Promise</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">void</span><spanclass="tsd-signature-symbol">></span><spanclass="tsd-signature-symbol">)</span></div><divclass="tsd-comment tsd-typography"><p>Event prior to any rewards logic in MysteryEncounterRewardsPhase</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L163">src/data/mystery-encounters/mystery-encounter.ts:163</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="onTurnStart"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag">Optional</code><span>on<wbr/>Turn<wbr/>Start</span><ahref="#onTurnStart"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">on<wbr/>Turn<wbr/>Start</span><spanclass="tsd-signature-symbol">?:</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></div><divclass="tsd-comment tsd-typography"><p>Event triggered prior to CommandPhase, during TurnInitPhase</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L161">src/data/mystery-encounters/mystery-encounter.ts:161</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="onVisualsStart"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag">Optional</code><span>on<wbr/>Visuals<wbr/>Start</span><ahref="#onVisualsStart"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">on<wbr/>Visuals<wbr/>Start</span><spanclass="tsd-signature-symbol">?:</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></div><divclass="tsd-comment tsd-typography"><p>Event when battlefield visuals have finished sliding in and the encounter dialogue begins</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Implementation of <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#onVisualsStart">onVisualsStart</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L159">src/data/mystery-encounters/mystery-encounter.ts:159</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="options"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>options</span><ahref="#options"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">options</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-symbol">[</span><ahref="data_mystery_encounters_mystery_encounter_option.default.html"class="tsd-signature-type tsd-kind-class">default</a><spanclass="tsd-signature-symbol">, </span><ahref="data_mystery_encounters_mystery_encounter_option.default.html"class="tsd-signature-type tsd-kind-class">default</a><spanclass="tsd-signature-symbol">, </span><spanclass="tsd-signature-symbol">...</span><ahref="data_mystery_encounters_mystery_encounter_option.default.html"class="tsd-signature-type tsd-kind-class">default</a><spanclass="tsd-signature-symbol">[]</span><spanclass="tsd-signature-symbol">]</span></div><asideclass="tsd-sources"><p>Implementation of <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#options">options</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L84">src/data/mystery-encounters/mystery-encounter.ts:84</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="primaryPokemon"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag">Optional</code><span>primary<wbr/>Pokemon</span><ahref="#primaryPokemon"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">primary<wbr/>Pokemon</span><spanclass="tsd-signature-symbol">?:</span><ahref="field_pokemon.PlayerPokemon.html"class="tsd-signature-type tsd-kind-class">PlayerPokemon</a></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L189">src/data/mystery-encounters/mystery-encounter.ts:189</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="primaryPokemonRequirements"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>primary<wbr/>Pokemon<wbr/>Requirements</span><ahref="#primaryPokemonRequirements"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">primary<wbr/>Pokemon<wbr/>Requirements</span><spanclass="tsd-signature-symbol">:</span><ahref="data_mystery_encounters_mystery_encounter_requirements.EncounterPokemonRequirement.html"class="tsd-signature-type tsd-kind-class">EncounterPokemonRequirement</a><spanclass="tsd-signature-symbol">[]</span></div><divclass="tsd-comment tsd-typography"><p>Primary Pokemon is a single pokemon randomly selected from the party that meet ALL primary pokemon requirements</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Implementation of <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#primaryPokemonRequirements">primaryPokemonRequirements</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L181">src/data/mystery-encounters/mystery-encounter.ts:181</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="requirements"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>requirements</span><ahref="#requirements"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">requirements</span><spanclass="tsd-signature-symbol">:</span><ahref="data_mystery_encounters_mystery_encounter_requirements.EncounterSceneRequirement.html"class="tsd-signature-type tsd-kind-class">EncounterSceneRequirement</a><spanclass="tsd-signature-symbol">[]</span></div><divclass="tsd-comment tsd-typography"><p>Requirements</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Implementation of <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#requirements">requirements</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L179">src/data/mystery-encounters/mystery-encounter.ts:179</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="secondaryPokemon"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag">Optional</code><span>secondary<wbr/>Pokemon</span><ahref="#secondaryPokemon"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">secondary<wbr/>Pokemon</span><spanclass="tsd-signature-symbol">?:</span><ahref="field_pokemon.PlayerPokemon.html"class="tsd-signature-type tsd-kind-class">PlayerPokemon</a><spanclass="tsd-signature-symbol">[]</span></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L190">src/data/mystery-encounters/mystery-encounter.ts:190</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="secondaryPokemonRequirements"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>secondary<wbr/>Pokemon<wbr/>Requirements</span><ahref="#secondaryPokemonRequirements"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">secondary<wbr/>Pokemon<wbr/>Requirements</span><spanclass="tsd-signature-symbol">:</span><ahref="data_mystery_encounters_mystery_encounter_requirements.EncounterPokemonRequirement.html"class="tsd-signature-type tsd-kind-class">EncounterPokemonRequirement</a><spanclass="tsd-signature-symbol">[]</span></div><divclass="tsd-comment tsd-typography"><p>Secondary Pokemon are pokemon that meet ALL secondary pokemon requirements
Note that an individual requirement may require multiple pokemon, but the resulting pokemon after all secondary requirements are met may be lower than expected
If the primary pokemon and secondary pokemon are the same and ExcludePrimaryFromSupportRequirements flag is true, primary pokemon may be promoted from secondary pool</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Implementation of <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#secondaryPokemonRequirements">secondaryPokemonRequirements</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L187">src/data/mystery-encounters/mystery-encounter.ts:187</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="selectedOption"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag">Optional</code><span>selected<wbr/>Option</span><ahref="#selectedOption"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">selected<wbr/>Option</span><spanclass="tsd-signature-symbol">?:</span><ahref="data_mystery_encounters_mystery_encounter_option.default.html"class="tsd-signature-type tsd-kind-class">default</a></div><divclass="tsd-comment tsd-typography"><p>Will be set by option select handlers automatically, and can be used to refer to which option was chosen by later phases</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L237">src/data/mystery-encounters/mystery-encounter.ts:237</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="skipEnemyBattleTurns"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>skip<wbr/>Enemy<wbr/>Battle<wbr/>Turns</span><ahref="#skipEnemyBattleTurns"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">skip<wbr/>Enemy<wbr/>Battle<wbr/>Turns</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span></div><divclass="tsd-comment tsd-typography"><p>If true, will skip enemy pokemon turns during battle for the encounter
Used for encounters where it is not a "real" battle, but still uses battle animations and commands (see FunAndGamesEncounter for an example)</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Implementation of <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#skipEnemyBattleTurns">skipEnemyBattleTurns</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L148">src/data/mystery-encounters/mystery-encounter.ts:148</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="skipToFightInput"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>skip<wbr/>To<wbr/>Fight<wbr/>Input</span><ahref="#skipToFightInput"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">skip<wbr/>To<wbr/>Fight<wbr/>Input</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span></div><divclass="tsd-comment tsd-typography"><p>If true, will skip COMMAND input and go straight to FIGHT (move select) input menu</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Implementation of <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#skipToFightInput">skipToFightInput</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L152">src/data/mystery-encounters/mystery-encounter.ts:152</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="spriteConfigs"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>sprite<wbr/>Configs</span><ahref="#spriteConfigs"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">sprite<wbr/>Configs</span><spanclass="tsd-signature-symbol">:</span><ahref="field_mystery_encounter_intro.MysteryEncounterSpriteConfig.html"class="tsd-signature-type tsd-kind-class">MysteryEncounterSpriteConfig</a><spanclass="tsd-signature-symbol">[]</span></div><asideclass="tsd-sources"><p>Implementation of <ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<ahref="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#spriteConfigs">spriteConfigs</a></p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L85">src/data/mystery-encounters/mystery-encounter.ts:85</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="startOfBattleEffects"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>start<wbr/>Of<wbr/>Battle<wbr/>Effects</span><ahref="#startOfBattleEffects"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">start<wbr/>Of<wbr/>Battle<wbr/>Effects</span><spanclass="tsd-signature-symbol">:</span><ahref="../interfaces/data_mystery_encounters_mystery_encounter.EncounterStartOfBattleEffect.html"class="tsd-signature-type tsd-kind-interface">EncounterStartOfBattleEffect</a><spanclass="tsd-signature-symbol">[]</span><spanclass="tsd-signature-symbol"> = []</span></div><divclass="tsd-comment tsd-typography"><p>Will be set by option select handlers automatically, and can be used to refer to which option was chosen by later phases</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L241">src/data/mystery-encounters/mystery-encounter.ts:241</a></li></ul></aside></section><sectionclass="tsd-panel tsd-member"><aid="startOfBattleEffectsComplete"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>start<wbr/>Of<wbr/>Battle<wbr/>Effects<wbr/>Complete</span><ahref="#startOfBattleEffectsComplete"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">start<wbr/>Of<wbr/>Battle<wbr/>Effects<wbr/>Complete</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">boolean</span></div><divclass="tsd-comment tsd-typography"><p>Will be set automatically, indicates special moves in startOfBattleEffects are complete (so will not repeat)</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">any</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L508">src/data/mystery-encounters/mystery-encounter.ts:508</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="initIntroVisuals"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>init<wbr/>Intro<wbr/>Visuals</span><ahref="#initIntroVisuals"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="initIntroVisuals.initIntroVisuals-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">init<wbr/>Intro<wbr/>Visuals</span><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">void</span><ahref="#initIntroVisuals.initIntroVisuals-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>Initializes encounter intro sprites based on the sprite configs defined in spriteConfigs</p>
</div><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><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L408">src/data/mystery-encounters/mystery-encounter.ts:408</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="meetsRequirements"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>meets<wbr/>Requirements</span><ahref="#meetsRequirements"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="meetsRequirements.meetsRequirements-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">meets<wbr/>Requirements</span><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><ahref="#meetsRequirements.meetsRequirements-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>Checks if the current scene state meets the requirements for the <ahref="data_mystery_encounters_mystery_encounter.default.html"class="tsd-kind-class"><code>MysteryEncounter</code></a> to spawn
</div><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><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/3a5f3c39cda4a55df93517819a009bf328aacc17/src/data/mystery-encounters/mystery-encounter.ts#L296">src/data/mystery-encounters/mystery-encounter.ts:296</a></li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member"><aid="pokemonMeetsPrimaryRequirements"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>pokemon<wbr/>Meets<wbr/>Primary<wbr/>Requirements</span><ahref="#pokemonMeetsPrimaryRequirements"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="pokemonMeetsPrimaryRequirements.pokemonMeetsPrimaryRequirements-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">pokemon<wbr/>Meets<wbr/>Primary<wbr/>Requirements</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">scene</span>, <spanclass="tsd-kind-parameter">pokemon</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">boolean</span><ahref="#pokemonMeetsPrimaryRequirements.pokemonMeetsPrimaryRequirements-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>Checks if a specific player pokemon meets all given primary EncounterPokemonRequirements
Used automatically as part of <ahref="data_mystery_encounters_mystery_encounter.default.html#meetsRequirements"class="tsd-kind-method"><code>meetsRequirements</code></a>, but can also be used to manually check certain Pokemon where needed</p>
Increments if the same <ahref="data_mystery_encounters_mystery_encounter.default.html"class="tsd-kind-class"><code>MysteryEncounter</code></a> has multiple option select cycles</p>
