pokerogue/main/enums/data_challenge.ChallengeTyp...

21 lines
14 KiB
HTML
Raw Normal View History

2024-06-08 06:08:50 +01:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ChallengeType | 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_challenge.html">data/challenge</a></li><li><a href="data_challenge.ChallengeType.html">ChallengeType</a></li></ul><h1>Enumeration ChallengeType</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>An enum for all the challenge types. The parameter entries on these describe the
parameters to use when calling the applyChallenges function.</p>
2024-06-23 16:51:19 +01:00
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/326ae013fe9ed6d7369b92abb8305d4a404452fd/src/data/challenge.ts#L21">src/data/challenge.ts:21</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">Enumeration Members</h3><div class="tsd-index-list"><a href="data_challenge.ChallengeType.html#FIXED_BATTLES" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>FIXED_<wbr/>BATTLES</span></a>
2024-06-08 06:08:50 +01:00
<a href="data_challenge.ChallengeType.html#POKEMON_IN_BATTLE" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>POKEMON_<wbr/>IN_<wbr/>BATTLE</span></a>
<a href="data_challenge.ChallengeType.html#STARTER_CHOICE" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>STARTER_<wbr/>CHOICE</span></a>
<a href="data_challenge.ChallengeType.html#STARTER_MODIFY" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>STARTER_<wbr/>MODIFY</span></a>
<a href="data_challenge.ChallengeType.html#STARTER_POINTS" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>STARTER_<wbr/>POINTS</span></a>
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="FIXED_BATTLES" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>FIXED_<wbr/>BATTLES</span><a href="#FIXED_BATTLES" 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-enum-member">FIXED_<wbr/>BATTLES</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">4</span></div><div class="tsd-comment tsd-typography"><p>Adds or modifies the fixed battles in a run</p>
</div><div class="tsd-comment tsd-typography"><h4>Param: args</h4><p>[0] integer The wave to get a battle for
[1] <a href="../classes/battle.FixedBattleConfig.html" class="tsd-kind-class">FixedBattleConfig</a> A new fixed battle. It&#39;ll be modified if a battle exists.</p>
2024-06-23 16:51:19 +01:00
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/326ae013fe9ed6d7369b92abb8305d4a404452fd/src/data/challenge.ts#L49">src/data/challenge.ts:49</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="POKEMON_IN_BATTLE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>POKEMON_<wbr/>IN_<wbr/>BATTLE</span><a href="#POKEMON_IN_BATTLE" 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-enum-member">POKEMON_<wbr/>IN_<wbr/>BATTLE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">3</span></div><div class="tsd-comment tsd-typography"><p>Challenges which limit which pokemon you can have in battle.</p>
2024-06-08 06:08:50 +01:00
</div><div class="tsd-comment tsd-typography"><h4>Param: args</h4><p>[0] <a href="../classes/field_pokemon.default.html" class="tsd-kind-class">Pokemon</a> The pokemon to check
[1] <a href="../classes/utils.BooleanHolder.html" class="tsd-kind-class">Utils.BooleanHolder</a> Sets to false if illegal, pass in true.</p>
2024-06-23 16:51:19 +01:00
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/326ae013fe9ed6d7369b92abb8305d4a404452fd/src/data/challenge.ts#L43">src/data/challenge.ts:43</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="STARTER_CHOICE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>STARTER_<wbr/>CHOICE</span><a href="#STARTER_CHOICE" 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-enum-member">STARTER_<wbr/>CHOICE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">0</span></div><div class="tsd-comment tsd-typography"><p>Challenges which modify what starters you can choose</p>
2024-06-08 06:08:50 +01:00
</div><div class="tsd-comment tsd-typography"><h4>Param: args</h4><p>[0] <a href="../classes/data_pokemon_species.default.html" class="tsd-kind-class">PokemonSpecies</a> The species to check
[1] <a href="../classes/utils.BooleanHolder.html" class="tsd-kind-class">Utils.BooleanHolder</a> Sets to false if illegal, pass in true.</p>
2024-06-23 16:51:19 +01:00
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/326ae013fe9ed6d7369b92abb8305d4a404452fd/src/data/challenge.ts#L27">src/data/challenge.ts:27</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="STARTER_MODIFY" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>STARTER_<wbr/>MODIFY</span><a href="#STARTER_MODIFY" 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-enum-member">STARTER_<wbr/>MODIFY</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">2</span></div><div class="tsd-comment tsd-typography"><p>Challenges which modify your starters in some way
2024-06-08 06:08:50 +01:00
Not Fully Implemented</p>
2024-06-23 16:51:19 +01:00
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/326ae013fe9ed6d7369b92abb8305d4a404452fd/src/data/challenge.ts#L37">src/data/challenge.ts:37</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="STARTER_POINTS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>STARTER_<wbr/>POINTS</span><a href="#STARTER_POINTS" 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-enum-member">STARTER_<wbr/>POINTS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span></div><div class="tsd-comment tsd-typography"><p>Challenges which modify how many starter points you have</p>
2024-06-08 06:08:50 +01:00
</div><div class="tsd-comment tsd-typography"><h4>Param: args</h4><p>[0] <a href="../classes/utils.NumberHolder.html" class="tsd-kind-class">Utils.NumberHolder</a> The amount of starter points you have</p>
2024-06-23 16:51:19 +01:00
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/326ae013fe9ed6d7369b92abb8305d4a404452fd/src/data/challenge.ts#L32">src/data/challenge.ts:32</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-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"><h4 class="uppercase">Member Visibility</h4><form><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-private" name="private"/><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>Private</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></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><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-index-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"><a href="#FIXED_BATTLES" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>FIXED_<wbr/>BATTLES</span></a><a href="#POKEMON_IN_BATTLE" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>POKEMON_<wbr/>IN_<wbr/>BATTLE</span></a><a href="#STARTER_CHOICE" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>STARTER_<wbr/>CHOICE</span></a><a href="#STARTER_MODIFY" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>STARTER_<wbr/>MODIFY</span></a><a href="#STARTER_POINTS" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>STARTER_<wbr/>POINTS</span></a></div></deta