pokerogue/main/classes/data_mystery_encounters_mys...

16 lines
21 KiB
HTML
Raw Normal View History

2024-10-26 21:31:27 +00:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CombinationSceneRequirement | 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.CombinationSceneRequirement.html">CombinationSceneRequirement</a></li></ul><h1>Class CombinationSceneRequirement</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Combination of multiple <a href="data_mystery_encounters_mystery_encounter_requirements.EncounterSceneRequirement.html" class="tsd-kind-class"><code>EncounterSceneRequirements</code></a> (OR/AND possible. See isAnd)</p>
2024-11-18 18:42:56 +00:00
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a href="../hierarchy.html#data/mystery-encounters/mystery-encounter-requirements.CombinationSceneRequirement">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="data_mystery_encounters_mystery_encounter_requirements.EncounterSceneRequirement.html" class="tsd-signature-type tsd-kind-class">EncounterSceneRequirement</a><ul class="tsd-hierarchy"><li><span class="target">CombinationSceneRequirement</span></li></ul></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-requirements.ts#L43">src/data/mystery-encounters/mystery-encounter-requirements.ts:43</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">Properties</h3><div class="tsd-index-list"><a href="data_mystery_encounters_mystery_encounter_requirements.CombinationSceneRequirement.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>
2024-09-27 21:52:07 +00:00
</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.CombinationSceneRequirement.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.CombinationSceneRequirement.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>
2024-10-26 21:31:27 +00:00
<a href="data_mystery_encounters_mystery_encounter_requirements.CombinationSceneRequirement.html#Every" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Every</span></a>
<a href="data_mystery_encounters_mystery_encounter_requirements.CombinationSceneRequirement.html#Some" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>Some</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-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="requirements" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>requirements</span><a href="#requirements" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">requirements</span><span class="tsd-signature-symbol">:</span> <a href="data_mystery_encounters_mystery_encounter_requirements.EncounterSceneRequirement.html" class="tsd-signature-type tsd-kind-class">EncounterSceneRequirement</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/mystery-encounters/mystery-encounter-requirements.ts#L46">src/data/mystery-encounters/mystery-encounter-requirements.ts:46</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"><span>get<wbr/>Dialogue<wbr/>Token</span><a href="#getDialogueToken" 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="getDialogueToken.getDialogueToken-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Dialogue<wbr/>Token</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-symbol">: </span><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><a href="#getDialogueToken.getDialogueToken-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>Retrieves a dialogue token key/value pair for the given <a href="data_mystery_encounters_mystery_encounter_requirements.EncounterSceneRequirement.html" class="tsd-kind-class"><code>requirements</code></a>.</p>
2024-10-26 21:31:27 +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"><p>The <a href="battle_scene.default.html" class="tsd-kind-class"><code>BattleScene</code></a> to check against</p>
</div><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"><p>The <a href="field_pokemon.PlayerPokemon.html" class="tsd-kind-class"><code>PlayerPokemon</code></a> to check against</p>
</div><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><p>A dialogue token key/value pair</p>
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Throws" class="tsd-anchor"></a>Throws<a href="#Throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>An Error if isAnd is <code>true</code> (not supported)</p>
2024-11-18 18:42:56 +00:00
</div><aside class="tsd-sources"><p>Overrides <a href="data_mystery_encounters_mystery_encounter_requirements.EncounterSceneRequirement.html">EncounterSceneRequirement</a>.<a href="data_mystery_encounters_mystery_encounter_requirements.EncounterSceneRequirement.html#getDialogueToken">getDialogueToken</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/mystery-encounters/mystery-encounter-requirements.ts#L80">src/data/mystery-encounters/mystery-encounter-requirements.ts:80</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"><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>Checks if all/any requirements are met (depends on isAnd)</p>
2024-10-26 21:31:27 +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"><p>The <a href="battle_scene.default.html" class="tsd-kind-class"><code>BattleScene</code></a> to check against</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if all/any requirements are met (depends on isAnd)</p>
2024-11-18 18:42:56 +00:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="data_mystery_encounters_mystery_encounter_requirements.EncounterSceneRequirement.html">EncounterSceneRequirement</a>.<a href="data_mystery_encounters_mystery_encounter_requirements.EncounterSceneRequirement.html#meetsRequirement">meetsRequirement</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/0c920ba195c8fa8470694f5a1f4b3157438aa256/src/data/mystery-encounters/mystery-encounter-requirements.ts#L67">src/data/mystery-encounters/mystery-encounter-requirements.ts:67</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="Every" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>Every</span><a href="#Every" 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="Every.Every-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Every</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">requirements</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter_requirements.CombinationSceneRequirement.html" class="tsd-signature-type tsd-kind-class">CombinationSceneRequirement</a><a href="#Every.Every-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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">requirements</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></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_mystery_encounters_mystery_encounter_requirements.CombinationSceneRequirement.html" class="tsd-signature-type tsd-kind-class">CombinationSceneRequirement</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-requirements.ts#L52">src/data/mystery-encounters/mystery-encounter-requirements.ts:52</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="Some" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>Some</span><a href="#Some" 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="Some.Some-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Some</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">requirements</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_mystery_encounters_mystery_encounter_requirements.CombinationSceneRequirement.html" class="tsd-signature-type tsd-kind-class">CombinationSceneRequirement</a><a href="#Some.Some-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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">requirements</span>: <a href="data_mystery_encounters_mystery_encounter_requirements.EncounterSc