pokerogue/main/classes/data_mystery_encounters_mys...

39 lines
45 KiB
HTML
Raw Permalink 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>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_option.html">data/mystery-encounters/mystery-encounter-option</a></li><li><a href="data_mystery_encounters_mystery_encounter_option.default.html">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 <a href="data_mystery_encounters_mystery_encounter_option.default.html" class="tsd-kind-class"><code>MysteryEncounterOption</code></a> class when building.</p>
<p>Should ONLY contain properties that are necessary for <a href="data_mystery_encounters_mystery_encounter_option.default.html" class="tsd-kind-class"><code>MysteryEncounterOption</code></a> construction.
Post-construct and flag data properties are defined in the <a href="data_mystery_encounters_mystery_encounter_option.default.html" class="tsd-kind-class"><code>MysteryEncounterOption</code></a> class itself.</p>
2024-11-18 18:42:56 +00:00
</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/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/mystery-encounters/mystery-encounter-option.ts#L35">src/data/mystery-encounters/mystery-encounter-option.ts:35</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_option.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>
2024-09-27 22:52:07 +01:00
</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_option.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_option.default.html#excludePrimaryFromSecondaryRequirements" 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/>Secondary<wbr/>Requirements</span></a>
<a href="data_mystery_encounters_mystery_encounter_option.default.html#hasDexProgress" 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/>Dex<wbr/>Progress</span></a>
<a href="data_mystery_encounters_mystery_encounter_option.default.html#onOptionPhase" 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/>Option<wbr/>Phase</span></a>
<a href="data_mystery_encounters_mystery_encounter_option.default.html#onPostOptionPhase" 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/>Post<wbr/>Option<wbr/>Phase?</span></a>
<a href="data_mystery_encounters_mystery_encounter_option.default.html#onPreOptionPhase" 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/>Pre<wbr/>Option<wbr/>Phase?</span></a>
<a href="data_mystery_encounters_mystery_encounter_option.default.html#optionMode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>option<wbr/>Mode</span></a>
<a href="data_mystery_encounters_mystery_encounter_option.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_option.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_option.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_option.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_option.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>
</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_option.default.html#hasRequirements" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>has<wbr/>Requirements</span></a>
<a href="data_mystery_encounters_mystery_encounter_option.default.html#meetsPrimaryRequirementAndPrimaryPokemonSelected" 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/>Primary<wbr/>Requirement<wbr/>And<wbr/>Primary<wbr/>Pokemon<wbr/>Selected</span></a>
<a href="data_mystery_encounters_mystery_encounter_option.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_option.default.html#meetsSupportingRequirementAndSupportingPokemonSelected" 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/>Supporting<wbr/>Requirement<wbr/>And<wbr/>Supporting<wbr/>Pokemon<wbr/>Selected</span></a>
<a href="data_mystery_encounters_mystery_encounter_option.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>
2024-11-18 18:42:56 +00: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-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">option</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><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">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="data_mystery_encounters_mystery_encounter_option.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/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/mystery-encounters/mystery-encounter-option.ts#L58">src/data/mystery-encounters/mystery-encounter-option.ts:58</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="dialogue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><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
2024-09-27 22:52:07 +01:00
Will be populated on MysteryEncounter initialization</p>
2024-11-18 18:42:56 +00:00
</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/0c920ba195c8fa8470694f5a1f4b3157438aa256/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"><a id="excludePrimaryFromSecondaryRequirements" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><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/>Secondary<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_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/0c920ba195c8fa8470694f5a1f4b3157438aa256/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"><a id="hasDexProgress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has<wbr/>Dex<wbr/>Progress</span><a href="#hasDexProgress" 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/>Dex<wbr/>Progress</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/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/mystery-encounters/mystery-encounter-option.ts#L37">src/data/mystery-encounters/mystery-encounter-option.ts:37</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="onOptionPhase" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>on<wbr/>Option<wbr/>Phase</span><a href="#onOptionPhase" 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/>Option<wbr/>Phase</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/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/mystery-encounters/mystery-encounter-option.ts#L54">src/data/mystery-encounters/mystery-encounter-option.ts:54</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="onPostOptionPhase" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">on<wbr/>Post<wbr/>Option<wbr/>Phase</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/0c920ba195c8fa8470694f5a1f4b3157438aa256/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"><a id="onPreOptionPhase" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">on<wbr/>Pre<wbr/>Option<wbr/>Phase</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/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/mystery-encounters/mystery-encounter-option.ts#L52">src/data/mystery-encounters/mystery-encounter-option.ts:52</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="optionMode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>option<wbr/>Mode</span><a href="#optionMode" 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">option<wbr/>Mode</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/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/mystery-encounters/mystery-encounter-option.ts#L36">src/data/mystery-encounters/mystery-encounter-option.ts:36</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/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/mystery-encounters/mystery-encounter-option.ts#L41">src/data/mystery-encounters/mystery-encounter-option.ts:41</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><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/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/mystery-encounters/mystery-encounter-option.ts#L39">src/data/mystery-encounters/mystery-encounter-option.ts:39</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="requirements" class="tsd-anchor"></
</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/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/mystery-encounters/mystery-encounter-option.ts#L71">src/data/mystery-encounters/mystery-encounter-option.ts:71</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="meetsPrimaryRequirementAndPrimaryPokemonSelected" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="meetsPrimaryRequirementAndPrimaryPokemonSelected.meetsPrimaryRequirementAndPrimaryPokemonSelected-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">meets<wbr/>Primary<wbr/>Requirement<wbr/>And<wbr/>Primary<wbr/>Pokemon<wbr/>Selected</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="#meetsPrimaryRequirementAndPrimaryPokemonSelected.meetsPrimaryRequirementAndPrimaryPokemonSelected-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>Returns true if all PRIMARY EncounterRequirements for the option are met,
2024-09-27 22:52:07 +01:00
AND there is a valid Pokemon assigned to <a href="data_mystery_encounters_mystery_encounter_option.default.html#primaryPokemon" class="tsd-kind-property"><code>primaryPokemon</code></a>.
If both <a href="data_mystery_encounters_mystery_encounter_option.default.html#primaryPokemonRequirements" class="tsd-kind-property"><code>primaryPokemonRequirements</code></a> and <a href="data_mystery_encounters_mystery_encounter_option.default.html#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>
2024-11-18 18:42:56 +00:00
</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/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/mystery-encounters/mystery-encounter-option.ts#L101">src/data/mystery-encounters/mystery-encounter-option.ts:101</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>Returns true if all 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">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/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/mystery-encounters/mystery-encounter-option.ts#L79">src/data/mystery-encounters/mystery-encounter-option.ts:79</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="meetsSupportingRequirementAndSupportingPokemonSelected" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="meetsSupportingRequirementAndSupportingPokemonSelected.meetsSupportingRequirementAndSupportingPokemonSelected-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">meets<wbr/>Supporting<wbr/>Requirement<wbr/>And<wbr/>Supporting<wbr/>Pokemon<wbr/>Selected</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="#meetsSupportingRequirementAndSupportingPokemonSelected.meetsSupportingRequirementAndSupportingPokemonSelected-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>Returns true if all SECONDARY EncounterRequirements for the option are met,
2024-09-27 22:52:07 +01:00
AND there is a valid Pokemon assigned to <a href="data_mystery_encounters_mystery_encounter_option.default.html#secondaryPokemon" class="tsd-kind-property"><code>secondaryPokemon</code></a> (if applicable).
If both <a href="data_mystery_encounters_mystery_encounter_option.default.html#primaryPokemonRequirements" class="tsd-kind-property"><code>primaryPokemonRequirements</code></a> and <a href="data_mystery_encounters_mystery_encounter_option.default.html#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>
2024-11-18 18:42:56 +00:00
</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/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/mystery-encounters/mystery-encounter-option.ts#L159">src/data/mystery-encounters/mystery-encounter-option.ts:159</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>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">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/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/mystery-encounters/mystery-encounter-option.ts#L90">src/data/mystery-encounters/mystery-encounter-option.ts:90</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=