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

39 lines
42 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html><html class="default" lang="en" data-base="../"><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">pokemon-rogue-battle</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/data_mystery-encounters_mystery-encounter-option.html">data/mystery-encounters/mystery-encounter-option</a></li><li><a href="" aria-current="page">default</a></li></ul><h1>Class default</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Used by <a href="data_mystery-encounters_mystery-encounter-option.MysteryEncounterOptionBuilder.html" class="tsd-kind-class"><code>MysteryEncounterOptionBuilder</code></a> class to define required/optional properties on the MysteryEncounterOption class when building.</p>
<p>Should ONLY contain properties that are necessary for MysteryEncounterOption construction.
Post-construct and flag data properties are defined in the MysteryEncounterOption class itself.</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-option.IMysteryEncounterOption.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounterOption</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter-option.ts#L42">src/data/mystery-encounters/mystery-encounter-option.ts:42</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#dialogue" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dialogue?</span></a>
<a href="#excludeprimaryfromsecondaryrequirements" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>exclude<wbr/>Primary<wbr/>From<wbr/>Secondary<wbr/>Requirements</span></a>
<a href="#hasdexprogress" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has<wbr/>Dex<wbr/>Progress</span></a>
<a href="#onoptionphase" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Option<wbr/>Phase</span></a>
<a href="#onpostoptionphase" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Post<wbr/>Option<wbr/>Phase?</span></a>
<a href="#onpreoptionphase" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Pre<wbr/>Option<wbr/>Phase?</span></a>
<a href="#optionmode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>option<wbr/>Mode</span></a>
<a href="#primarypokemon" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>primary<wbr/>Pokemon?</span></a>
<a href="#primarypokemonrequirements" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>primary<wbr/>Pokemon<wbr/>Requirements</span></a>
<a href="#requirements" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>requirements</span></a>
<a href="#secondarypokemon" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>secondary<wbr/>Pokemon?</span></a>
<a href="#secondarypokemonrequirements" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>secondary<wbr/>Pokemon<wbr/>Requirements</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#hasrequirements" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>has<wbr/>Requirements</span></a>
<a href="#meetsprimaryrequirementandprimarypokemonselected" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>meets<wbr/>Primary<wbr/>Requirement<wbr/>And<wbr/>Primary<wbr/>Pokemon<wbr/>Selected</span></a>
<a href="#meetsrequirements" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>meets<wbr/>Requirements</span></a>
<a href="#meetssupportingrequirementandsupportingpokemonselected" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>meets<wbr/>Supporting<wbr/>Requirement<wbr/>And<wbr/>Supporting<wbr/>Pokemon<wbr/>Selected</span></a>
<a href="#pokemonmeetsprimaryrequirements" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pokemon<wbr/>Meets<wbr/>Primary<wbr/>Requirements</span></a>
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructordefault"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">default</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">option</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/data_mystery-encounters_mystery-encounter-option.IMysteryEncounterOption.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounterOption</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">default</a><a href="#constructordefault" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">option</span>: <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/data_mystery-encounters_mystery-encounter-option.IMysteryEncounterOption.html" class="tsd-signature-type tsd-kind-interface">IMysteryEncounterOption</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" 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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter-option.ts#L65">src/data/mystery-encounters/mystery-encounter-option.ts:65</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="dialogue"><code class="tsd-tag">Optional</code><span>dialogue</span><a href="#dialogue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">dialogue</span><span class="tsd-signature-symbol">?:</span> <a href="data_mystery-encounters_mystery-encounter-dialogue.OptionTextDisplay.html" class="tsd-signature-type tsd-kind-class">OptionTextDisplay</a></div><div class="tsd-comment tsd-typography"><p>Dialogue object containing all the dialogue, messages, tooltips, etc. for this option
Will be populated on MysteryEncounter initialization</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery-encounters_mystery-encounter-option.IMysteryEncounterOption.html">IMysteryEncounterOption</a>.<a href="../interfaces/data_mystery-encounters_mystery-encounter-option.IMysteryEncounterOption.html#dialogue">dialogue</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter-option.ts#L56">src/data/mystery-encounters/mystery-encounter-option.ts:56</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="excludeprimaryfromsecondaryrequirements"><span>exclude<wbr/>Primary<wbr/>From<wbr/>Secondary<wbr/>Requirements</span><a href="#excludeprimaryfromsecondaryrequirements" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">excludePrimaryFromSecondaryRequirements</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-option.IMysteryEncounterOption.html">IMysteryEncounterOption</a>.<a href="../interfaces/data_mystery-encounters_mystery-encounter-option.IMysteryEncounterOption.html#excludeprimaryfromsecondaryrequirements">excludePrimaryFromSecondaryRequirements</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter-option.ts#L50">src/data/mystery-encounters/mystery-encounter-option.ts:50</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hasdexprogress"><span>has<wbr/>Dex<wbr/>Progress</span><a href="#hasdexprogress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hasDexProgress</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-option.IMysteryEncounterOption.html">IMysteryEncounterOption</a>.<a href="../interfaces/data_mystery-encounters_mystery-encounter-option.IMysteryEncounterOption.html#hasdexprogress">hasDexProgress</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter-option.ts#L44">src/data/mystery-encounters/mystery-encounter-option.ts:44</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="onoptionphase"><span>on<wbr/>Option<wbr/>Phase</span><a href="#onoptionphase" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">onOptionPhase</span><span class="tsd-signature-symbol">:</span> <a href="../types/data_mystery-encounters_mystery-encounter-option.OptionPhaseCallback.html" class="tsd-signature-type tsd-kind-type-alias">OptionPhaseCallback</a></div><div class="tsd-comment tsd-typography"><p>Business logic function for option</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery-encounters_mystery-encounter-option.IMysteryEncounterOption.html">IMysteryEncounterOption</a>.<a href="../interfaces/data_mystery-encounters_mystery-encounter-option.IMysteryEncounterOption.html#onoptionphase">onOptionPhase</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter-option.ts#L61">src/data/mystery-encounters/mystery-encounter-option.ts:61</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="onpostoptionphase"><code class="tsd-tag">Optional</code><span>on<wbr/>Post<wbr/>Option<wbr/>Phase</span><a href="#onpostoptionphase" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">onPostOptionPhase</span><span class="tsd-signature-symbol">?:</span> <a href="../types/data_mystery-encounters_mystery-encounter-option.OptionPhaseCallback.html" class="tsd-signature-type tsd-kind-type-alias">OptionPhaseCallback</a></div><div class="tsd-comment tsd-typography"><p>Executes after the encounter is over. Usually this will be for calculating dialogueTokens or performing data updates</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery-encounters_mystery-encounter-option.IMysteryEncounterOption.html">IMysteryEncounterOption</a>.<a href="../interfaces/data_mystery-encounters_mystery-encounter-option.IMysteryEncounterOption.html#onpostoptionphase">onPostOptionPhase</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter-option.ts#L63">src/data/mystery-encounters/mystery-encounter-option.ts:63</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="onpreoptionphase"><code class="tsd-tag">Optional</code><span>on<wbr/>Pre<wbr/>Option<wbr/>Phase</span><a href="#onpreoptionphase" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">onPreOptionPhase</span><span class="tsd-signature-symbol">?:</span> <a href="../types/data_mystery-encounters_mystery-encounter-option.OptionPhaseCallback.html" class="tsd-signature-type tsd-kind-type-alias">OptionPhaseCallback</a></div><div class="tsd-comment tsd-typography"><p>Executes before any following dialogue or business logic from option. Usually this will be for calculating dialogueTokens or performing scene/data updates</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery-encounters_mystery-encounter-option.IMysteryEncounterOption.html">IMysteryEncounterOption</a>.<a href="../interfaces/data_mystery-encounters_mystery-encounter-option.IMysteryEncounterOption.html#onpreoptionphase">onPreOptionPhase</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter-option.ts#L59">src/data/mystery-encounters/mystery-encounter-option.ts:59</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="optionmode"><span>option<wbr/>Mode</span><a href="#optionmode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">optionMode</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_mystery-encounter-option-mode.MysteryEncounterOptionMode.html" class="tsd-signature-type tsd-kind-enum">MysteryEncounterOptionMode</a></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery-encounters_mystery-encounter-option.IMysteryEncounterOption.html">IMysteryEncounterOption</a>.<a href="../interfaces/data_mystery-encounters_mystery-encounter-option.IMysteryEncounterOption.html#optionmode">optionMode</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter-option.ts#L43">src/data/mystery-encounters/mystery-encounter-option.ts:43</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="primarypokemon"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">primaryPokemon</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter-option.ts#L48">src/data/mystery-encounters/mystery-encounter-option.ts:48</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="primarypokemonrequirements"><span>primary<wbr/>Pokemon<wbr/>Requirements</span><a href="#primarypokemonrequirements" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">primaryPokemonRequirements</span><span class="tsd-signature-symbol">:</span> <a href="data_mystery-encounters_mystery-encounter-requirements.EncounterPokemonRequirement.html" class="tsd-signature-type tsd-kind-class">EncounterPokemonRequirement</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery-encounters_mystery-encounter-option.IMysteryEncounterOption.html">IMysteryEncounterOption</a>.<a href="../interfaces/data_mystery-encounters_mystery-encounter-option.IMysteryEncounterOption.html#primarypokemonrequirements">primaryPokemonRequirements</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter-option.ts#L46">src/data/mystery-encounters/mystery-encounter-option.ts:46</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="requirements"><span>requirements</span><a href="#requirements" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">requirements</span><span class="tsd-signature-symbol">:</span> <a href="data_mystery-encounters_mystery-encounter-requirements.EncounterSceneRequirement.html" class="tsd-signature-type tsd-kind-class">EncounterSceneRequirement</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery-encounters_mystery-encounter-option.IMysteryEncounterOption.html">IMysteryEncounterOption</a>.<a href="../interfaces/data_mystery-encounters_mystery-encounter-option.IMysteryEncounterOption.html#requirements">requirements</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter-option.ts#L45">src/data/mystery-encounters/mystery-encounter-option.ts:45</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="secondarypokemon"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">secondaryPokemon</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter-option.ts#L49">src/data/mystery-encounters/mystery-encounter-option.ts:49</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="secondarypokemonrequirements"><span>secondary<wbr/>Pokemon<wbr/>Requirements</span><a href="#secondarypokemonrequirements" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">secondaryPokemonRequirements</span><span class="tsd-signature-symbol">:</span> <a href="data_mystery-encounters_mystery-encounter-requirements.EncounterPokemonRequirement.html" class="tsd-signature-type tsd-kind-class">EncounterPokemonRequirement</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery-encounters_mystery-encounter-option.IMysteryEncounterOption.html">IMysteryEncounterOption</a>.<a href="../interfaces/data_mystery-encounters_mystery-encounter-option.IMysteryEncounterOption.html#secondarypokemonrequirements">secondaryPokemonRequirements</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter-option.ts#L47">src/data/mystery-encounters/mystery-encounter-option.ts:47</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hasrequirements"><span>has<wbr/>Requirements</span><a href="#hasrequirements" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="hasrequirements-1"><span class="tsd-kind-call-signature">hasRequirements</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#hasrequirements-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns true if option contains any EncounterRequirements, false otherwise.</p>
</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter-option.ts#L78">src/data/mystery-encounters/mystery-encounter-option.ts:78</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="meetsprimaryrequirementandprimarypokemonselected"><span>meets<wbr/>Primary<wbr/>Requirement<wbr/>And<wbr/>Primary<wbr/>Pokemon<wbr/>Selected</span><a href="#meetsprimaryrequirementandprimarypokemonselected" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="meetsprimaryrequirementandprimarypokemonselected-1"><span class="tsd-kind-call-signature">meetsPrimaryRequirementAndPrimaryPokemonSelected</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#meetsprimaryrequirementandprimarypokemonselected-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns true if all PRIMARY EncounterRequirements for the option are met,
AND there is a valid Pokemon assigned to <a href="#primarypokemon" class="tsd-kind-property"><code>primaryPokemon</code></a>.
If both <a href="#primarypokemonrequirements" class="tsd-kind-property"><code>primaryPokemonRequirements</code></a> and <a href="#secondarypokemonrequirements" class="tsd-kind-property"><code>secondaryPokemonRequirements</code></a> are defined,
can cause scenarios where there are not enough Pokemon that are sufficient for all requirements.</p>
</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter-option.ts#L117">src/data/mystery-encounters/mystery-encounter-option.ts:117</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="meetsrequirements"><span>meets<wbr/>Requirements</span><a href="#meetsrequirements" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="meetsrequirements-1"><span class="tsd-kind-call-signature">meetsRequirements</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#meetsrequirements-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns true if all EncounterRequirements for the option are met</p>
</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter-option.ts#L89">src/data/mystery-encounters/mystery-encounter-option.ts:89</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="meetssupportingrequirementandsupportingpokemonselected"><span>meets<wbr/>Supporting<wbr/>Requirement<wbr/>And<wbr/>Supporting<wbr/>Pokemon<wbr/>Selected</span><a href="#meetssupportingrequirementandsupportingpokemonselected" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="meetssupportingrequirementandsupportingpokemonselected-1"><span class="tsd-kind-call-signature">meetsSupportingRequirementAndSupportingPokemonSelected</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#meetssupportingrequirementandsupportingpokemonselected-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns true if all SECONDARY EncounterRequirements for the option are met,
AND there is a valid Pokemon assigned to <a href="#secondarypokemon" class="tsd-kind-property"><code>secondaryPokemon</code></a> (if applicable).
If both <a href="#primarypokemonrequirements" class="tsd-kind-property"><code>primaryPokemonRequirements</code></a> and <a href="#secondarypokemonrequirements" class="tsd-kind-property"><code>secondaryPokemonRequirements</code></a> are defined,
can cause scenarios where there are not enough Pokemon that are sufficient for all requirements.</p>
</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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter-option.ts#L173">src/data/mystery-encounters/mystery-encounter-option.ts:173</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="pokemonmeetsprimaryrequirements"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="pokemonmeetsprimaryrequirements-1"><span class="tsd-kind-call-signature">pokemonMeetsPrimaryRequirements</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pokemon</span><span class="tsd-signature-symbol">:</span> <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#pokemonmeetsprimaryrequirements-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns true if all PRIMARY EncounterRequirements for the option are 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">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/965f92ba0f7626b117b1ed74f3c1f9c6e814fa17/src/data/mystery-encounters/mystery-encounter-option.ts#L101">src/data/mystery-encounters/mystery-encounter-option.ts:101</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#dialogue"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dialogue</span></a><a href="#excludeprimaryfromsecondaryrequirements"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>exclude<wbr/>Primary<wbr/>From<wbr/>Secondary<wbr/>Requirements</span></a><a href="#hasdexprogress"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has<wbr/>Dex<wbr/>Progress</span></a><a href="#onoptionphase"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Option<wbr/>Phase</span></a><a href="#onpostoptionphase"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Post<wbr/>Option<wbr/>Phase</span></a><a href="#onpreoptionphase"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Pre<wbr/>Option<wbr/>Phase</span></a><a href="#optionmode"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>option<wbr/>Mode</span></a><a href="#primarypokemon"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>primary<wbr/>Pokemon</span></a><a href="#primarypokemonrequirements"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>primary<wbr/>Pokemon<wbr/>Requirements</span></a><a href="#requirements"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>requirements</span></a><a href="#secondarypokemon"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>secondary<wbr/>Pokemon</span></a><a href="#secondarypokemonrequirements"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>secondary<wbr/>Pokemon<wbr/>Requirements</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#hasrequirements"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>has<wbr/>Requirements</span></a><a href="#meetsprimaryrequirementandprimarypokemonselected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>meets<wbr/>Primary<wbr/>Requirement<wbr/>And<wbr/>Primary<wbr/>Pokemon<wbr/>Selected</span></a><a href="#meetsrequirements"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>meets<wbr/>Requirements</span></a><a href="#meetssupportingrequirementandsupportingpokemonselected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>meets<wbr/>Supporting<wbr/>Requirement<wbr/>And<wbr/>Supporting<wbr/>Pokemon<wbr/>Selected</span></a><a href="#pokemonmeetsprimaryrequirements"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pokemon<wbr/>Meets<wbr/>Primary<wbr/>Requirements</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">pokemon-rogue-battle</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
Reference in New Issue View Git Blame Copy Permalink