pokerogue/beta/variables/src_enums_hit-check-result.HitCheckResult.html
2025-09-23 13:50:32 +00:00

12 lines
11 KiB
HTML
Raw Permalink 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" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>HitCheckResult | PokéRogue</title><link rel="icon" href="../assets/favicon.ico"/><meta name="description" content="Documentation for PokéRogue"/><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script><link rel="stylesheet" href="../assets/typedoc-github-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">PokéRogue</a><div id="tsd-toolbar-links"><a href="https://github.com/pagefaultgames/pokerogue">GitHub</a><a href="https://pagefaultgames.github.io/pokerogue/main">Switch to Main</a></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/src_enums_hit-check-result.html">src/enums/hit-check-result</a></li><li><a href="" aria-current="page">HitCheckResult</a></li></ul><h1>Variable HitCheckResult<code class="tsd-tag">Const</code></h1></div><div class="tsd-signature"><span class="tsd-kind-variable">HitCheckResult</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>    <span class="tsd-kind-property">ERROR</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">8</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">HIT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">MISS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">5</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">NO_EFFECT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">2</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">NO_EFFECT_NO_MESSAGE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">3</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">PENDING</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">0</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">PROTECTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">4</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">REFLECTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">6</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">TARGET_NOT_ON_FIELD</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">7</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>The result of a hit check calculation</p>
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5 id="error"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">ERROR</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">8</span></h5><div class="tsd-comment tsd-typography"><p>The move failed unexpectedly</p>
</div></li><li class="tsd-parameter"><h5 id="hit"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">HIT</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">1</span></h5><div class="tsd-comment tsd-typography"><p>The move hits the target successfully</p>
</div></li><li class="tsd-parameter"><h5 id="miss"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">MISS</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">5</span></h5><div class="tsd-comment tsd-typography"><p>The move missed the target</p>
</div></li><li class="tsd-parameter"><h5 id="no_effect"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">NO_EFFECT</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">2</span></h5><div class="tsd-comment tsd-typography"><p>The move has no effect on the target</p>
</div></li><li class="tsd-parameter"><h5 id="no_effect_no_message"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">NO_EFFECT_NO_MESSAGE</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">3</span></h5><div class="tsd-comment tsd-typography"><p>The move has no effect on the target, but doesn't proc the default &quot;no effect&quot; message</p>
</div></li><li class="tsd-parameter"><h5 id="pending"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">PENDING</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">0</span></h5><div class="tsd-comment tsd-typography"><p>Hit checks haven't been evaluated yet in this pass</p>
</div></li><li class="tsd-parameter"><h5 id="protected"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">PROTECTED</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">4</span></h5><div class="tsd-comment tsd-typography"><p>The target protected itself against the move</p>
</div></li><li class="tsd-parameter"><h5 id="reflected"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">REFLECTED</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">6</span></h5><div class="tsd-comment tsd-typography"><p>The move is reflected by magic coat or magic bounce</p>
</div></li><li class="tsd-parameter"><h5 id="target_not_on_field"><code class="tsd-tag">Readonly</code><span class="tsd-kind-property">TARGET_NOT_ON_FIELD</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">7</span></h5><div class="tsd-comment tsd-typography"><p>The target is no longer on the field</p>
</div></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/6766940fa15202c9995f2fed7287bf85939d9816/src/enums/hit-check-result.ts#L4">src/enums/hit-check-result.ts:4</a></li><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/6766940fa15202c9995f2fed7287bf85939d9816/src/enums/hit-check-result.ts#L25">src/enums/hit-check-result.ts:25</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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-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></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></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://github.com/pagefaultgames/pokerogue" class="tsd-nav-link">GitHub</a><a href="https://pagefaultgames.github.io/pokerogue/main" class="tsd-nav-link">Switch to Main</a></nav><nav class="tsd-navigation"><a href="../modules.html">PokéRogue</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a> with <a href="https://github.com/JulianWowra/typedoc-github-theme" target="_blank">typedoc-github-theme</a></p><p>Copyright <strong>Pagefault Games</strong> 2025</p></footer><div class="overlay"></div></body></html>