2024-09-10 22:07:25 +00:00
|
|
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>utils | 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="utils.html">utils</a></li></ul><h1>Module utils</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/4808c07cf9e92714e4b7c0ba77a6b5e96fbe9c34/src/utils.ts#L1">src/utils.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/utils.BooleanHolder.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Boolean<wbr/>Holder</span></a>
|
2024-05-31 13:57:14 +00:00
|
|
|
<a href="../classes/utils.FixedInt.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Fixed<wbr/>Int</span></a>
|
|
|
|
|
<a href="../classes/utils.IntegerHolder.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Integer<wbr/>Holder</span></a>
|
|
|
|
|
<a href="../classes/utils.NumberHolder.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Number<wbr/>Holder</span></a>
|
2024-06-19 16:01:41 +00:00
|
|
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Type Aliases</h3><div class="tsd-index-list"><a href="../types/utils.Constructor.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Constructor</span></a>
|
2024-05-31 13:57:14 +00:00
|
|
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Variables</h3><div class="tsd-index-list"><a href="../variables/utils.MissingTextureKey.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>Missing<wbr/>Texture<wbr/>Key</span></a>
|
|
|
|
|
<a href="../variables/utils.apiUrl.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>api<wbr/>Url</span></a>
|
2024-07-27 23:48:18 +00:00
|
|
|
<a href="../variables/utils.isBeta.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>is<wbr/>Beta</span></a>
|
2024-05-31 13:57:14 +00:00
|
|
|
<a href="../variables/utils.isLocal.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>is<wbr/>Local</span></a>
|
2024-06-06 01:26:00 +00:00
|
|
|
<a href="../variables/utils.isLocalServerConnected.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>is<wbr/>Local<wbr/>Server<wbr/>Connected</span></a>
|
2024-06-07 20:44:39 +00:00
|
|
|
<a href="../variables/utils.localServerUrl.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>local<wbr/>Server<wbr/>Url</span></a>
|
2024-05-31 13:57:14 +00:00
|
|
|
<a href="../variables/utils.sessionIdKey.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>session<wbr/>Id<wbr/>Key</span></a>
|
|
|
|
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Functions</h3><div class="tsd-index-list"><a href="../functions/utils.apiFetch.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>api<wbr/>Fetch</span></a>
|
|
|
|
|
<a href="../functions/utils.apiPost.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>api<wbr/>Post</span></a>
|
2024-07-27 23:48:18 +00:00
|
|
|
<a href="../functions/utils.capitalizeString.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>capitalize<wbr/>String</span></a>
|
2024-05-31 13:57:14 +00:00
|
|
|
<a href="../functions/utils.clampInt.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>clamp<wbr/>Int</span></a>
|
2024-06-01 12:57:45 +00:00
|
|
|
<a href="../functions/utils.deepCopy.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>deep<wbr/>Copy</span></a>
|
2024-05-31 13:57:14 +00:00
|
|
|
<a href="../functions/utils.deltaRgb.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>delta<wbr/>Rgb</span></a>
|
|
|
|
|
<a href="../functions/utils.executeIf.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>execute<wbr/>If</span></a>
|
|
|
|
|
<a href="../functions/utils.fixedInt-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>fixed<wbr/>Int</span></a>
|
|
|
|
|
<a href="../functions/utils.formatFancyLargeNumber.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>format<wbr/>Fancy<wbr/>Large<wbr/>Number</span></a>
|
|
|
|
|
<a href="../functions/utils.formatLargeNumber.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>format<wbr/>Large<wbr/>Number</span></a>
|
2024-06-08 01:10:18 +00:00
|
|
|
<a href="../functions/utils.formatMoney.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>format<wbr/>Money</span></a>
|
2024-05-31 13:57:14 +00:00
|
|
|
<a href="../functions/utils.formatStat.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>format<wbr/>Stat</span></a>
|
2024-06-24 15:32:59 +00:00
|
|
|
<a href="../functions/utils.formatText.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>format<wbr/>Text</span></a>
|
2024-05-31 13:57:14 +00:00
|
|
|
<a href="../functions/utils.getCookie.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>get<wbr/>Cookie</span></a>
|
|
|
|
|
<a href="../functions/utils.getCurrentTime.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>get<wbr/>Current<wbr/>Time</span></a>
|
|
|
|
|
<a href="../functions/utils.getEnumKeys.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>get<wbr/>Enum<wbr/>Keys</span></a>
|
|
|
|
|
<a href="../functions/utils.getEnumValues.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>get<wbr/>Enum<wbr/>Values</span></a>
|
|
|
|
|
<a href="../functions/utils.getFrameMs.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>get<wbr/>Frame<wbr/>Ms</span></a>
|
|
|
|
|
<a href="../functions/utils.getIvsFromId.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>get<wbr/>Ivs<wbr/>From<wbr/>Id</span></a>
|
2024-09-01 22:17:02 +00:00
|
|
|
<a href="../functions/utils.getLocalizedSpriteKey.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>get<wbr/>Localized<wbr/>Sprite<wbr/>Key</span></a>
|
2024-05-31 13:57:14 +00:00
|
|
|
<a href="../functions/utils.getPlayTimeString.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>get<wbr/>Play<wbr/>Time<wbr/>String</span></a>
|
2024-09-10 22:07:25 +00:00
|
|
|
<a href="../functions/utils.hslToHex.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>hsl<wbr/>To<wbr/>Hex</span></a>
|
2024-08-19 00:07:09 +00:00
|
|
|
<a href="../functions/utils.isNullOrUndefined.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>is<wbr/>Null<wbr/>Or<wbr/>Undefined</span></a>
|
2024-06-06 01:26:00 +00:00
|
|
|
<a href="../functions/utils.localPing.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>local<wbr/>Ping</span></a>
|
2024-05-31 13:57:14 +00:00
|
|
|
<a href="../functions/utils.padInt.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>pad<wbr/>Int</span></a>
|
|
|
|
|
<a href="../functions/utils.printContainerList.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>print<wbr/>Container<wbr/>List</span></a>
|
|
|
|
|
<a href="../functions/utils.randGauss.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>rand<wbr/>Gauss</span></a>
|
|
|
|
|
<a href="../functions/utils.randInt.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>rand<wbr/>Int</span></a>
|
|
|
|
|
<a href="../functions/utils.randIntRange.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>rand<wbr/>Int<wbr/>Range</span></a>
|
|
|
|
|
<a href="../functions/utils.randItem.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>rand<wbr/>Item</span></a>
|
|
|
|
|
<a href="../functions/utils.randSeedEasedWeightedItem.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>rand<wbr/>Seed<wbr/>Eased<wbr/>Weighted<wbr/>Item</span></a>
|
|
|
|
|
<a href="../functions/utils.randSeedGauss.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>rand<wbr/>Seed<wbr/>Gauss</span></a>
|
|
|
|
|
<a href="../functions/utils.randSeedInt.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>rand<wbr/>Seed<wbr/>Int</span></a>
|
|
|
|
|
<a href="../functions/utils.randSeedItem.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>rand<wbr/>Seed<wbr/>Item</span></a>
|
2024-06-07 03:02:20 +00:00
|
|
|
<a href="../functions/utils.randSeedShuffle.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>rand<wbr/>Seed<wbr/>Shuffle</span></a>
|
2024-05-31 13:57:14 +00:00
|
|
|
<a href="../functions/utils.randSeedWeightedItem.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>rand<wbr/>Seed<wbr/>Weighted<wbr/>Item</span></a>
|
|
|
|
|
<a href="../functions/utils.randomString.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>random<wbr/>String</span></a>
|
2024-07-27 23:48:18 +00:00
|
|
|
<a href="../functions/utils.removeCookie.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>remove<wbr/>Cookie</span></a>
|
2024-06-01 12:57:45 +00:00
|
|
|
<a href="../functions/utils.reverseValueToKeySetting.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>reverse<wbr/>Value<wbr/>To<wbr/>Key<wbr/>Setting</span></a>
|
2024-05-31 13:57:14 +00:00
|
|
|
<a href="../functions/utils.rgbHexToRgba.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>rgb<wbr/>Hex<wbr/>To<wbr/>Rgba</span></a>
|
|
|
|
|
<a href="../functions/utils.rgbToHsv.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>rgb<wbr/>To<wbr/>Hsv</span></a>
|
|
|
|
|
<a href="../functions/utils.rgbaToInt.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>rgba<wbr/>To<wbr/>Int</span></a>
|
|
|
|
|
<a href="../functions/utils.setCookie.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>set<wbr/>Cookie</span></a>
|
|
|
|
|
<a href="../functions/utils.shiftCharCodes.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>shift<wbr/>Char<wbr/>Codes</span></a>
|
2024-07-27 23:48:18 +00:00
|
|
|
<a href="../functions/utils.toCamelCaseString.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>to<wbr/>Camel<wbr/>Case<wbr/>String</span></a>
|
2024-09-01 22:17:02 +00:00
|
|
|
<a href="../functions/utils.toDmgValue.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>to<wbr/>Dmg<wbr/>Value</span></a>
|
2024-05-31 13:57:14 +00:00
|
|
|
<a href="../functions/utils.toReadableString.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>to<wbr/>Readable<wbr/>String</span></a>
|
2024-06-01 12:57:45 +00:00
|
|
|
<a href="../functions/utils.truncateString.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>truncate<wbr/>String</span></a>
|
2024-05-31 13:57:14 +00:00
|
|
|
<a href="../functions/utils.verifyLang.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>verify<wbr/>Lang</span></a>
|
2024-07-27 23:48:18 +00:00
|
|
|
</div></section></section></section></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></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>
|
