pokerogue/main/classes/data_battler_tags.TruantTag...

19 lines
35 KiB
HTML
Raw Normal View History

2024-06-12 18:12:43 +01:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TruantTag | 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_battler_tags.html">data/battler-tags</a></li><li><a href="data_battler_tags.TruantTag.html">TruantTag</a></li></ul><h1>Class TruantTag</h1></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#data/battler-tags.TruantTag">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="data_battler_tags.AbilityBattlerTag.html" class="tsd-signature-type tsd-kind-class">AbilityBattlerTag</a><ul class="tsd-hierarchy"><li><span class="target">TruantTag</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ed495673f3f5eda023c5d27be7f0dabb54e5befd/src/data/battler-tags.ts#L1031">src/data/battler-tags.ts:1031</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_battler_tags.TruantTag.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_battler_tags.TruantTag.html#ability" 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>ability</span></a>
<a href="data_battler_tags.TruantTag.html#lapseType" 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>lapse<wbr/>Type</span></a>
<a href="data_battler_tags.TruantTag.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_battler_tags.TruantTag.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_battler_tags.TruantTag.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_battler_tags.TruantTag.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>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="data_battler_tags.TruantTag.html#canAdd" 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>can<wbr/>Add</span></a>
<a href="data_battler_tags.TruantTag.html#getDescriptor" 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/>Descriptor</span></a>
<a href="data_battler_tags.TruantTag.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_battler_tags.TruantTag.html#isSourceLinked" 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/>Source<wbr/>Linked</span></a>
<a href="data_battler_tags.TruantTag.html#lapse" class="tsd-index-link"><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_battler_tags.TruantTag.html#loadTag" 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>load<wbr/>Tag</span></a>
<a href="data_battler_tags.TruantTag.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_battler_tags.TruantTag.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_battler_tags.TruantTag.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-12 18:12:43 +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_TruantTag" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Truant<wbr/>Tag</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="data_battler_tags.TruantTag.html" class="tsd-signature-type tsd-kind-class">TruantTag</a><a href="#constructor.new_TruantTag" 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="data_battler_tags.TruantTag.html" class="tsd-signature-type tsd-kind-class">TruantTag</a></h4><aside class="tsd-sources"><p>Overrides <a href="data_battler_tags.AbilityBattlerTag.html">AbilityBattlerTag</a>.<a href="data_battler_tags.AbilityBattlerTag.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ed495673f3f5eda023c5d27be7f0dabb54e5befd/src/data/battler-tags.ts#L1032">src/data/battler-tags.ts:1032</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="ability" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>ability</span><a href="#ability" 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">ability</span><span class="tsd-signature-symbol">:</span> <a href="../enums/data_enums_abilities.Abilities.html" class="tsd-signature-type tsd-kind-enum">Abilities</a></div><aside class="tsd-sources"><p>Inherited from <a href="data_battler_tags.AbilityBattlerTag.html">AbilityBattlerTag</a>.<a href="data_battler_tags.AbilityBattlerTag.html#ability">ability</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ed495673f3f5eda023c5d27be7f0dabb54e5befd/src/data/battler-tags.ts#L1013">src/data/battler-tags.ts:1013</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="lapseType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>lapse<wbr/>Type</span><a href="#lapseType" 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">lapse<wbr/>Type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/data_battler_tags.BattlerTagLapseType.html" class="tsd-signature-type tsd-kind-enum">BattlerTagLapseType</a></div><aside class="tsd-sources"><p>Inherited from <a href="data_battler_tags.AbilityBattlerTag.html">AbilityBattlerTag</a>.<a href="data_battler_tags.AbilityBattlerTag.html#lapseType">lapseType</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ed495673f3f5eda023c5d27be7f0dabb54e5befd/src/data/battler-tags.ts#L33">src/data/battler-tags.ts:33</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"><code class="tsd-tag ts-flagOptional">Optional</code> <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-sign
2024-05-31 14:57:14 +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">source</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>A battler tag</p>
2024-06-12 18:12:43 +01:00
</div><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_battler_tags.AbilityBattlerTag.html">AbilityBattlerTag</a>.<a href="data_battler_tags.AbilityBattlerTag.html#loadTag">loadTag</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ed495673f3f5eda023c5d27be7f0dabb54e5befd/src/data/battler-tags.ts#L1025">src/data/battler-tags.ts:1025</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">pokemon</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#onAdd.onAdd-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">pokemon</span>: <a href="field_pokemon.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">void</span></h4><aside class="tsd-sources"><p>Inherited from <a href="data_battler_tags.AbilityBattlerTag.html">AbilityBattlerTag</a>.<a href="data_battler_tags.AbilityBattlerTag.html#onAdd">onAdd</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ed495673f3f5eda023c5d27be7f0dabb54e5befd/src/data/battler-tags.ts#L50">src/data/battler-tags.ts:50</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="onOverlap" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>on<wbr/>Overlap</span><a href="#onOverlap" 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="onOverlap.onOverlap-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">on<wbr/>Overlap</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pokemon</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#onOverlap.onOverlap-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">pokemon</span>: <a href="field_pokemon.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">void</span></h4><aside class="tsd-sources"><p>Inherited from <a href="data_battler_tags.AbilityBattlerTag.html">AbilityBattlerTag</a>.<a href="data_battler_tags.AbilityBattlerTag.html#onOverlap">onOverlap</a></p><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/ed495673f3f5eda023c5d27be7f0dabb54e5befd/src/data/battler-tags.ts#L54">src/data/battler-tags.ts:54</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="onRemove" class="tsd-anchor"></a><h3 class="t