ShuriZma
/
pokerogue
mirror of https://github.com/pagefaultgames/pokerogue.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
pokerogue/main/classes/data_mystery_encounters_mys...

12 lines
24 KiB
HTML
Raw Normal View History

[skip ci] Deploy docs
2024-09-28 17:46:25 +00:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>EncounterPokemonRequirement | 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_requirements.html">data/mystery-encounters/mystery-encounter-requirements</a></li><li><a href="data_mystery_encounters_mystery_encounter_requirements.EncounterPokemonRequirement.html">EncounterPokemonRequirement</a></li></ul><h1>Class EncounterPokemonRequirement<code class="tsd-tag">Abstract</code></h1></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a href="../hierarchy.html#data/mystery-encounters/mystery-encounter-requirements.EncounterPokemonRequirement">view full</a>)</h4><ul class="tsd-hierarchy"><li><span class="target">EncounterPokemonRequirement</span><ul class="tsd-hierarchy"><li><a href="data_mystery_encounters_mystery_encounter_requirements.CombinationPokemonRequirement.html" class="tsd-signature-type tsd-kind-class">CombinationPokemonRequirement</a></li><li><a href="data_mystery_encounters_mystery_encounter_requirements.SpeciesRequirement.html" class="tsd-signature-type tsd-kind-class">SpeciesRequirement</a></li><li><a href="data_mystery_encounters_mystery_encounter_requirements.NatureRequirement.html" class="tsd-signature-type tsd-kind-class">NatureRequirement</a></li><li><a href="data_mystery_encounters_mystery_encounter_requirements.TypeRequirement.html" class="tsd-signature-type tsd-kind-class">TypeRequirement</a></li><li><a href="data_mystery_encounters_mystery_encounter_requirements.MoveRequirement.html" class="tsd-signature-type tsd-kind-class">MoveRequirement</a></li><li><a href="data_mystery_encounters_mystery_encounter_requirements.CompatibleMoveRequirement.html" class="tsd-signature-type tsd-kind-class">CompatibleMoveRequirement</a></li><li><a href="data_mystery_encounters_mystery_encounter_requirements.AbilityRequirement.html" class="tsd-signature-type tsd-kind-class">AbilityRequirement</a></li><li><a href="data_mystery_encounters_mystery_encounter_requirements.StatusEffectRequirement.html" class="tsd-signature-type tsd-kind-class">StatusEffectRequirement</a></l
[skip ci] Deploy docs
2024-09-27 21:52:07 +00: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_requirements.EncounterPokemonRequirement.html#invertQuery" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>invert<wbr/>Query</span></a>
<a href="data_mystery_encounters_mystery_encounter_requirements.EncounterPokemonRequirement.html#minNumberOfPokemon" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>min<wbr/>Number<wbr/>Of<wbr/>Pokemon</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_requirements.EncounterPokemonRequirement.html#getDialogueToken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Dialogue<wbr/>Token</span></a>
<a href="data_mystery_encounters_mystery_encounter_requirements.EncounterPokemonRequirement.html#meetsRequirement" 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/>Requirement</span></a>
<a href="data_mystery_encounters_mystery_encounter_requirements.EncounterPokemonRequirement.html#queryParty" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>query<wbr/>Party</span></a>
[skip ci] Deploy docs
2024-09-28 17:46:25 +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_EncounterPokemonRequirement" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Encounter<wbr/>Pokemon<wbr/>Requirement</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</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><a href="#constructor.new_EncounterPokemonRequirement" 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"><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter_requirements.EncounterPokemonRequirement.html" class="tsd-signature-type tsd-kind-class">EncounterPokemonRequirement</a></h4></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="invertQuery" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>invert<wbr/>Query</span><a href="#invertQuery" 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">invert<wbr/>Query</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/b1194cdfb62a42409343e6dcdd959c88fcca1590/src/data/mystery-encounters/mystery-encounter-requirements.ts#L69">src/data/mystery-encounters/mystery-encounter-requirements.ts:69</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="minNumberOfPokemon" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>min<wbr/>Number<wbr/>Of<wbr/>Pokemon</span><a href="#minNumberOfPokemon" 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">min<wbr/>Number<wbr/>Of<wbr/>Pokemon</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/b1194cdfb62a42409343e6dcdd959c88fcca1590/src/data/mystery-encounters/mystery-encounter-requirements.ts#L68">src/data/mystery-encounters/mystery-encounter-requirements.ts:68</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="getDialogueToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Abstract</code><span>get<wbr/>Dialogue<wbr/>Token</span><
[skip ci] Deploy docs
2024-09-27 21:52:07 +00:00
Should be overridden by child Requirement classes.</p>
[skip ci] Deploy docs
2024-09-28 17:46:25 +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><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">pokemon</span>: <a href="field_pokemon.PlayerPokemon.html" class="tsd-signature-type tsd-kind-class">PlayerPokemon</a></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</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">]</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter_requirements.EncounterRequirement.html">EncounterRequirement</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter_requirements.EncounterRequirement.html#getDialogueToken">getDialogueToken</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/b1194cdfb62a42409343e6dcdd959c88fcca1590/src/data/mystery-encounters/mystery-encounter-requirements.ts#L89">src/data/mystery-encounters/mystery-encounter-requirements.ts:89</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="meetsRequirement" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Abstract</code><span>meets<wbr/>Requirement</span><a href="#meetsRequirement" 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="meetsRequirement.meetsRequirement-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">meets<wbr/>Requirement</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="#meetsRequirement.meetsRequirement-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 whether the EncounterPokemonRequirement's... requirements, are met by the given scene</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">scene</span>: <a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/data_mystery_encounters_mystery_encounter_requirements.EncounterRequirement.html">EncounterRequirement</a>.<a href="../interfaces/data_mystery_encounters_mystery_encounter_requirements.EncounterRequirement.html#meetsRequirement">meetsRequirement</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/b1194cdfb62a42409343e6dcdd959c88fcca1590/src/data/mystery-encounters/mystery-encounter-requirements.ts#L75">src/data/mystery-encounters/mystery-encounter-requirements.ts:75</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="queryParty" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Abstract</code><span>query<wbr/>Party</span><a href="#queryParty" 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="queryParty.queryParty-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">query<wbr/>Party</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">partyPokemon</span><span class="tsd-signature-symbol">)</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><a href="#queryParty.queryParty-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 all party members that are compatible with this requirement. For non pokemon related requirements, the entire party is returned.</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">partyPokemon</span>: <a href="field_pokemon.PlayerPokemon.html" class="tsd-signature-type tsd-kind-class">PlayerPokemon</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="field_pokemon.PlayerPokemon.html" class="tsd-signature-type tsd-kind-class">PlayerPokemon</a><span class="tsd-signature-symbol">[]</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/b1194cdfb62a42409343e6dcdd959c88fcca1590/src/data/mystery-encounters/mystery-encounter-requirements.ts#L81">src/data/mystery-encounters/mystery-encounter-requirements.ts:81</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24