pokerogue/main/classes/modifier_modifier_type.Modi...

16 lines
32 KiB
HTML
Raw Normal View History

2024-06-04 23:00:48 +01:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ModifierType | 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_type.html">modifier/modifier-type</a></li><li><a href="modifier_modifier_type.ModifierType.html">ModifierType</a></li></ul><h1>Class ModifierType</h1></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#modifier/modifier-type.ModifierType">view full</a>)</h4><ul class="tsd-hierarchy"><li><span class="target">ModifierType</span><ul class="tsd-hierarchy"><li><a href="modifier_modifier_type.ModifierTypeGenerator.html" class="tsd-signature-type tsd-kind-class">ModifierTypeGenerator</a></li><li><a href="modifier_modifier_type.PokemonModifierType.html" class="tsd-signature-type tsd-kind-class">PokemonModifierType</a></li><li><a href="modifier_modifier_type.DoubleBattleChanceBoosterModifierType.html" class="tsd-signature-type tsd-kind-class">DoubleBattleChanceBoosterModifierType</a></li><li><a href="modifier_modifier_type.TempBattleStatBoosterModifierType.html" class="tsd-signature-type tsd-kind-class">TempBattleStatBoosterModifierType</a></li><li><a href="modifier_modifier_type.AllPokemonLevelIncrementModifierType.html" class="tsd-signature-type tsd-kind-class">AllPokemonLevelIncrementModifierType</a></li><li><a href="modifier_modifier_type.MoneyRewardModifierType.html" class="tsd-signature-type tsd-kind-class">MoneyRewardModifierType</a></li><li><a href="modifier_modifier_type.ExpBoosterModifierType.html" class="tsd-signature-type tsd-kind-class">ExpBoosterModifierType</a></li><li><a href="modifier_modifier_type.EnemyAttackStatusEffectChanceModifierType.html" class="tsd-signature-type tsd-kind-class">EnemyAttackStatusEffectChanceModifierType</a></li><li><a href="modifier_modifier_type.EnemyEndureChanceModifierType.html" class="tsd-signature-type tsd-kind-class">EnemyEndureChanceModifierType</a></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/d04010226d8d02f1c288abafc33da45b149c90de/src/modifier/modifier-type.ts#
2024-05-31 14:57:14 +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_type.ModifierType.html#generatorId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>generator<wbr/>Id</span></a>
<a href="modifier_modifier_type.ModifierType.html#group" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>group</span></a>
<a href="modifier_modifier_type.ModifierType.html#iconImage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>icon<wbr/>Image</span></a>
<a href="modifier_modifier_type.ModifierType.html#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a>
<a href="modifier_modifier_type.ModifierType.html#localeKey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>locale<wbr/>Key</span></a>
<a href="modifier_modifier_type.ModifierType.html#newModifierFunc" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>new<wbr/>Modifier<wbr/>Func</span></a>
<a href="modifier_modifier_type.ModifierType.html#soundName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sound<wbr/>Name</span></a>
<a href="modifier_modifier_type.ModifierType.html#tier" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tier</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="modifier_modifier_type.ModifierType.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>name</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_type.ModifierType.html#getDescription" 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/>Description</span></a>
<a href="modifier_modifier_type.ModifierType.html#getOrInferTier" 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/>Or<wbr/>Infer<wbr/>Tier</span></a>
<a href="modifier_modifier_type.ModifierType.html#newModifier" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>new<wbr/>Modifier</span></a>
<a href="modifier_modifier_type.ModifierType.html#setTier" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Tier</span></a>
<a href="modifier_modifier_type.ModifierType.html#withIdFromFunc" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Id<wbr/>From<wbr/>Func</span></a>
2024-06-04 23:00:48 +01:00
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><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_ModifierType" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Modifier<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">localeKey</span>, <span class="tsd-kind-parameter">iconImage</span>, <span class="tsd-kind-parameter">newModifierFunc</span>, <span class="tsd-kind-parameter">group</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">soundName</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="modifier_modifier_type.ModifierType.html" class="tsd-signature-type tsd-kind-class">ModifierType</a><a href="#constructor.new_ModifierType" 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">localeKey</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">iconImage</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">newModifierFunc</span>: <span class="tsd-signature-type">NewModifierFunc</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">group</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">soundName</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="modifier_modifier_type.ModifierType.html" class="tsd-signature-type tsd-kind-class">ModifierType</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/d04010226d8d02f1c288abafc33da45b149c90de/src/modifier/modifier-type.ts#L52">src/modifier/modifier-type.ts:52</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="generatorId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>generator<wbr/>Id</span><a href="#generatorId" 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">generator<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/d04010226d8d02f1c288abafc33da45b149c90de/src/modifier/modifier-type.ts#L44">src/modifier/modifier-type.ts:44</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="group" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>group</span><a href="#group" 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">group</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/d04010226d8d02f1c288abafc33da45b149c90de/src/modifier/modifier-type.ts#L47">src/modifier/modifier-ty