pokerogue/main/interfaces/data_mystery_encounters_uti...

16 lines
21 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>EnemyPartyConfig | 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_utils_encounter_phase_utils.html">data/mystery-encounters/utils/encounter-phase-utils</a></li><li><a href="data_mystery_encounters_utils_encounter_phase_utils.EnemyPartyConfig.html">EnemyPartyConfig</a></li></ul><h1>Interface EnemyPartyConfig</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">EnemyPartyConfig</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="data_mystery_encounters_utils_encounter_phase_utils.EnemyPartyConfig.html#countAsSeen">countAsSeen</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_mystery_encounters_utils_encounter_phase_utils.EnemyPartyConfig.html#disableSwitch">disableSwitch</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_mystery_encounters_utils_encounter_phase_utils.EnemyPartyConfig.html#doubleBattle">doubleBattle</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_mystery_encounters_utils_encounter_phase_utils.EnemyPartyConfig.html#female">female</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_mystery_encounters_utils_encounter_phase_utils.EnemyPartyConfig.html#levelAdditiveModifier">levelAdditiveModifier</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_mystery_encounters_utils_encounter_phase_utils.EnemyPartyConfig.html#pokemonConfigs">pokemonConfigs</a><span class="tsd-signature-symbol">?: </span><a href="data_mystery_encounters_utils_encounter_phase_utils.EnemyPokemonConfig.html" class="tsd-signature-type tsd-kind-interface">EnemyPokemonConfig</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_mystery_encounters_utils_encounter_phase_utils.EnemyPartyConfig.html#trainerConfig">trainerConfig</a><span class="tsd-signature-symbol">?: </span><a href="../classes/data_trainer_config.TrainerConfig.html" class="tsd-signature-type tsd-kind-class">TrainerConfig</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="data_mystery_encounters_utils_encounter_phase_utils.EnemyPartyConfig.html#trainerType">trainerType</a><span class="tsd-signature-symbol">?: </span><a href="../enums/enums_trainer_type.TrainerType.html" class="tsd-signature-type tsd-kind-enum">TrainerType</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/b1194cdfb62a42409343e6dcdd959c88fcca1590/src/data/mystery-encounters/utils/encounter-phase-utils.ts#L95">src/data/mystery-encounters/utils/encounter-phase-utils.ts:95</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_utils_encounter_phase_utils.EnemyPartyConfig.html#countAsSeen" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>count<wbr/>As<wbr/>Seen?</span></a>
<a href="data_mystery_encounters_utils_encounter_phase_utils.EnemyPartyConfig.html#disableSwitch" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disable<wbr/>Switch?</span></a>
<a href="data_mystery_encounters_utils_encounter_phase_utils.EnemyPartyConfig.html#doubleBattle" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>double<wbr/>Battle?</span></a>
<a href="data_mystery_encounters_utils_encounter_phase_utils.EnemyPartyConfig.html#female" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>female?</span></a>
<a href="data_mystery_encounters_utils_encounter_phase_utils.EnemyPartyConfig.html#levelAdditiveModifier" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>level<wbr/>Additive<wbr/>Modifier?</span></a>
<a href="data_mystery_encounters_utils_encounter_phase_utils.EnemyPartyConfig.html#pokemonConfigs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pokemon<wbr/>Configs?</span></a>
<a href="data_mystery_encounters_utils_encounter_phase_utils.EnemyPartyConfig.html#trainerConfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>trainer<wbr/>Config?</span></a>
<a href="data_mystery_encounters_utils_encounter_phase_utils.EnemyPartyConfig.html#trainerType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>trainer<wbr/>Type?</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-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="countAsSeen" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>count<wbr/>As<wbr/>Seen</span><a href="#countAsSeen" 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">count<wbr/>As<wbr/>Seen</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p><code>true</code> or leaving undefined will increment dex seen count for the encounter battle, <code>false</code> will not</p>
</div><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/utils/encounter-phase-utils.ts#L109">src/data/mystery-encounters/utils/encounter-phase-utils.ts:109</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="disableSwitch" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>disable<wbr/>Switch</span><a href="#disableSwitch" 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">disable<wbr/>Switch</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p><code>true</code> will prevent player from switching</p>
</div><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/utils/encounter-phase-utils.ts#L107">src/data/mystery-encounters/utils/encounter-phase-utils.ts:107</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="doubleBattle" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>double<wbr/>Battle</span><a href="#doubleBattle" 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">double<wbr/>Battle</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/utils/encounter-phase-utils.ts#L98">src/data/mystery-encounters/utils/encounter-phase-utils.ts:98</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="female" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>female</span><a href="#female" 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">female</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p><code>true</code> for female trainer, false for male</p>
</div><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/utils/encounter-phase-utils.ts#L105">src/data/mystery-encounters/utils/encounter-phase-utils.ts:105</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="levelAdditiveModifier" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>level<wbr/>Additive<wbr/>Modifier</span><a href="#levelAdditiveModifier" 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">level<wbr/>Additive<wbr/>Modifier</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Formula for enemy level: level += waveIndex / 10 * levelAdditiveModifier</p>
</div><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/utils/encounter-phase-utils.ts#L97">src/data/mystery-encounters/utils/encounter-phase-utils.ts:97</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="pokemonConfigs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>pokemon<wbr/>Configs</span><a href="#pokemonConfigs" 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">pokemon<wbr/>Configs</span><span class="tsd-signature-symbol">?:</span> <a href="data_mystery_encounters_utils_encounter_phase_utils.EnemyPokemonConfig.html" class="tsd-signature-type tsd-kind-interface">EnemyPokemonConfig</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/b1194cdfb62a42409343e6dcdd959c88fcca1590/src/data/mystery-encounters/utils/encounter-phase-utils.ts#L103">src/data/mystery-encounters/utils/encounter-phase-utils.ts:103</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="trainerConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>trainer<wbr/>Config</span><a href="#trainerConfig" 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">trainer<wbr/>Config</span><span class="tsd-signature-symbol">?:</span> <a href="../classes/data_trainer_config.TrainerConfig.html" class="tsd-signature-type tsd-kind-class">TrainerConfig</a></div><div class="tsd-comment tsd-typography"><p>More customizable option for configuring trainer battle</p>
</div><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/utils/encounter-phase-utils.ts#L102">src/data/mystery-encounters/utils/encounter-phase-utils.ts:102</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="trainerType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>trainer<wbr/>Type</span><a href="#trainerType" 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">trainer<wbr/>Type</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/enums_trainer_type.TrainerType.html" class="tsd-signature-type tsd-kind-enum">TrainerType</a></div><div class="tsd-comment tsd-typography"><p>Generates trainer battle solely off trainer type</p>
</div><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/utils/encounter-phase-utils.ts#L100">src/data/mystery-encounters/utils/encounter-phase-utils.ts:100</a></li></ul></aside></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-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#countAsSeen" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>count<wbr/>As<wbr/>Seen</span></a><a href="#disableSwitch" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disable<wbr/>Switch</span></a><a href="#doubleBattle" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>double<wbr/>Battle</span></a><a href="#female" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>female</span></a><a href="#levelAdditiveModifier" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>level<wbr/>Additive<wbr/>Modifier</span></a><a href="#pokemonConfigs" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pokemon<wbr/>Configs</span></a><a href="#trainerConfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>trainer<wbr/>Config</span></a><a href="#trainerType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>trainer<wbr/>Type</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>pokemon-rogue-battle</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><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>