random-mirrors/pokerogue
1
0
Fork 0
mirror of https://github.com/pagefaultgames/pokerogue.git synced 2024-11-26 08:46:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
268ad29597
pokerogue/main/classes/data_battle_anims.CommonBattleAnim.html
github-actions[bot] 268ad29597 [skip ci] Deploy docs
2024-10-27 04:06:25 +00:00

24 lines
34 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>CommonBattleAnim | 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_battle_anims.html">data/battle-anims</a></li><li><a href="data_battle_anims.CommonBattleAnim.html">CommonBattleAnim</a></li></ul><h1>Class CommonBattleAnim</h1></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a href="../hierarchy.html#data/battle-anims.CommonBattleAnim">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="data_battle_anims.BattleAnim.html" class="tsd-signature-type tsd-kind-class">BattleAnim</a><ul class="tsd-hierarchy"><li><span class="target">CommonBattleAnim</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/data/battle-anims.ts#L1262">src/data/battle-anims.ts:1262</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="data_battle_anims.CommonBattleAnim.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>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="data_battle_anims.CommonBattleAnim.html#bgSprite" 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>bg<wbr/>Sprite</span></a>
<a href="data_battle_anims.CommonBattleAnim.html#commonAnim" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>common<wbr/>Anim</span></a>
<a href="data_battle_anims.CommonBattleAnim.html#playRegardlessOfIssues" 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>play<wbr/>Regardless<wbr/>Of<wbr/>Issues</span></a>
<a href="data_battle_anims.CommonBattleAnim.html#sprites" 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>sprites</span></a>
<a href="data_battle_anims.CommonBattleAnim.html#target" 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>target</span></a>
<a href="data_battle_anims.CommonBattleAnim.html#user" 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>user</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="data_battle_anims.CommonBattleAnim.html#getAnim" 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/>Anim</span></a>
<a href="data_battle_anims.CommonBattleAnim.html#isHideTarget" class="tsd-index-link tsd-is-protected 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/>Hide<wbr/>Target</span></a>
<a href="data_battle_anims.CommonBattleAnim.html#isHideUser" class="tsd-index-link tsd-is-protected 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/>Hide<wbr/>User</span></a>
<a href="data_battle_anims.CommonBattleAnim.html#isOppAnim" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Opp<wbr/>Anim</span></a>
<a href="data_battle_anims.CommonBattleAnim.html#play" 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>play</span></a>
<a href="data_battle_anims.CommonBattleAnim.html#playWithoutTargets" 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>play<wbr/>Without<wbr/>Targets</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-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_CommonBattleAnim" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Common<wbr/>Battle<wbr/>Anim</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">commonAnim</span>, <span class="tsd-kind-parameter">user</span>, <span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">playOnEmptyField</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_battle_anims.CommonBattleAnim.html" class="tsd-signature-type tsd-kind-class">CommonBattleAnim</a><a href="#constructor.new_CommonBattleAnim" 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">commonAnim</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../enums/data_battle_anims.CommonAnim.html" class="tsd-signature-type tsd-kind-enum">CommonAnim</a></span></li><li><span><span class="tsd-kind-parameter">user</span>: <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">target</span>: <a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li><li><span><span class="tsd-kind-parameter">playOnEmptyField</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="data_battle_anims.CommonBattleAnim.html" class="tsd-signature-type tsd-kind-class">CommonBattleAnim</a></h4><aside class="tsd-sources"><p>Overrides <a href="data_battle_anims.BattleAnim.html">BattleAnim</a>.<a href="data_battle_anims.BattleAnim.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/data/battle-anims.ts#L1265">src/data/battle-anims.ts:1265</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="bgSprite" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>bg<wbr/>Sprite</span><a href="#bgSprite" 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">bg<wbr/>Sprite</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TileSprite</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Rectangle</span></div><aside class="tsd-sources"><p>Inherited from <a href="data_battle_anims.BattleAnim.html">BattleAnim</a>.<a href="data_battle_anims.BattleAnim.html#bgSprite">bgSprite</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/data/battle-anims.ts#L750">src/data/battle-anims.ts:750</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="commonAnim" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>common<wbr/>Anim</span><a href="#commonAnim" 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">common<wbr/>Anim</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../enums/data_battle_anims.CommonAnim.html" class="tsd-signature-type tsd-kind-enum">CommonAnim</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/data/battle-anims.ts#L1263">src/data/battle-anims.ts:1263</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="playRegardlessOfIssues" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>play<wbr/>Regardless<wbr/>Of<wbr/>Issues</span><a href="#playRegardlessOfIssues" 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">play<wbr/>Regardless<wbr/>Of<wbr/>Issues</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Will attempt to play as much of an animation as possible, even if not all targets are on the field.
Will also play the animation, even if the user has selected &quot;Move Animations&quot; OFF in Settings.
Exclusively used by MEs atm, for visual animations at the start of an encounter.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="data_battle_anims.BattleAnim.html">BattleAnim</a>.<a href="data_battle_anims.BattleAnim.html#playRegardlessOfIssues">playRegardlessOfIssues</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/data/battle-anims.ts#L756">src/data/battle-anims.ts:756</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="sprites" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>sprites</span><a href="#sprites" 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">sprites</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Sprite</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from <a href="data_battle_anims.BattleAnim.html">BattleAnim</a>.<a href="data_battle_anims.BattleAnim.html#sprites">sprites</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/data/battle-anims.ts#L749">src/data/battle-anims.ts:749</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="target" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>target</span><a href="#target" 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">target</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></div><aside class="tsd-sources"><p>Inherited from <a href="data_battle_anims.BattleAnim.html">BattleAnim</a>.<a href="data_battle_anims.BattleAnim.html#target">target</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/data/battle-anims.ts#L748">src/data/battle-anims.ts:748</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="user" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>user</span><a href="#user" 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">user</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="field_pokemon.default.html" class="tsd-signature-type tsd-kind-class">default</a></div><aside class="tsd-sources"><p>Inherited from <a href="data_battle_anims.BattleAnim.html">BattleAnim</a>.<a href="data_battle_anims.BattleAnim.html#user">user</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/data/battle-anims.ts#L747">src/data/battle-anims.ts:747</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="getAnim" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Anim</span><a href="#getAnim" 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="getAnim.getAnim-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Anim</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="data_battle_anims.AnimConfig.html" class="tsd-signature-type tsd-kind-class">AnimConfig</a><a href="#getAnim.getAnim-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">null</span><span class="tsd-signature-symbol"> | </span><a href="data_battle_anims.AnimConfig.html" class="tsd-signature-type tsd-kind-class">AnimConfig</a></h4><aside class="tsd-sources"><p>Overrides <a href="data_battle_anims.BattleAnim.html">BattleAnim</a>.<a href="data_battle_anims.BattleAnim.html#getAnim">getAnim</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/data/battle-anims.ts#L1271">src/data/battle-anims.ts:1271</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="isHideTarget" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>is<wbr/>Hide<wbr/>Target</span><a href="#isHideTarget" 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-protected tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="isHideTarget.isHideTarget-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Hide<wbr/>Target</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isHideTarget.isHideTarget-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">boolean</span></h4><aside class="tsd-sources"><p>Inherited from <a href="data_battle_anims.BattleAnim.html">BattleAnim</a>.<a href="data_battle_anims.BattleAnim.html#isHideTarget">isHideTarget</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/data/battle-anims.ts#L776">src/data/battle-anims.ts:776</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="isHideUser" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Protected</code><span>is<wbr/>Hide<wbr/>User</span><a href="#isHideUser" 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-protected tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="isHideUser.isHideUser-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Hide<wbr/>User</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isHideUser.isHideUser-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">boolean</span></h4><aside class="tsd-sources"><p>Inherited from <a href="data_battle_anims.BattleAnim.html">BattleAnim</a>.<a href="data_battle_anims.BattleAnim.html#isHideUser">isHideUser</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/data/battle-anims.ts#L772">src/data/battle-anims.ts:772</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isOppAnim" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Opp<wbr/>Anim</span><a href="#isOppAnim" 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="isOppAnim.isOppAnim-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Opp<wbr/>Anim</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isOppAnim.isOppAnim-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">boolean</span></h4><aside class="tsd-sources"><p>Overrides <a href="data_battle_anims.BattleAnim.html">BattleAnim</a>.<a href="data_battle_anims.BattleAnim.html#isOppAnim">isOppAnim</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/data/battle-anims.ts#L1275">src/data/battle-anims.ts:1275</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="play" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>play</span><a href="#play" 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="play.play-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">play</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span>, <span class="tsd-kind-parameter">onSubstitute</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#play.play-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">scene</span>: <a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">onSubstitute</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-type">Function</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from <a href="data_battle_anims.BattleAnim.html">BattleAnim</a>.<a href="data_battle_anims.BattleAnim.html#play">play</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/data/battle-anims.ts#L837">src/data/battle-anims.ts:837</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="playWithoutTargets" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>play<wbr/>Without<wbr/>Targets</span><a href="#playWithoutTargets" 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="playWithoutTargets.playWithoutTargets-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">play<wbr/>Without<wbr/>Targets</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span>, <span class="tsd-kind-parameter">targetInitialX</span>, <span class="tsd-kind-parameter">targetInitialY</span>, <span class="tsd-kind-parameter">frameTimeMult</span>, <span class="tsd-kind-parameter">frameTimedEventPriority</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#playWithoutTargets.playWithoutTargets-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">scene</span>: <a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">targetInitialX</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">targetInitialY</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">frameTimeMult</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">frameTimedEventPriority</span>: <br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">0</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">1</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">3</span><br/><span>    </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">5</span></span><div class="tsd-comment tsd-typography"><p>0 is behind all other sprites (except BG)</p>
<ul>
<li>1 on top of player field</li>
<li>3 is on top of both fields</li>
<li>5 is on top of player sprite</li>
</ul>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-type">Function</span></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="data_battle_anims.BattleAnim.html">BattleAnim</a>.<a href="data_battle_anims.BattleAnim.html#playWithoutTargets">playWithoutTargets</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dfb42e44a695040c2a7ae9b76e8564572ed89c0d/src/data/battle-anims.ts#L1137">src/data/battle-anims.ts:1137</a></li></ul></aside></li></ul></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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></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="#bgSprite" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bg<wbr/>Sprite</span></a><a href="#commonAnim" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>common<wbr/>Anim</span></a><a href="#playRegardlessOfIssues" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>play<wbr/>Regardless<wbr/>Of<wbr/>Issues</span></a><a href="#sprites" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sprites</span></a><a href="#target" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>target</span></a><a href="#user" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>user</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#getAnim" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Anim</span></a><a href="#isHideTarget" class="tsd-is-protected 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/>Hide<wbr/>Target</span></a><a href="#isHideUser" class="tsd-is-protected 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/>Hide<wbr/>User</span></a><a href="#isOppAnim" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Opp<wbr/>Anim</span></a><a href="#play" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>play</span></a><a href="#playWithoutTargets" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>play<wbr/>Without<wbr/>Targets</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>
Reference in New Issue View Git Blame Copy Permalink