pokerogue/main/interfaces/data_mystery_encounters_mystery_encounter.IMysteryEncounter.html

35 lines
62 KiB
HTML
Raw Normal View History

2024-09-27 22:52:07 +01:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IMysteryEncounter | 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.IMysteryEncounter.html">IMysteryEncounter</a></li></ul><h1>Interface IMysteryEncounter</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Used by <a href="../classes/data_mystery_encounters_mystery_encounter.MysteryEncounterBuilder.html" class="tsd-kind-class"><code>MysteryEncounterBuilder</code></a> class to define required/optional properties on the <a href="../classes/data_mystery_encounters_mystery_encounter.default.html" class="tsd-kind-class"><code>MysteryEncounter</code></a> class when building.</p>
<p>Should ONLY contain properties that are necessary for <a href="../classes/data_mystery_encounters_mystery_encounter.default.html" class="tsd-kind-class"><code>MysteryEncounter</code></a> construction.
Post-construct and flag data properties are defined in the <a href="../classes/data_mystery_encounters_mystery_encounter.default.html" class="tsd-kind-class"><code>MysteryEncounter</code></a> class itself.</p>
2024-09-28 02:40:24 +01:00
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">IMysteryEncounter</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#autoHideIntroVisuals">autoHideIntroVisuals</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#catchAllowed">catchAllowed</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#continuousEncounter">continuousEncounter</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#dialogue">dialogue</a><span class="tsd-signature-symbol">: </span><a href="../classes/data_mystery_encounters_mystery_encounter_dialogue.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#dialogueTokens">dialogueTokens</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#disallowedChallenges">disallowedChallenges</a><span class="tsd-signature-symbol">?: </span><a href="../enums/enums_challenges.Challenges.html" class="tsd-signature-type tsd-kind-enum">Challenges</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#disallowedGameModes">disallowedGameModes</a><span class="tsd-signature-symbol">?: </span><a href="../enums/game_mode.GameModes.html" class="tsd-signature-type tsd-kind-enum">GameModes</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#doContinueEncounter">doContinueEncounter</a><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="../classes/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><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_mystery_encounters_mystery_encounter.IMysteryEncounter.html#doEncounterExp">doEncounterExp</a><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
2024-09-27 22:52:07 +01:00
<a href="data_mystery_encounters_mystery_encounter.IMysteryEncounter.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.IMysteryEncounter.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.IMysteryEncounter.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.IMysteryEncounter.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.IMysteryEncounter.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.IMysteryEncounter.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.IMysteryEncounter.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.IMysteryEncounter.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.IMysteryEncounter.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.IMysteryEncounter.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.IMysteryEncounter.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.IMysteryEncounter.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.IMysteryEncounter.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.IMysteryEncounter.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.IMysteryEncounter.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.IMysteryEncounter.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.IMysteryEncounter.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.IMysteryEncounter.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.IMysteryEncounter.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.IMysteryEncounter.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.IMysteryEncounter.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.IMysteryEncounter.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.IMysteryEncounter.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.IMysteryEncounter.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.IMysteryEncounter.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.IMysteryEncounter.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.IMysteryEncounter.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.IMysteryEncounter.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.IMysteryEncounter.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>
2024-09-28 02:40:24 +01:00
</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-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><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/1b6593d24274596f48c92a1f21c16c08f4203bb4/src/data/mystery-encounters/mystery-encounter.ts#L47">src/data/mystery-encounters/mystery-encounter.ts:47</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><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/1b6593d24274596f48c92a1f21c16c08f4203bb4/src/data/mystery-encounters/mystery-encounter.ts#L49">src/data/mystery-encounters/mystery-encounter.ts:49</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><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/1b6593d24274596f48c92a1f21c16c08f4203bb4/src/data/mystery-encounters/mystery-encounter.ts#L51">src/data/mystery-encounters/mystery-encounter.ts:51</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="../classes/data_mystery_encounters_mystery_encounter_dialogue.default.html" class="tsd-signature-type tsd-kind-class">default</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/1b6593d24274596f48c92a1f21c16c08f4203bb4/src/data/mystery-encounters/mystery-encounter.ts#L68">src/data/mystery-encounters/mystery-encounter.ts:68</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 cl