pokerogue/main/classes/data_arena_tag.WeakenMoveSc...

26 lines
32 KiB
HTML
Raw Normal View History

2024-06-22 15:10:33 +01:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WeakenMoveScreenTag | 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_arena_tag.html">data/arena-tag</a></li><li><a href="data_arena_tag.WeakenMoveScreenTag.html">WeakenMoveScreenTag</a></li></ul><h1>Class WeakenMoveScreenTag</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Reduces the damage of specific move categories in the arena.</p>
2024-06-23 17:02:44 +01:00
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#data/arena-tag.WeakenMoveScreenTag">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="data_arena_tag.ArenaTag.html" class="tsd-signature-type tsd-kind-class">ArenaTag</a><ul class="tsd-hierarchy"><li><span class="target">WeakenMoveScreenTag</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/baac90120fbe2c99bf396ce4bb8bedf3503ac293/src/data/arena-tag.ts#L97">src/data/arena-tag.ts:97</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-index-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="data_arena_tag.WeakenMoveScreenTag.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-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="data_arena_tag.WeakenMoveScreenTag.html#side" 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>side</span></a>
<a href="data_arena_tag.WeakenMoveScreenTag.html#sourceId" 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>source<wbr/>Id</span></a>
<a href="data_arena_tag.WeakenMoveScreenTag.html#sourceMove" 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>source<wbr/>Move</span></a>
<a href="data_arena_tag.WeakenMoveScreenTag.html#tagType" 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>tag<wbr/>Type</span></a>
<a href="data_arena_tag.WeakenMoveScreenTag.html#turnCount" 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>turn<wbr/>Count</span></a>
2024-06-22 15:10:33 +01:00
<a href="data_arena_tag.WeakenMoveScreenTag.html#weakenedCategories" 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>weakened<wbr/>Categories</span></a>
2024-05-31 14:57:14 +01:00
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="data_arena_tag.WeakenMoveScreenTag.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="data_arena_tag.WeakenMoveScreenTag.html#getMoveName" 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/>Move<wbr/>Name</span></a>
<a href="data_arena_tag.WeakenMoveScreenTag.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="data_arena_tag.WeakenMoveScreenTag.html#onAdd" 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>on<wbr/>Add</span></a>
<a href="data_arena_tag.WeakenMoveScreenTag.html#onOverlap" 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>on<wbr/>Overlap</span></a>
<a href="data_arena_tag.WeakenMoveScreenTag.html#onRemove" 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>on<wbr/>Remove</span></a>
2024-06-22 15:10:33 +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_WeakenMoveScreenTag" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Weaken<wbr/>Move<wbr/>Screen<wbr/>Tag</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tagType</span>, <span class="tsd-kind-parameter">turnCount</span>, <span class="tsd-kind-parameter">sourceMove</span>, <span class="tsd-kind-parameter">sourceId</span>, <span class="tsd-kind-parameter">side</span>, <span class="tsd-kind-parameter">weakenedCategories</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_arena_tag.WeakenMoveScreenTag.html" class="tsd-signature-type tsd-kind-class">WeakenMoveScreenTag</a><a href="#constructor.new_WeakenMoveScreenTag" 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>Creates a new instance of the WeakenMoveScreenTag class.</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">tagType</span>: <a href="../enums/enums_arena_tag_type.ArenaTagType.html" class="tsd-signature-type tsd-kind-enum">ArenaTagType</a></span><div class="tsd-comment tsd-typography"><p>The type of the arena tag.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">turnCount</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The number of turns the tag is active.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">sourceMove</span>: <a href="../enums/enums_moves.Moves.html" class="tsd-signature-type tsd-kind-enum">Moves</a></span><div class="tsd-comment tsd-typography"><p>The move that created the tag.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">sourceId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The ID of the source of the tag.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">side</span>: <a href="../enums/data_arena_tag.ArenaTagSide.html" class="tsd-signature-type tsd-kind-enum">ArenaTagSide</a></span><div class="tsd-comment tsd-typography"><p>The side (player or enemy) the tag affects.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">weakenedCategories</span>: <a href="../enums/data_move.MoveCategory.html" class="tsd-signature-type tsd-kind-enum">MoveCategory</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The categories of moves that are weakened by this tag.</p>
2024-06-23 17:02:44 +01:00
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_arena_tag.WeakenMoveScreenTag.html" class="tsd-signature-type tsd-kind-class">WeakenMoveScreenTag</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="data_arena_tag.ArenaTag.html">ArenaTag</a>.<a href="data_arena_tag.ArenaTag.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/baac90120fbe2c99bf396ce4bb8bedf3503ac293/src/data/arena-tag.ts#L110">src/data/arena-tag.ts:110</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 tsd-is-inherited"><a id="side" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>side</span><a href="#side" 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">side</span><span class="tsd-signature-symbol">:</span> <a href="../enums/data_arena_tag.ArenaTagSide.html" class="tsd-signature-type tsd-kind-enum">ArenaTagSide</a></div><aside class="tsd-sources"><p>Inherited from <a href="data_arena_tag.ArenaTag.html">ArenaTag</a>.<a href="data_arena_tag.ArenaTag.html#side">side</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/baac90120fbe2c99bf396ce4bb8bedf3503ac293/src/data/arena-tag.ts#L30">src/data/arena-tag.ts:30</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="sourceId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>source<wbr/>Id</span><a href="#sourceId" 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">source<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="data_arena_tag.ArenaTag.html">ArenaTag</a>.<a href="data_arena_tag.ArenaTag.html#sourceId">sourceId</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/baac90120fbe2c99bf396ce4bb8bedf3503ac293/src/data/arena-tag.ts#L29">src/data/arena-tag.ts:29</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="sourceMove" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>source<wbr/>Move</span><a href="#sourceMove" 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">source<wbr/>Move</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_moves.Moves.html" class="tsd-signature-type tsd-kind-enum">Moves</a></div><aside class="tsd-sources"><p>Inherited from <a href="data_arena_tag.ArenaTag.html">ArenaTag</a>.<a href="data_arena_tag.ArenaTag.html#sourceMove">sourceMove</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/baac90120fbe2c99bf396ce4bb8bedf3503ac293/src/data/arena-tag.ts#L28">src/data/arena-tag.ts:28</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="tagType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>tag<wbr/>Type</span><a href="#tagType" 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">tag<wbr/>Type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/enums_arena_tag_type.ArenaTagType.html" class="tsd-signature-type tsd-kind-enum">ArenaTagType</a></div><aside class="tsd-sources"><p>Inherited from <a href="data_arena_tag.ArenaTag.html">ArenaTag</a>.<a href="data_arena_tag.ArenaTag.html#tagType">tagType</a></p><ul><li>Defined in <a href="https://github
2024-06-22 15:10:33 +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">arena</span>: <a href="field_arena.Arena.html" class="tsd-signature-type tsd-kind-class">Arena</a></span><div class="tsd-comment tsd-typography"><p>The arena where the move is applied.</p>
</div><div class="tsd-comment tsd-typography"></div></li><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>The arguments for the move application.</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 move was weakened, otherwise false.</p>
2024-06-23 17:02:44 +01:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="data_arena_tag.ArenaTag.html">ArenaTag</a>.<a href="data_arena_tag.ArenaTag.html#apply">apply</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/baac90120fbe2c99bf396ce4bb8bedf3503ac293/src/data/arena-tag.ts#L127">src/data/arena-tag.ts:127</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getMoveName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Move<wbr/>Name</span><a href="#getMoveName" 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="getMoveName.getMoveName-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Move<wbr/>Name</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><a href="#getMoveName.getMoveName-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">string</span></h4><aside class="tsd-sources"><p>Inherited from <a href="data_arena_tag.ArenaTag.html">ArenaTag</a>.<a href="data_arena_tag.ArenaTag.html#getMoveName">getMoveName</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/baac90120fbe2c99bf396ce4bb8bedf3503ac293/src/data/arena-tag.ts#L59">src/data/arena-tag.ts:59</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="lapse" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>lapse</span><a href="#lapse" 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="lapse.lapse-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">lapse</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">arena</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#lapse.lapse-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><span class="tsd-kind-parameter">arena</span>: <a href="field_arena.Arena.html" class="tsd-signature-type tsd-kind-class">Arena</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><p>Inherited from <a href="data_arena_tag.ArenaTag.html">ArenaTag</a>.<a href="data_arena_tag.ArenaTag.html#lapse">lapse</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/baac90120fbe2c99bf396ce4bb8bedf3503ac293/src/data/arena-tag.ts#L55">src/data/arena-tag.ts:55</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="onAdd" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>on<wbr/>Add</span><a href="#onAdd" 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="onAdd.onAdd-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">on<wbr/>Add</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">arena</span>, <span class="tsd-kind-parameter">quiet</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol