random-mirrors/pokerogue
1
0
Fork 0
mirror of https://github.com/pagefaultgames/pokerogue.git synced 2024-11-30 02:36:11 +00:00
Code Issues Packages Projects Releases Wiki Activity
b3c41e0bc1
pokerogue/main/classes/data_mystery_encounters_mystery_encounter.default.html
github-actions[bot] b3c41e0bc1 [skip ci] Deploy docs
2024-10-07 19:05:00 +00:00

134 lines
103 KiB
HTML
Raw Blame History

<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>default | pokemon-rogue-battle</title><meta name="description" content="Documentation for pokemon-rogue-battle"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">pokemon-rogue-battle</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">pokemon-rogue-battle</a></li><li><a href="../modules/data_mystery_encounters_mystery_encounter.html">data/mystery-encounters/mystery-encounter</a></li><li><a href="data_mystery_encounters_mystery_encounter.default.html">default</a></li></ul><h1>Class default</h1></div><section class="tsd-panel tsd-comment"><div class="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><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L80">src/data/mystery-encounters/mystery-encounter.ts:80</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="data_mystery_encounters_mystery_encounter.default.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="data_mystery_encounters_mystery_encounter.default.html#autoHideIntroVisuals" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Hide<wbr/>Intro<wbr/>Visuals</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#catchAllowed" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>catch<wbr/>Allowed</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#continuousEncounter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>continuous<wbr/>Encounter</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#dialogue" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dialogue</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#dialogueTokens" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dialogue<wbr/>Tokens</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#disallowedChallenges" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disallowed<wbr/>Challenges?</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#disallowedGameModes" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disallowed<wbr/>Game<wbr/>Modes?</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#doContinueEncounter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>do<wbr/>Continue<wbr/>Encounter?</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#doEncounterExp" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>do<wbr/>Encounter<wbr/>Exp?</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#doEncounterRewards" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>do<wbr/>Encounter<wbr/>Rewards?</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#encounterAnimations" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>encounter<wbr/>Animations?</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#encounterMode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>encounter<wbr/>Mode</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#encounterTier" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>encounter<wbr/>Tier</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#encounterType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>encounter<wbr/>Type</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#enemyPartyConfigs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enemy<wbr/>Party<wbr/>Configs</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#enterIntroVisualsFromRight" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enter<wbr/>Intro<wbr/>Visuals<wbr/>From<wbr/>Right</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#excludePrimaryFromSupportRequirements" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>exclude<wbr/>Primary<wbr/>From<wbr/>Support<wbr/>Requirements</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#expMultiplier" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>exp<wbr/>Multiplier</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#fleeAllowed" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>flee<wbr/>Allowed</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#hasBattleAnimationsWithoutTargets" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has<wbr/>Battle<wbr/>Animations<wbr/>Without<wbr/>Targets</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#hideBattleIntroMessage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hide<wbr/>Battle<wbr/>Intro<wbr/>Message</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#introVisuals" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>intro<wbr/>Visuals?</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#loadAssets" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>load<wbr/>Assets</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#lockEncounterRewardTiers" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>lock<wbr/>Encounter<wbr/>Reward<wbr/>Tiers</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#maxAllowedEncounters" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Allowed<wbr/>Encounters</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#misc" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>misc?</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#onGameOver" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Game<wbr/>Over?</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#onInit" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Init?</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#onRewards" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Rewards?</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#onTurnStart" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Turn<wbr/>Start?</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#onVisualsStart" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Visuals<wbr/>Start?</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#options" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#primaryPokemon" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>primary<wbr/>Pokemon?</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#primaryPokemonRequirements" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>primary<wbr/>Pokemon<wbr/>Requirements</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#requirements" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>requirements</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#secondaryPokemon" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>secondary<wbr/>Pokemon?</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#secondaryPokemonRequirements" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>secondary<wbr/>Pokemon<wbr/>Requirements</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#selectedOption" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>selected<wbr/>Option?</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#skipEnemyBattleTurns" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>skip<wbr/>Enemy<wbr/>Battle<wbr/>Turns</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#skipToFightInput" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>skip<wbr/>To<wbr/>Fight<wbr/>Input</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#spriteConfigs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sprite<wbr/>Configs</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#startOfBattleEffects" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>start<wbr/>Of<wbr/>Battle<wbr/>Effects</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#startOfBattleEffectsComplete" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>start<wbr/>Of<wbr/>Battle<wbr/>Effects<wbr/>Complete</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="data_mystery_encounters_mystery_encounter.default.html#getSeedOffset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Seed<wbr/>Offset</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#initIntroVisuals" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>init<wbr/>Intro<wbr/>Visuals</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#meetsRequirements" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>meets<wbr/>Requirements</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#pokemonMeetsPrimaryRequirements" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pokemon<wbr/>Meets<wbr/>Primary<wbr/>Requirements</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#populateDialogueTokensFromRequirements" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>populate<wbr/>Dialogue<wbr/>Tokens<wbr/>From<wbr/>Requirements</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#setDialogueToken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Dialogue<wbr/>Token</span></a>
<a href="data_mystery_encounters_mystery_encounter.default.html#updateSeedOffset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Seed<wbr/>Offset</span></a>
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_default" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new default</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">encounter</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter.default.html" class="tsd-signature-type tsd-kind-class">default</a><a href="#constructor.new_default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">encounter</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounter</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter.default.html" class="tsd-signature-type tsd-kind-class">default</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L262">src/data/mystery-encounters/mystery-encounter.ts:262</a></li></ul></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="autoHideIntroVisuals" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>auto<wbr/>Hide<wbr/>Intro<wbr/>Visuals</span><a href="#autoHideIntroVisuals" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">auto<wbr/>Hide<wbr/>Intro<wbr/>Visuals</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>If true, when an option is selected the field visuals will fade out automatically
Default false</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#autoHideIntroVisuals">autoHideIntroVisuals</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L112">src/data/mystery-encounters/mystery-encounter.ts:112</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="catchAllowed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>catch<wbr/>Allowed</span><a href="#catchAllowed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">catch<wbr/>Allowed</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>If true, allows catching a wild pokemon during the encounter
Default false</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#catchAllowed">catchAllowed</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L122">src/data/mystery-encounters/mystery-encounter.ts:122</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="continuousEncounter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>continuous<wbr/>Encounter</span><a href="#continuousEncounter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">continuous<wbr/>Encounter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>If true, encounter will continuously run through multiple battles/puzzles/etc. instead of going to next wave
MUST EVENTUALLY BE DISABLED TO CONTINUE TO NEXT WAVE
Default false</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#continuousEncounter">continuousEncounter</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L133">src/data/mystery-encounters/mystery-encounter.ts:133</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="dialogue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>dialogue</span><a href="#dialogue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">dialogue</span><span class="tsd-signature-symbol">:</span> <a href="data_mystery_encounters_mystery_encounter_dialogue.default.html" class="tsd-signature-type tsd-kind-class">default</a></div><div class="tsd-comment tsd-typography"><p>Dialogue object containing all the dialogue, messages, tooltips, etc. for an encounter</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#dialogue">dialogue</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L197">src/data/mystery-encounters/mystery-encounter.ts:197</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="dialogueTokens" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>dialogue<wbr/>Tokens</span><a href="#dialogueTokens" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">dialogue<wbr/>Tokens</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div><div class="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.)
Example use: see MYSTERIOUS_CHEST</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#dialogueTokens">dialogueTokens</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L217">src/data/mystery-encounters/mystery-encounter.ts:217</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="disallowedChallenges" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>disallowed<wbr/>Challenges</span><a href="#disallowedChallenges" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">disallowed<wbr/>Challenges</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/enums_challenges.Challenges.html" class="tsd-signature-type tsd-kind-enum">Challenges</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>If specified, defines any challenges (from Challenge game mode) where the <a href="data_mystery_encounters_mystery_encounter.default.html" class="tsd-kind-class"><code>MysteryEncounter</code></a> should <em>NOT</em> spawn</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#disallowedChallenges">disallowedChallenges</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L102">src/data/mystery-encounters/mystery-encounter.ts:102</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="disallowedGameModes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>disallowed<wbr/>Game<wbr/>Modes</span><a href="#disallowedGameModes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">disallowed<wbr/>Game<wbr/>Modes</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/game_mode.GameModes.html" class="tsd-signature-type tsd-kind-enum">GameModes</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>If specified, defines any game modes where the <a href="data_mystery_encounters_mystery_encounter.default.html" class="tsd-kind-class"><code>MysteryEncounter</code></a> should <em>NOT</em> spawn</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#disallowedGameModes">disallowedGameModes</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L98">src/data/mystery-encounters/mystery-encounter.ts:98</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="doContinueEncounter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>do<wbr/>Continue<wbr/>Encounter</span><a href="#doContinueEncounter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">do<wbr/>Continue<wbr/>Encounter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span><span class="tsd-signature-symbol">: </span><a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Will execute callback during VictoryPhase of a continuousEncounter</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#doContinueEncounter">doContinueEncounter</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L169">src/data/mystery-encounters/mystery-encounter.ts:169</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="doEncounterExp" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>do<wbr/>Encounter<wbr/>Exp</span><a href="#doEncounterExp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">do<wbr/>Encounter<wbr/>Exp</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span><span class="tsd-signature-symbol">: </span><a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Will provide the player party EXP before rewards are displayed for that wave</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#doEncounterExp">doEncounterExp</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L165">src/data/mystery-encounters/mystery-encounter.ts:165</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="doEncounterRewards" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>do<wbr/>Encounter<wbr/>Rewards</span><a href="#doEncounterRewards" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">do<wbr/>Encounter<wbr/>Rewards</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span><span class="tsd-signature-symbol">: </span><a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Will provide the player a rewards shop for that wave</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#doEncounterRewards">doEncounterRewards</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L167">src/data/mystery-encounters/mystery-encounter.ts:167</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="encounterAnimations" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>encounter<wbr/>Animations</span><a href="#encounterAnimations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">encounter<wbr/>Animations</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/enums_encounter_anims.EncounterAnim.html" class="tsd-signature-type tsd-kind-enum">EncounterAnim</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Custom battle animations that are configured for encounter effects and visuals
Specify here so that assets are loaded on initialization of encounter</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#encounterAnimations">encounterAnimations</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L94">src/data/mystery-encounters/mystery-encounter.ts:94</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="encounterMode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>encounter<wbr/>Mode</span><a href="#encounterMode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">encounter<wbr/>Mode</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_mystery_encounter_mode.MysteryEncounterMode.html" class="tsd-signature-type tsd-kind-enum">MysteryEncounterMode</a></div><div class="tsd-comment tsd-typography"><p>Should be set depending upon option selected as part of an encounter
For example, if there is no battle as part of the encounter/selected option, should be set to NO_BATTLE
Defaults to DEFAULT</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L223">src/data/mystery-encounters/mystery-encounter.ts:223</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="encounterTier" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>encounter<wbr/>Tier</span><a href="#encounterTier" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">encounter<wbr/>Tier</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_mystery_encounter_tier.MysteryEncounterTier.html" class="tsd-signature-type tsd-kind-enum">MysteryEncounterTier</a></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#encounterTier">encounterTier</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L89">src/data/mystery-encounters/mystery-encounter.ts:89</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="encounterType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>encounter<wbr/>Type</span><a href="#encounterType" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">encounter<wbr/>Type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_mystery_encounter_type.MysteryEncounterType.html" class="tsd-signature-type tsd-kind-enum">MysteryEncounterType</a></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#encounterType">encounterType</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L83">src/data/mystery-encounters/mystery-encounter.ts:83</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="enemyPartyConfigs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>enemy<wbr/>Party<wbr/>Configs</span><a href="#enemyPartyConfigs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">enemy<wbr/>Party<wbr/>Configs</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/data_mystery_encounters_utils_encounter_phase_utils.EnemyPartyConfig.html" class="tsd-signature-type tsd-kind-interface">EnemyPartyConfig</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Data used for setting up/initializing enemy party in battles
Can store multiple configs so that one can be chosen based on option selected
Should usually be defined in <code>onInit()</code> or <code>onPreOptionPhase()</code></p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#enemyPartyConfigs">enemyPartyConfigs</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L203">src/data/mystery-encounters/mystery-encounter.ts:203</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="enterIntroVisualsFromRight" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>enter<wbr/>Intro<wbr/>Visuals<wbr/>From<wbr/>Right</span><a href="#enterIntroVisualsFromRight" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">enter<wbr/>Intro<wbr/>Visuals<wbr/>From<wbr/>Right</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Intro visuals on the field will slide in from the right instead of the left
Default false</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#enterIntroVisualsFromRight">enterIntroVisualsFromRight</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L117">src/data/mystery-encounters/mystery-encounter.ts:117</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="excludePrimaryFromSupportRequirements" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>exclude<wbr/>Primary<wbr/>From<wbr/>Support<wbr/>Requirements</span><a href="#excludePrimaryFromSupportRequirements" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">exclude<wbr/>Primary<wbr/>From<wbr/>Support<wbr/>Requirements</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#excludePrimaryFromSupportRequirements">excludePrimaryFromSupportRequirements</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L188">src/data/mystery-encounters/mystery-encounter.ts:188</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="expMultiplier" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>exp<wbr/>Multiplier</span><a href="#expMultiplier" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">exp<wbr/>Multiplier</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Can be set higher or lower based on the type of battle or exp gained for an option/encounter
Defaults to 1</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#expMultiplier">expMultiplier</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L246">src/data/mystery-encounters/mystery-encounter.ts:246</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fleeAllowed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>flee<wbr/>Allowed</span><a href="#fleeAllowed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">flee<wbr/>Allowed</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>If true, allows fleeing from a wild encounter (trainer battle MEs auto-disable fleeing)
Default true</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#fleeAllowed">fleeAllowed</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L127">src/data/mystery-encounters/mystery-encounter.ts:127</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="hasBattleAnimationsWithoutTargets" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has<wbr/>Battle<wbr/>Animations<wbr/>Without<wbr/>Targets</span><a href="#hasBattleAnimationsWithoutTargets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">has<wbr/>Battle<wbr/>Animations<wbr/>Without<wbr/>Targets</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>If true, encounter will not animate the target Pokemon as part of battle animations
Used for encounters where it is not a &quot;real&quot; battle, but still uses battle animations and commands (see FunAndGamesEncounter for an example)</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#hasBattleAnimationsWithoutTargets">hasBattleAnimationsWithoutTargets</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L143">src/data/mystery-encounters/mystery-encounter.ts:143</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="hideBattleIntroMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>hide<wbr/>Battle<wbr/>Intro<wbr/>Message</span><a href="#hideBattleIntroMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hide<wbr/>Battle<wbr/>Intro<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>If true, hides &quot;A Wild X Appeared&quot; etc. messages
Default true</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#hideBattleIntroMessage">hideBattleIntroMessage</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L107">src/data/mystery-encounters/mystery-encounter.ts:107</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="introVisuals" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>intro<wbr/>Visuals</span><a href="#introVisuals" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">intro<wbr/>Visuals</span><span class="tsd-signature-symbol">?:</span> <a href="field_mystery_encounter_intro.default.html" class="tsd-signature-type tsd-kind-class">default</a></div><div class="tsd-comment tsd-typography"><p>Object instance containing sprite data for an encounter when it is being spawned
Otherwise, will be undefined
You probably shouldn't do anything directly with this unless you have a very specific need</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L209">src/data/mystery-encounters/mystery-encounter.ts:209</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="loadAssets" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>load<wbr/>Assets</span><a href="#loadAssets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">load<wbr/>Assets</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></div><div class="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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L250">src/data/mystery-encounters/mystery-encounter.ts:250</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="lockEncounterRewardTiers" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>lock<wbr/>Encounter<wbr/>Reward<wbr/>Tiers</span><a href="#lockEncounterRewardTiers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">lock<wbr/>Encounter<wbr/>Reward<wbr/>Tiers</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Flag for checking if it's the first time a shop is being shown for an encounter.
Defaults to true so that the first shop does not override the specified rewards.
Will be set to false after a shop is shown (so can't reroll same rarity items for free)</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L229">src/data/mystery-encounters/mystery-encounter.ts:229</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="maxAllowedEncounters" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>max<wbr/>Allowed<wbr/>Encounters</span><a href="#maxAllowedEncounters" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">max<wbr/>Allowed<wbr/>Encounters</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Maximum number of times the encounter can be seen per run
Rogue tier encounters default to 1, others default to 3</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#maxAllowedEncounters">maxAllowedEncounters</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L138">src/data/mystery-encounters/mystery-encounter.ts:138</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="misc" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>misc</span><a href="#misc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">misc</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>Generic property to set any custom data required for the encounter
Extremely useful for carrying state/data between onPreOptionPhase/onOptionPhase/onPostOptionPhase</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L255">src/data/mystery-encounters/mystery-encounter.ts:255</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="onGameOver" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>on<wbr/>Game<wbr/>Over</span><a href="#onGameOver" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">on<wbr/>Game<wbr/>Over</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span><span class="tsd-signature-symbol">: </span><a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Can perform special logic when a ME battle is lost, before GameOver/battle retry prompt.
Should return <code>true</code> if it is treated as &quot;real&quot; Game Over, <code>false</code> if not.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L174">src/data/mystery-encounters/mystery-encounter.ts:174</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="onInit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>on<wbr/>Init</span><a href="#onInit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">on<wbr/>Init</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span><span class="tsd-signature-symbol">: </span><a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Event when Encounter is first loaded, use it for data conditioning</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#onInit">onInit</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L157">src/data/mystery-encounters/mystery-encounter.ts:157</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="onRewards" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>on<wbr/>Rewards</span><a href="#onRewards" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">on<wbr/>Rewards</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span><span class="tsd-signature-symbol">: </span><a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Event prior to any rewards logic in MysteryEncounterRewardsPhase</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L163">src/data/mystery-encounters/mystery-encounter.ts:163</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="onTurnStart" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>on<wbr/>Turn<wbr/>Start</span><a href="#onTurnStart" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">on<wbr/>Turn<wbr/>Start</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span><span class="tsd-signature-symbol">: </span><a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Event triggered prior to CommandPhase, during TurnInitPhase</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L161">src/data/mystery-encounters/mystery-encounter.ts:161</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="onVisualsStart" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>on<wbr/>Visuals<wbr/>Start</span><a href="#onVisualsStart" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">on<wbr/>Visuals<wbr/>Start</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span><span class="tsd-signature-symbol">: </span><a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Event when battlefield visuals have finished sliding in and the encounter dialogue begins</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#onVisualsStart">onVisualsStart</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L159">src/data/mystery-encounters/mystery-encounter.ts:159</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="options" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>options</span><a href="#options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><a href="data_mystery_encounters_mystery_encounter_option.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">, </span><a href="data_mystery_encounters_mystery_encounter_option.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">...</span><a href="data_mystery_encounters_mystery_encounter_option.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">]</span></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#options">options</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L84">src/data/mystery-encounters/mystery-encounter.ts:84</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="primaryPokemon" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>primary<wbr/>Pokemon</span><a href="#primaryPokemon" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">primary<wbr/>Pokemon</span><span class="tsd-signature-symbol">?:</span> <a href="field_pokemon.PlayerPokemon.html" class="tsd-signature-type tsd-kind-class">PlayerPokemon</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L189">src/data/mystery-encounters/mystery-encounter.ts:189</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="primaryPokemonRequirements" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>primary<wbr/>Pokemon<wbr/>Requirements</span><a href="#primaryPokemonRequirements" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">primary<wbr/>Pokemon<wbr/>Requirements</span><span class="tsd-signature-symbol">:</span> <a href="data_mystery_encounters_mystery_encounter_requirements.EncounterPokemonRequirement.html" class="tsd-signature-type tsd-kind-class">EncounterPokemonRequirement</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Primary Pokemon is a single pokemon randomly selected from the party that meet ALL primary pokemon requirements</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#primaryPokemonRequirements">primaryPokemonRequirements</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L181">src/data/mystery-encounters/mystery-encounter.ts:181</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="requirements" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>requirements</span><a href="#requirements" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">requirements</span><span class="tsd-signature-symbol">:</span> <a href="data_mystery_encounters_mystery_encounter_requirements.EncounterSceneRequirement.html" class="tsd-signature-type tsd-kind-class">EncounterSceneRequirement</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Requirements</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#requirements">requirements</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L179">src/data/mystery-encounters/mystery-encounter.ts:179</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="secondaryPokemon" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>secondary<wbr/>Pokemon</span><a href="#secondaryPokemon" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">secondary<wbr/>Pokemon</span><span class="tsd-signature-symbol">?:</span> <a href="field_pokemon.PlayerPokemon.html" class="tsd-signature-type tsd-kind-class">PlayerPokemon</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L190">src/data/mystery-encounters/mystery-encounter.ts:190</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="secondaryPokemonRequirements" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>secondary<wbr/>Pokemon<wbr/>Requirements</span><a href="#secondaryPokemonRequirements" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">secondary<wbr/>Pokemon<wbr/>Requirements</span><span class="tsd-signature-symbol">:</span> <a href="data_mystery_encounters_mystery_encounter_requirements.EncounterPokemonRequirement.html" class="tsd-signature-type tsd-kind-class">EncounterPokemonRequirement</a><span class="tsd-signature-symbol">[]</span></div><div class="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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#secondaryPokemonRequirements">secondaryPokemonRequirements</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L187">src/data/mystery-encounters/mystery-encounter.ts:187</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="selectedOption" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>selected<wbr/>Option</span><a href="#selectedOption" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">selected<wbr/>Option</span><span class="tsd-signature-symbol">?:</span> <a href="data_mystery_encounters_mystery_encounter_option.default.html" class="tsd-signature-type tsd-kind-class">default</a></div><div class="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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L237">src/data/mystery-encounters/mystery-encounter.ts:237</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="skipEnemyBattleTurns" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>skip<wbr/>Enemy<wbr/>Battle<wbr/>Turns</span><a href="#skipEnemyBattleTurns" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">skip<wbr/>Enemy<wbr/>Battle<wbr/>Turns</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="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 &quot;real&quot; battle, but still uses battle animations and commands (see FunAndGamesEncounter for an example)</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#skipEnemyBattleTurns">skipEnemyBattleTurns</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L148">src/data/mystery-encounters/mystery-encounter.ts:148</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="skipToFightInput" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>skip<wbr/>To<wbr/>Fight<wbr/>Input</span><a href="#skipToFightInput" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">skip<wbr/>To<wbr/>Fight<wbr/>Input</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>If true, will skip COMMAND input and go straight to FIGHT (move select) input menu</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#skipToFightInput">skipToFightInput</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L152">src/data/mystery-encounters/mystery-encounter.ts:152</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="spriteConfigs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>sprite<wbr/>Configs</span><a href="#spriteConfigs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">sprite<wbr/>Configs</span><span class="tsd-signature-symbol">:</span> <a href="field_mystery_encounter_intro.MysteryEncounterSpriteConfig.html" class="tsd-signature-type tsd-kind-class">MysteryEncounterSpriteConfig</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html">IMysteryEncounter</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#spriteConfigs">spriteConfigs</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L85">src/data/mystery-encounters/mystery-encounter.ts:85</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="startOfBattleEffects" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>start<wbr/>Of<wbr/>Battle<wbr/>Effects</span><a href="#startOfBattleEffects" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">start<wbr/>Of<wbr/>Battle<wbr/>Effects</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/data_mystery_encounters_mystery_encounter.EncounterStartOfBattleEffect.html" class="tsd-signature-type tsd-kind-interface">EncounterStartOfBattleEffect</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L241">src/data/mystery-encounters/mystery-encounter.ts:241</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="startOfBattleEffectsComplete" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>start<wbr/>Of<wbr/>Battle<wbr/>Effects<wbr/>Complete</span><a href="#startOfBattleEffectsComplete" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">start<wbr/>Of<wbr/>Battle<wbr/>Effects<wbr/>Complete</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Will be set automatically, indicates special moves in startOfBattleEffects are complete (so will not repeat)</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L233">src/data/mystery-encounters/mystery-encounter.ts:233</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="getSeedOffset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Seed<wbr/>Offset</span><a href="#getSeedOffset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getSeedOffset.getSeedOffset-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Seed<wbr/>Offset</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#getSeedOffset.getSeedOffset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>If an encounter uses MysteryEncounterMode.continuousEncounter,
should rely on this value for seed offset instead of wave index.</p>
<p>This offset is incremented for each new MysteryEncounterPhase that occurs,
so multi-encounter RNG will be consistent on resets and not be affected by number of turns, move RNG, etc.</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L508">src/data/mystery-encounters/mystery-encounter.ts:508</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="initIntroVisuals" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>init<wbr/>Intro<wbr/>Visuals</span><a href="#initIntroVisuals" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="initIntroVisuals.initIntroVisuals-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">init<wbr/>Intro<wbr/>Visuals</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#initIntroVisuals.initIntroVisuals-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes encounter intro sprites based on the sprite configs defined in spriteConfigs</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">scene</span>: <a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L408">src/data/mystery-encounters/mystery-encounter.ts:408</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="meetsRequirements" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>meets<wbr/>Requirements</span><a href="#meetsRequirements" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="meetsRequirements.meetsRequirements-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">meets<wbr/>Requirements</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#meetsRequirements.meetsRequirements-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Checks if the current scene state meets the requirements for the <a href="data_mystery_encounters_mystery_encounter.default.html" class="tsd-kind-class"><code>MysteryEncounter</code></a> to spawn
This is used to filter the pool of encounters down to only the ones with all requirements met</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">scene</span>: <a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L296">src/data/mystery-encounters/mystery-encounter.ts:296</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="pokemonMeetsPrimaryRequirements" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>pokemon<wbr/>Meets<wbr/>Primary<wbr/>Requirements</span><a href="#pokemonMeetsPrimaryRequirements" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="pokemonMeetsPrimaryRequirements.pokemonMeetsPrimaryRequirements-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">pokemon<wbr/>Meets<wbr/>Primary<wbr/>Requirements</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span>, <span class="tsd-kind-parameter">pokemon</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#pokemonMeetsPrimaryRequirements.pokemonMeetsPrimaryRequirements-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Checks if a specific player pokemon meets all given primary EncounterPokemonRequirements
Used automatically as part of <a href="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>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">scene</span>: <a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">pokemon</span>: <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L310">src/data/mystery-encounters/mystery-encounter.ts:310</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="populateDialogueTokensFromRequirements" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>populate<wbr/>Dialogue<wbr/>Tokens<wbr/>From<wbr/>Requirements</span><a href="#populateDialogueTokensFromRequirements" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="populateDialogueTokensFromRequirements.populateDialogueTokensFromRequirements-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">populate<wbr/>Dialogue<wbr/>Tokens<wbr/>From<wbr/>Requirements</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#populateDialogueTokensFromRequirements.populateDialogueTokensFromRequirements-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Auto-pushes dialogue tokens from the encounter (and option) requirements.
Will use the first support pokemon in list
For multiple support pokemon in the dialogue token, it will have to be overridden.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">scene</span>: <a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L417">src/data/mystery-encounters/mystery-encounter.ts:417</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setDialogueToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Dialogue<wbr/>Token</span><a href="#setDialogueToken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setDialogueToken.setDialogueToken-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Dialogue<wbr/>Token</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span>, <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setDialogueToken.setDialogueToken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Used to cache a dialogue token for the encounter.
Tokens will be auto-injected via the <code>{{key}}</code> pattern with <code>value</code>,
when using the showEncounterText and showEncounterDialogue helper functions.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L497">src/data/mystery-encounters/mystery-encounter.ts:497</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="updateSeedOffset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update<wbr/>Seed<wbr/>Offset</span><a href="#updateSeedOffset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="updateSeedOffset.updateSeedOffset-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Seed<wbr/>Offset</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#updateSeedOffset.updateSeedOffset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Maintains seed offset for RNG consistency
Increments if the same <a href="data_mystery_encounters_mystery_encounter.default.html" class="tsd-kind-class"><code>MysteryEncounter</code></a> has multiple option select cycles</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">scene</span>: <a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/8980513a83b257b4a6d0723dcc30d13cfc9b4c04/src/data/mystery-encounters/mystery-encounter.ts#L517">src/data/mystery-encounters/mystery-encounter.ts:517</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#autoHideIntroVisuals" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Hide<wbr/>Intro<wbr/>Visuals</span></a><a href="#catchAllowed" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>catch<wbr/>Allowed</span></a><a href="#continuousEncounter" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>continuous<wbr/>Encounter</span></a><a href="#dialogue" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dialogue</span></a><a href="#dialogueTokens" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dialogue<wbr/>Tokens</span></a><a href="#disallowedChallenges" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disallowed<wbr/>Challenges</span></a><a href="#disallowedGameModes" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disallowed<wbr/>Game<wbr/>Modes</span></a><a href="#doContinueEncounter" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>do<wbr/>Continue<wbr/>Encounter</span></a><a href="#doEncounterExp" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>do<wbr/>Encounter<wbr/>Exp</span></a><a href="#doEncounterRewards" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>do<wbr/>Encounter<wbr/>Rewards</span></a><a href="#encounterAnimations" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>encounter<wbr/>Animations</span></a><a href="#encounterMode" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>encounter<wbr/>Mode</span></a><a href="#encounterTier" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>encounter<wbr/>Tier</span></a><a href="#encounterType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>encounter<wbr/>Type</span></a><a href="#enemyPartyConfigs" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enemy<wbr/>Party<wbr/>Configs</span></a><a href="#enterIntroVisualsFromRight" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enter<wbr/>Intro<wbr/>Visuals<wbr/>From<wbr/>Right</span></a><a href="#excludePrimaryFromSupportRequirements" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>exclude<wbr/>Primary<wbr/>From<wbr/>Support<wbr/>Requirements</span></a><a href="#expMultiplier" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>exp<wbr/>Multiplier</span></a><a href="#fleeAllowed" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>flee<wbr/>Allowed</span></a><a href="#hasBattleAnimationsWithoutTargets" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has<wbr/>Battle<wbr/>Animations<wbr/>Without<wbr/>Targets</span></a><a href="#hideBattleIntroMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hide<wbr/>Battle<wbr/>Intro<wbr/>Message</span></a><a href="#introVisuals" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>intro<wbr/>Visuals</span></a><a href="#loadAssets" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>load<wbr/>Assets</span></a><a href="#lockEncounterRewardTiers" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>lock<wbr/>Encounter<wbr/>Reward<wbr/>Tiers</span></a><a href="#maxAllowedEncounters" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Allowed<wbr/>Encounters</span></a><a href="#misc" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>misc</span></a><a href="#onGameOver" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Game<wbr/>Over</span></a><a href="#onInit" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Init</span></a><a href="#onRewards" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Rewards</span></a><a href="#onTurnStart" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Turn<wbr/>Start</span></a><a href="#onVisualsStart" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Visuals<wbr/>Start</span></a><a href="#options" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a><a href="#primaryPokemon" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>primary<wbr/>Pokemon</span></a><a href="#primaryPokemonRequirements" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>primary<wbr/>Pokemon<wbr/>Requirements</span></a><a href="#requirements" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>requirements</span></a><a href="#secondaryPokemon" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>secondary<wbr/>Pokemon</span></a><a href="#secondaryPokemonRequirements" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>secondary<wbr/>Pokemon<wbr/>Requirements</span></a><a href="#selectedOption" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>selected<wbr/>Option</span></a><a href="#skipEnemyBattleTurns" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>skip<wbr/>Enemy<wbr/>Battle<wbr/>Turns</span></a><a href="#skipToFightInput" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>skip<wbr/>To<wbr/>Fight<wbr/>Input</span></a><a href="#spriteConfigs" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sprite<wbr/>Configs</span></a><a href="#startOfBattleEffects" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>start<wbr/>Of<wbr/>Battle<wbr/>Effects</span></a><a href="#startOfBattleEffectsComplete" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>start<wbr/>Of<wbr/>Battle<wbr/>Effects<wbr/>Complete</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#getSeedOffset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Seed<wbr/>Offset</span></a><a href="#initIntroVisuals" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>init<wbr/>Intro<wbr/>Visuals</span></a><a href="#meetsRequirements" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>meets<wbr/>Requirements</span></a><a href="#pokemonMeetsPrimaryRequirements" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pokemon<wbr/>Meets<wbr/>Primary<wbr/>Requirements</span></a><a href="#populateDialogueTokensFromRequirements" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>populate<wbr/>Dialogue<wbr/>Tokens<wbr/>From<wbr/>Requirements</span></a><a href="#setDialogueToken" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Dialogue<wbr/>Token</span></a><a href="#updateSeedOffset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Seed<wbr/>Offset</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>pokemon-rogue-battle</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
Reference in New Issue View Git Blame Copy Permalink