pokerogue/main/classes/modifier_modifier.DoubleBattleChanceBoosterModifier.html

34 lines
51 KiB
HTML
Raw Normal View History

2024-09-10 23:07:25 +01:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DoubleBattleChanceBoosterModifier | 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/modifier_modifier.html">modifier/modifier</a></li><li><a href="modifier_modifier.DoubleBattleChanceBoosterModifier.html">DoubleBattleChanceBoosterModifier</a></li></ul><h1>Class DoubleBattleChanceBoosterModifier</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Modifier used for passive items, specifically lures, that
temporarily increases the chance of a double battle.</p>
</div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="See" class="tsd-anchor"></a>See<a href="#See" 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><a href="modifier_modifier.DoubleBattleChanceBoosterModifier.html#apply" class="tsd-kind-method"><code>apply</code></a></p>
2024-09-28 15:26:51 +01:00
</div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a href="../hierarchy.html#modifier/modifier.DoubleBattleChanceBoosterModifier">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="modifier_modifier.LapsingPersistentModifier.html" class="tsd-signature-type tsd-kind-class">LapsingPersistentModifier</a><ul class="tsd-hierarchy"><li><span class="target">DoubleBattleChanceBoosterModifier</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/0464d8f6664cf2b07a908df0cdabb7c67e7f6ce2/src/modifier/modifier.ts#L402">src/modifier/modifier.ts:402</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="modifier_modifier.DoubleBattleChanceBoosterModifier.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-10 23:07:25 +01:00
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="modifier_modifier.DoubleBattleChanceBoosterModifier.html#stackCount" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stack<wbr/>Count</span></a>
2024-05-31 14:57:14 +01:00
<a href="modifier_modifier.DoubleBattleChanceBoosterModifier.html#type" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a>
<a href="modifier_modifier.DoubleBattleChanceBoosterModifier.html#virtualStackCount" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>virtual<wbr/>Stack<wbr/>Count</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="modifier_modifier.DoubleBattleChanceBoosterModifier.html#add" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add</span></a>
<a href="modifier_modifier.DoubleBattleChanceBoosterModifier.html#apply" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>apply</span></a>
<a href="modifier_modifier.DoubleBattleChanceBoosterModifier.html#clone" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clone</span></a>
2024-09-10 23:07:25 +01:00
<a href="modifier_modifier.DoubleBattleChanceBoosterModifier.html#getArgs" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Args</span></a>
<a href="modifier_modifier.DoubleBattleChanceBoosterModifier.html#getBattleCount" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Battle<wbr/>Count</span></a>
2024-05-31 14:57:14 +01:00
<a href="modifier_modifier.DoubleBattleChanceBoosterModifier.html#getIcon" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Icon</span></a>
<a href="modifier_modifier.DoubleBattleChanceBoosterModifier.html#getIconStackText" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Icon<wbr/>Stack<wbr/>Text</span></a>
2024-09-10 23:07:25 +01:00
<a href="modifier_modifier.DoubleBattleChanceBoosterModifier.html#getMaxBattles" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Max<wbr/>Battles</span></a>
2024-05-31 14:57:14 +01:00
<a href="modifier_modifier.DoubleBattleChanceBoosterModifier.html#getMaxStackCount" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Max<wbr/>Stack<wbr/>Count</span></a>
<a href="modifier_modifier.DoubleBattleChanceBoosterModifier.html#getStackCount" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Stack<wbr/>Count</span></a>
<a href="modifier_modifier.DoubleBattleChanceBoosterModifier.html#incrementStack" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>increment<wbr/>Stack</span></a>
<a href="modifier_modifier.DoubleBattleChanceBoosterModifier.html#isIconVisible" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Icon<wbr/>Visible</span></a>
<a href="modifier_modifier.DoubleBattleChanceBoosterModifier.html#lapse" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>lapse</span></a>
<a href="modifier_modifier.DoubleBattleChanceBoosterModifier.html#match" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>match</span></a>
2024-09-10 23:07:25 +01:00
<a href="modifier_modifier.DoubleBattleChanceBoosterModifier.html#resetBattleCount" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reset<wbr/>Battle<wbr/>Count</span></a>
2024-05-31 14:57:14 +01:00
<a href="modifier_modifier.DoubleBattleChanceBoosterModifier.html#shouldApply" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>should<wbr/>Apply</span></a>
2024-09-28 15:26:51 +01: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_DoubleBattleChanceBoosterModifier" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Double<wbr/>Battle<wbr/>Chance<wbr/>Booster<wbr/>Modifier</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</span>, <span class="tsd-kind-parameter">maxBattles</span>, <span class="tsd-kind-parameter">battleCount</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">stackCount</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="modifier_modifier.DoubleBattleChanceBoosterModifier.html" class="tsd-signature-type tsd-kind-class">DoubleBattleChanceBoosterModifier</a><a href="#constructor.new_DoubleBattleChanceBoosterModifier" 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">type</span>: <a href="modifier_modifier_type.ModifierType.html" class="tsd-signature-type tsd-kind-class">ModifierType</a></span></li><li><span><span class="tsd-kind-parameter">maxBattles</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">battleCount</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">stackCount</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="modifier_modifier.DoubleBattleChanceBoosterModifier.html" class="tsd-signature-type tsd-kind-class">DoubleBattleChanceBoosterModifier</a></h4><aside class="tsd-sources"><p>Overrides <a href="modifier_modifier.LapsingPersistentModifier.html">LapsingPersistentModifier</a>.<a href="modifier_modifier.LapsingPersistentModifier.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/0464d8f6664cf2b07a908df0cdabb7c67e7f6ce2/src/modifier/modifier.ts#L403">src/modifier/modifier.ts:403</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 tsd-is-inherited"><a id="stackCount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>stack<wbr/>Count</span><a href="#stackCount" 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">stack<wbr/>Count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="modifier_modifier.LapsingPersistentModifier.html">LapsingPersistentModifier</a>.<a href="modifier_modifier.LapsingPersistentModifier.html#stackCount">stackCount</a></p><u
2024-09-10 23:07:25 +01:00
which will then either add it to the existing modifiers if none were found
or, if one was found, it will refresh battleCount.</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">modifiers</span>: <a href="modifier_modifier.PersistentModifier.html" class="tsd-signature-type tsd-kind-class">PersistentModifier</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p><a href="modifier_modifier.PersistentModifier.html" class="tsd-kind-class"><code>PersistentModifier</code></a> array of the player's modifiers</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">_virtual</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>N/A</p>
</div><div class="tsd-comment tsd-typography"></div></li><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><p>true if the modifier was successfully added or applied, false otherwise</p>
2024-09-28 15:26:51 +01:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="modifier_modifier.LapsingPersistentModifier.html">LapsingPersistentModifier</a>.<a href="modifier_modifier.LapsingPersistentModifier.html#add">add</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/0464d8f6664cf2b07a908df0cdabb7c67e7f6ce2/src/modifier/modifier.ts#L328">src/modifier/modifier.ts:328</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="apply" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>apply</span><a href="#apply" 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="apply.apply-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">apply</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#apply.apply-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>Increases the chance of a double battle occurring</p>
2024-09-10 23:07:25 +01: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">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>[0] <a href="utils.NumberHolder.html" class="tsd-kind-class"><code>Utils.NumberHolder</code></a> for double battle chance</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 the modifier was applied</p>
2024-09-28 15:26:51 +01:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="modifier_modifier.LapsingPersistentModifier.html">LapsingPersistentModifier</a>.<a href="modifier_modifier.LapsingPersistentModifier.html#apply">apply</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/0464d8f6664cf2b07a908df0cdabb7c67e7f6ce2/src/modifier/modifier.ts#L420">src/modifier/modifier.ts:420</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="clone" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>clone</span><a href="#clone" 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="clone.clone-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">clone</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="modifier_modifier.DoubleBattleChanceBoosterModifier.html" class="tsd-signature-type tsd-kind-class">DoubleBattleChanceBoosterModifier</a><a href="#clone.clone-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"><h4 class="tsd-returns-title">Returns <a href="modifier_modifier.DoubleBattleChanceBoosterModifier.html" class="tsd-signature-type tsd-kind-class">DoubleBattleChanceBoosterModifier</a></h4><aside class="tsd-sources"><p>Overrides <a href="modifier_modifier.LapsingPersistentModifier.html">LapsingPersistentModifier</a>.<a href="modifier_modifier.LapsingPersistentModifier.html#clone">clone</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/0464d8f6664cf2b07a908df0cdabb7c67e7f6ce2/src/modifier/modifier.ts#L411">src/modifier/modifier.ts:411</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getArgs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Args</span><a href="#getArgs" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="getArgs.getArgs-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Args</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><a href="#getArgs.getArgs-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"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources"><p>Inherited from <a href="modifier_modifier.LapsingPersistentModifier.html">LapsingPersistentModifier</a>.<a href="modifier_modifier.LapsingPersistentModifier.html#getArgs">getArgs</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/0464d8f6664cf2b07a908df0cdabb7c67e7f6ce2/src/modifier/modifier.ts#L386">src/modifier/modifier.ts:386</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getBattleCount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Battle<wbr/>Count</span><a href="#getBattleCount" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="getBattleCount.getBattleCount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Battle<wbr/>Count</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)