pokerogue/main/classes/system_game_data.GameData.html

113 lines
151 KiB
HTML
Raw Normal View History

2024-11-18 02:09:28 +00:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>GameData | 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/system_game_data.html">system/game-data</a></li><li><a href="system_game_data.GameData.html">GameData</a></li></ul><h1>Class GameData</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L300">src/system/game-data.ts:300</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="system_game_data.GameData.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 13:57:14 +00:00
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="system_game_data.GameData.html#achvUnlocks" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>achv<wbr/>Unlocks</span></a>
<a href="system_game_data.GameData.html#dexData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dex<wbr/>Data</span></a>
2024-06-03 19:45:23 +00:00
<a href="system_game_data.GameData.html#eggPity" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>egg<wbr/>Pity</span></a>
2024-05-31 13:57:14 +00:00
<a href="system_game_data.GameData.html#eggs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>eggs</span></a>
<a href="system_game_data.GameData.html#gameStats" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>game<wbr/>Stats</span></a>
<a href="system_game_data.GameData.html#gender" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>gender</span></a>
2024-09-01 22:17:02 +00:00
<a href="system_game_data.GameData.html#runHistory" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>run<wbr/>History</span></a>
2024-05-31 13:57:14 +00:00
<a href="system_game_data.GameData.html#secretId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>secret<wbr/>Id</span></a>
<a href="system_game_data.GameData.html#starterData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>starter<wbr/>Data</span></a>
<a href="system_game_data.GameData.html#trainerId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>trainer<wbr/>Id</span></a>
2024-06-03 19:45:23 +00:00
<a href="system_game_data.GameData.html#unlockPity" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unlock<wbr/>Pity</span></a>
2024-05-31 13:57:14 +00:00
<a href="system_game_data.GameData.html#unlocks" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unlocks</span></a>
<a href="system_game_data.GameData.html#voucherCounts" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>voucher<wbr/>Counts</span></a>
<a href="system_game_data.GameData.html#voucherUnlocks" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>voucher<wbr/>Unlocks</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="system_game_data.GameData.html#addStarterCandy" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Starter<wbr/>Candy</span></a>
<a href="system_game_data.GameData.html#clearLocalData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Local<wbr/>Data</span></a>
<a href="system_game_data.GameData.html#consolidateDexData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>consolidate<wbr/>Dex<wbr/>Data</span></a>
2024-06-07 22:34:52 +00:00
<a href="system_game_data.GameData.html#convertSystemDataStr" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>convert<wbr/>System<wbr/>Data<wbr/>Str</span></a>
2024-05-31 13:57:14 +00:00
<a href="system_game_data.GameData.html#deleteSession" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Session</span></a>
<a href="system_game_data.GameData.html#getDexAttrLuck" 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/>Dex<wbr/>Attr<wbr/>Luck</span></a>
<a href="system_game_data.GameData.html#getFormAttr" 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/>Form<wbr/>Attr</span></a>
<a href="system_game_data.GameData.html#getFormIndex" 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/>Form<wbr/>Index</span></a>
<a href="system_game_data.GameData.html#getNaturesForAttr" 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/>Natures<wbr/>For<wbr/>Attr</span></a>
2024-09-01 22:17:02 +00:00
<a href="system_game_data.GameData.html#getRunHistoryData" 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/>Run<wbr/>History<wbr/>Data</span></a>
2024-06-03 10:50:22 +00:00
<a href="system_game_data.GameData.html#getSeenDialogues" 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/>Seen<wbr/>Dialogues</span></a>
2024-05-31 13:57:14 +00:00
<a href="system_game_data.GameData.html#getSession" 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/>Session</span></a>
2024-09-10 22:07:25 +00:00
<a href="system_game_data.GameData.html#getSessionSaveData" 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/>Session<wbr/>Save<wbr/>Data</span></a>
2024-05-31 13:57:14 +00:00
<a href="system_game_data.GameData.html#getSpeciesCount" 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/>Species<wbr/>Count</span></a>
<a href="system_game_data.GameData.html#getSpeciesDefaultDexAttr" 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/>Species<wbr/>Default<wbr/>Dex<wbr/>Attr</span></a>
<a href="system_game_data.GameData.html#getSpeciesDefaultNature" 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/>Species<wbr/>Default<wbr/>Nature</span></a>
<a href="system_game_data.GameData.html#getSpeciesDefaultNatureAttr" 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/>Species<wbr/>Default<wbr/>Nature<wbr/>Attr</span></a>
<a href="system_game_data.GameData.html#getSpeciesDexAttrProps" 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/>Species<wbr/>Dex<wbr/>Attr<wbr/>Props</span></a>
<a href="system_game_data.GameData.html#getSpeciesStarterValue" 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/>Species<wbr/>Starter<wbr/>Value</span></a>
<a href="system_game_data.GameData.html#getStarterCount" 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/>Starter<wbr/>Count</span></a>
<a href="system_game_data.GameData.html#getStarterSpeciesDefaultAbilityIndex" 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/>Starter<wbr/>Species<wbr/>Default<wbr/>Ability<wbr/>Index</span></a>
<a href="system_game_data.GameData.html#getSystemSaveData" 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/>System<wbr/>Save<wbr/>Data</span></a>
<a href="system_game_data.GameData.html#getTutorialFlags" 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/>Tutorial<wbr/>Flags</span></a>
<a href="system_game_data.GameData.html#importData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>import<wbr/>Data</span></a>
<a href="system_game_data.GameData.html#incrementRibbonCount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>increment<wbr/>Ribbon<wbr/>Count</span></a>
<a href="system_game_data.GameData.html#initSystem" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>init<wbr/>System</span></a>
2024-11-17 23:35:40 +00:00
<a href="system_game_data.GameData.html#isRootSpeciesUnlocked" 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/>Root<wbr/>Species<wbr/>Unlocked</span></a>
2024-09-27 21:52:07 +00:00
<a href="system_game_data.GameData.html#isUnlocked" 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/>Unlocked</span></a>
2024-06-01 12:57:45 +00:00
<a href="system_game_data.GameData.html#loadMappingConfigs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Mapping<wbr/>Configs</span></a>
2024-05-31 13:57:14 +00:00
<a href="system_game_data.GameData.html#loadSession" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>Session</span></a>
<a href="system_game_data.GameData.html#loadSystem" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load<wbr/>System</span></a>
<a href="system_game_data.GameData.html#migrateStarterAbilities" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>migrate<wbr/>Starter<wbr/>Abilities</span></a>
<a href="system_game_data.GameData.html#offlineNewClear" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>offline<wbr/>New<wbr/>Clear</span></a>
<a href="system_game_data.GameData.html#parseSessionData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>parse<wbr/>Session<wbr/>Data</span></a>
2024-06-07 22:34:52 +00:00
<a href="system_game_data.GameData.html#parseSystemData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>parse<wbr/>System<wbr/>Data</span></a>
2024-06-01 12:57:45 +00:00
<a href="system_game_data.GameData.html#resetMappingToFactory" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reset<wbr/>Mapping<wbr/>To<wbr/>Factory</span></a>
2024-05-31 13:57:14 +00:00
<a href="system_game_data.GameData.html#saveAll" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>save<wbr/>All</span></a>
2024-06-03 23:58:57 +00:00
<a href="system_game_data.GameData.html#saveControlSetting" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>save<wbr/>Control<wbr/>Setting</span></a>
2024-06-01 12:57:45 +00:00
<a href="system_game_data.GameData.html#saveMappingConfigs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>save<wbr/>Mapping<wbr/>Configs</span></a>
2024-09-01 22:17:02 +00:00
<a href="system_game_data.GameData.html#saveRunHistory" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>save<wbr/>Run<wbr/>History</span></a>
2024-06-03 10:50:22 +00:00
<a href="system_game_data.GameData.html#saveSeenDialogue" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>save<wbr/>Seen<wbr/>Dialogue</span></a>
2024-05-31 13:57:14 +00:00
<a href="system_game_data.GameData.html#saveSetting" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>save<wbr/>Setting</span></a>
<a href="system_game_data.GameData.html#saveSystem" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>save<wbr/>System</span></a>
<a href="system_game_data.GameData.html#saveTutorialFlag" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>save<wbr/>Tutorial<wbr/>Flag</span></a>
<a href="system_game_data.GameData.html#setEggMoveUnlocked" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Egg<wbr/>Move<wbr/>Unlocked</span></a>
<a href="system_game_data.GameData.html#setPokemonCaught" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Pokemon<wbr/>Caught</span></a>
<a href="system_game_data.GameData.html#setPokemonSeen" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Pokemon<wbr/>Seen</span></a>
<a href="system_game_data.GameData.html#setPokemonSpeciesCaught" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Pokemon<wbr/>Species<wbr/>Caught</span></a>
<a href="system_game_data.GameData.html#tryClearSession" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Clear<wbr/>Session</span></a>
<a href="system_game_data.GameData.html#tryExportData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Export<wbr/>Data</span></a>
2024-11-17 23:35:40 +00:00
<a href="system_game_data.GameData.html#unlockSpeciesNature" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unlock<wbr/>Species<wbr/>Nature</span></a>
2024-05-31 13:57:14 +00:00
<a href="system_game_data.GameData.html#updateSpeciesDexIvs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Species<wbr/>Dex<wbr/>Ivs</span></a>
<a href="system_game_data.GameData.html#verify" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>verify</span></a>
2024-11-18 02:09:28 +00:00
</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_GameData" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Game<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="system_game_data.GameData.html" class="tsd-signature-type tsd-kind-class">GameData</a><a href="#constructor.new_GameData" 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></ul></div><h4 class="tsd-returns-title">Returns <a href="system_game_data.GameData.html" class="tsd-signature-type tsd-kind-class">GameData</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L326">src/system/game-data.ts:326</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"><a id="achvUnlocks" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>achv<wbr/>Unlocks</span><a href="#achvUnlocks" 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">achv<wbr/>Unlocks</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AchvUnlocks</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L318">src/system/game-data.ts:318</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="dexData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>dex<wbr/>Data</span><a href="#dexData" 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">dex<wbr/>Data</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/system_game_data.DexData.html" class="tsd-signature-type tsd-kind-interface">DexData</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L308">src/system/game-data.ts:308</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="eggPity" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>egg<wbr/>Pity</span><a href="#eggPity" 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 cl
2024-09-27 21:52:07 +00:00
Will do nothing if the player does not have the Pokemon owned in their system save data.</p>
2024-11-18 02:09:28 +00: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">species</span>: <a href="data_pokemon_species.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">count</span>: <span class="tsd-signature-type">number</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"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L1745">src/system/game-data.ts:1745</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="clearLocalData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>clear<wbr/>Local<wbr/>Data</span><a href="#clearLocalData" 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="clearLocalData.clearLocalData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">clear<wbr/>Local<wbr/>Data</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="#clearLocalData.clearLocalData-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">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L719">src/system/game-data.ts:719</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="consolidateDexData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>consolidate<wbr/>Dex<wbr/>Data</span><a href="#consolidateDexData" 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="consolidateDexData.consolidateDexData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">consolidate<wbr/>Dex<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dexData</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#consolidateDexData.consolidateDexData-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">dexData</span>: <a href="../interfaces/system_game_data.DexData.html" class="tsd-signature-type tsd-kind-interface">DexData</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L1989">src/system/game-data.ts:1989</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="convertSystemDataStr" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>convert<wbr/>System<wbr/>Data<wbr/>Str</span><a href="#convertSystemDataStr" 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="
2024-10-26 21:31:27 +00:00
For deleting the session of a finished run, use <a href="system_game_data.GameData.html#tryClearSession" class="tsd-kind-method"><code>tryClearSession</code></a></p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">slotId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>the slot to clear</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><p>Promise with result <code>true</code> if the session was deleted successfully, <code>false</code> otherwise</p>
2024-11-18 02:09:28 +00:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L1139">src/system/game-data.ts:1139</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getDexAttrLuck" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Dex<wbr/>Attr<wbr/>Luck</span><a href="#getDexAttrLuck" 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="getDexAttrLuck.getDexAttrLuck-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Dex<wbr/>Attr<wbr/>Luck</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dexAttr</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getDexAttrLuck.getDexAttrLuck-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">dexAttr</span>: <span class="tsd-signature-type">bigint</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L1937">src/system/game-data.ts:1937</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFormAttr" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Form<wbr/>Attr</span><a href="#getFormAttr" 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="getFormAttr.getFormAttr-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Form<wbr/>Attr</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">formIndex</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">bigint</span><a href="#getFormAttr.getFormAttr-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">formIndex</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">bigint</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L1985">src/system/game-data.ts:1985</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getFormIndex" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Form<wbr/>Index</span><a href="#getFormIndex" 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="getFormIndex.getFormIndex-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Form<wbr/>Index</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">attr</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getFormIndex.getFormIndex-1" aria-label=
2024-09-01 22:17:02 +00:00
At the moment, only retrievable from locale cache</p>
2024-11-18 02:09:28 +00: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">scene</span>: <a href="battle_scene.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">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/system_game_data.RunHistoryData.html" class="tsd-signature-type tsd-kind-type-alias">RunHistoryData</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L577">src/system/game-data.ts:577</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getSeenDialogues" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Seen<wbr/>Dialogues</span><a href="#getSeenDialogues" 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="getSeenDialogues.getSeenDialogues-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Seen<wbr/>Dialogues</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/system_game_data.SeenDialogues.html" class="tsd-signature-type tsd-kind-interface">SeenDialogues</a><a href="#getSeenDialogues.getSeenDialogues-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 <a href="../interfaces/system_game_data.SeenDialogues.html" class="tsd-signature-type tsd-kind-interface">SeenDialogues</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L929">src/system/game-data.ts:929</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getSession" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Session</span><a href="#getSession" 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="getSession.getSession-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Session</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">slotId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/system_game_data.SessionSaveData.html" class="tsd-signature-type tsd-kind-interface">SessionSaveData</a><span class="tsd-signature-symbol">&gt;</span><a href="#getSession.getSession-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">slotId</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/system_game_data.SessionSaveData.html" class="tsd-signature-type tsd-kind-interface">SessionSaveData</a><span class="tsd-signat
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">species</span>: <a href="data_pokemon_species.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">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L1797">src/system/game-data.ts:1797</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isUnlocked" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Unlocked</span><a href="#isUnlocked" 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="isUnlocked.isUnlocked-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Unlocked</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">unlockable</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isUnlocked.isUnlocked-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-comment tsd-typography"><p>Checks if an <code>Unlockable</code> has been unlocked.</p>
2024-09-27 21:52:07 +00: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">unlockable</span>: <a href="../enums/system_unlockables.Unlockables.html" class="tsd-signature-type tsd-kind-enum">Unlockables</a></span><div class="tsd-comment tsd-typography"><p>The Unlockable to check</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if the player has unlocked this <code>Unlockable</code> or an override has enabled it</p>
2024-11-18 02:09:28 +00:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L382">src/system/game-data.ts:382</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="loadMappingConfigs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>load<wbr/>Mapping<wbr/>Configs</span><a href="#loadMappingConfigs" 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="loadMappingConfigs.loadMappingConfigs-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">load<wbr/>Mapping<wbr/>Configs</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="#loadMappingConfigs.loadMappingConfigs-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-comment tsd-typography"><p>Loads the mapping configurations from localStorage and injects them into the input controller.</p>
2024-06-01 12:57:45 +00:00
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if the configurations are successfully loaded and injected; <code>false</code> if no configurations are found in localStorage.</p>
2024-07-27 23:48:18 +00:00
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Remarks" class="tsd-anchor"></a>Remarks<a href="#Remarks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>This method checks if the 'mappingConfigs' entry exists in localStorage. If it does not exist, the method returns <code>false</code>.
If 'mappingConfigs' exists, it parses the configurations and injects each configuration into the input controller
2024-06-01 12:57:45 +00:00
for the corresponding gamepad or device key. The method then returns <code>true</code> to indicate success.</p>
2024-11-18 02:09:28 +00:00
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L782">src/system/game-data.ts:782</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="loadSession" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>load<wbr/>Session</span><a href="#loadSession" 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="loadSession.loadSession-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">load<wbr/>Session</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span>, <span class="tsd-kind-parameter">slotId</span>, <span class="tsd-kind-parameter">sessionData</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><a href="#loadSession.loadSession-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><span class="tsd-kind-parameter">slotId</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">sessionData</span>: <a href="../interfaces/system_game_data.SessionSaveData.html" class="tsd-signature-type tsd-kind-interface">SessionSaveData</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L1008">src/system/game-data.ts:1008</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="loadSystem" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>load<wbr/>System</span><a href="#loadSystem" 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="loadSystem.loadSystem-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">load<wbr/>System</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><a href="#loadSystem.loadSystem-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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L421">src/system/game-data.ts:421</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="migrateStarterAbilities" class
2024-06-03 23:58:57 +00: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">device</span>: <a href="../enums/enums_devices.Device.html" class="tsd-signature-type tsd-kind-enum">Device</a></span></li><li><span><span class="tsd-kind-parameter">localStoragePropertyName</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">setting</span>: <a href="../enums/system_settings_settings_gamepad.SettingGamepad.html" class="tsd-signature-type tsd-kind-enum">SettingGamepad</a><span class="tsd-signature-symbol"> | </span><a href="../enums/system_settings_settings_keyboard.SettingKeyboard.html" class="tsd-signature-type tsd-kind-enum">SettingKeyboard</a></span><div class="tsd-comment tsd-typography"><p>The gamepad setting to save.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">settingDefaults</span>: <span class="tsd-signature-type">any</span></span></li><li><span><span class="tsd-kind-parameter">valueIndex</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The index of the value to set for the gamepad setting.</p>
2024-06-01 12:57:45 +00:00
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if the setting is successfully saved.</p>
2024-07-27 23:48:18 +00:00
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Remarks-1" class="tsd-anchor"></a>Remarks<a href="#Remarks-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>This method initializes an empty object for gamepad settings if none exist in localStorage.
2024-06-01 12:57:45 +00:00
It then updates the setting in the current scene and iterates over the default gamepad settings
to update the specified setting with the new value. Finally, it saves the updated settings back
to localStorage and returns <code>true</code> to indicate success.</p>
2024-11-18 02:09:28 +00:00
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L818">src/system/game-data.ts:818</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="saveMappingConfigs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>save<wbr/>Mapping<wbr/>Configs</span><a href="#saveMappingConfigs" 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="saveMappingConfigs.saveMappingConfigs-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">save<wbr/>Mapping<wbr/>Configs</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">deviceName</span>, <span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#saveMappingConfigs.saveMappingConfigs-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-comment tsd-typography"><p>Saves the mapping configurations for a specified device.</p>
2024-06-01 12:57:45 +00: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">deviceName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The name of the device for which the configurations are being saved.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The configuration object containing custom mapping details.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if the configurations are successfully saved.</p>
2024-11-18 02:09:28 +00:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L758">src/system/game-data.ts:758</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="saveRunHistory" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>save<wbr/>Run<wbr/>History</span><a href="#saveRunHistory" 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="saveRunHistory.saveRunHistory-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">save<wbr/>Run<wbr/>History</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span>, <span class="tsd-kind-parameter">runEntry</span>, <span class="tsd-kind-parameter">isVictory</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><a href="#saveRunHistory.saveRunHistory-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-comment tsd-typography"><p>Saves a new entry to Run History</p>
</div><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><span class="tsd-kind-parameter">runEntry</span>: <a href="../interfaces/system_game_data.SessionSaveData.html" class="tsd-signature-type tsd-kind-interface">SessionSaveData</a></span></li><li><span><span class="tsd-kind-parameter">isVictory</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L631">src/system/game-data.ts:631</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="saveSeenDialogue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>save<wbr/>Seen<wbr/>Dialogue</span><a href="#saveSeenDialogue" 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="saveSeenDialogue.saveSeenDialogue-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">save<wbr/>Seen<wbr/>Dialogue</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dialogue</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#saveSeenDialogue.saveSeenDialogue-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">dialogue</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L918">src/system/game-data.ts:918</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="saveSetting" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>save<wbr/>Setting</span><a href="#saveSetting" 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="saveSetting.saveSetting-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">save<wbr/>Setting</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">setting</span>, <span class="tsd-kind-parameter">valueIndex</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#saveSetting.saveSetting-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-comment tsd-typography"><p>Saves a setting to localStorage</p>
2024-06-03 23:58:57 +00: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">setting</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>string ideally of SettingKeys</p>
2024-07-27 23:48:18 +00:00
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">valueIndex</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>index of the setting's option</p>
2024-06-03 23:58:57 +00:00
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true</p>
2024-11-18 02:09:28 +00:00
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L735">src/system/game-data.ts:735</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="saveSystem" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>save<wbr/>System</span><a href="#saveSystem" 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="saveSystem.saveSystem-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">save<wbr/>System</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><a href="#saveSystem.saveSystem-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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L389">src/system/game-data.ts:389</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="saveTutorialFlag" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>save<wbr/>Tutorial<wbr/>Flag</span><a href="#saveTutorialFlag" 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="saveTutorialFlag.saveTutorialFlag-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">save<wbr/>Tutorial<wbr/>Flag</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tutorial</span>, <span class="tsd-kind-parameter">flag</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#saveTutorialFlag.saveTutorialFlag-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">tutorial</span>: <a href="../enums/tutorial.Tutorial.html" class="tsd-signature-type tsd-kind-enum">Tutorial</a></span></li><li><span><span class="tsd-kind-parameter">flag</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L879">src/system/game-data.ts:879</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setEggMoveUnlocked" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Egg<wbr/>Move<wbr/>Unlocked</span><a href="#setEggMoveUnlocked" 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="setEggMoveUnlocked.setEggMoveUnlocked-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Egg<wbr/>Move<wbr/>Unlocked</span><span class="tsd-signature-symbol">(
2024-09-27 21:52:07 +00:00
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">prependSpeciesToMessage</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>Default false. If true, will change message from &quot;X Egg Move Unlocked!&quot; to &quot;Bulbasaur X Egg Move Unlocked!&quot;</p>
2024-11-18 02:09:28 +00:00
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L1761">src/system/game-data.ts:1761</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setPokemonCaught" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Pokemon<wbr/>Caught</span><a href="#setPokemonCaught" 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="setPokemonCaught.setPokemonCaught-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Pokemon<wbr/>Caught</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pokemon</span>, <span class="tsd-kind-parameter">incrementCount</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">fromEgg</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">showMessage</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><a href="#setPokemonCaught.setPokemonCaught-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><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">incrementCount</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fromEgg</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">showMessage</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><p><code>true</code> if Pokemon catch unlocked a new starter, <code>false</code> if Pokemon catch did not unlock a starter</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L1603">src/system/game-data.ts:1603</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setPokemonSeen" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Pokemon<wbr/>Seen</span><a href="#setPokemonSeen" 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="setPokemonSeen.setPokemonSeen-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Pokemon<wbr/>Seen</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pokemon</span>, <span class="tsd-kind-parameter">incrementCount</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">trainer</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="#setPokemonSeen.setPokemonSeen-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><li><span><span class="tsd-kind-parameter">incrementCount</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span></li><li><span><span class="tsd-kind-parameter">trainer</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 <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L1572">src/system/game-data.ts:1572</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setPokemonSpeciesCaught" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Pokemon<wbr/>Species<wbr/>Caught</span><a href="#setPokemonSpeciesCaught" 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="setPokemonSpeciesCaught.setPokemonSpeciesCaught-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Pokemon<wbr/>Species<wbr/>Caught</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pokemon</span>, <span class="tsd-kind-parameter">species</span>, <span class="tsd-kind-parameter">incrementCount</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">fromEgg</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">showMessage</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><a href="#setPokemonSpeciesCaught.setPokemonSpeciesCaught-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" c
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L1623">src/system/game-data.ts:1623</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="tryClearSession" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>try<wbr/>Clear<wbr/>Session</span><a href="#tryClearSession" 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="tryClearSession.tryClearSession-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">try<wbr/>Clear<wbr/>Session</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scene</span>, <span class="tsd-kind-parameter">slotId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">[</span>success<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span>newClear<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><a href="#tryClearSession.tryClearSession-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-comment tsd-typography"><p>Attempt to clear session data after the end of a run
2024-10-26 21:31:27 +00:00
After session data is removed, attempt to update user info so the menu updates
To delete an unfinished run instead, use <a href="system_game_data.GameData.html#deleteSession" class="tsd-kind-method"><code>deleteSession</code></a></p>
2024-11-18 02:09:28 +00: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">scene</span>: <a href="battle_scene.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li><li><span><span class="tsd-kind-parameter">slotId</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">[</span>success<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span>newClear<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L1208">src/system/game-data.ts:1208</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="tryExportData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>try<wbr/>Export<wbr/>Data</span><a href="#tryExportData" 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="tryExportData.tryExportData-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">try<wbr/>Export<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dataType</span>, <span class="tsd-kind-parameter">slotId</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><a href="#tryExportData.tryExportData-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">dataType</span>: <a href="../enums/enums_game_data_type.GameDataType.html" class="tsd-signature-type tsd-kind-enum">GameDataType</a></span></li><li><span><span class="tsd-kind-parameter">slotId</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L1367">src/system/game-data.ts:1367</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="unlockSpeciesNature" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unlock<wbr/>Species<wbr/>Nature</span><a href="#unlockSpeciesNature" 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="unlockSpeciesNature.unlockSpeciesNature-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">unlock<wbr/>Species<wbr/>Nature</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">species</span>, <span class="tsd-kind-parameter">nature</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span clas
2024-11-17 23:35:40 +00:00
Will fail silently if root species has not been unlocked</p>
2024-11-18 02:09:28 +00: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">species</span>: <a href="data_pokemon_species.default.html" class="tsd-signature-type tsd-kind-class">default</a></span></li><li><span><span class="tsd-kind-parameter">nature</span>: <a href="../enums/enums_nature.Nature.html" class="tsd-signature-type tsd-kind-enum">Nature</a></span></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"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L1805">src/system/game-data.ts:1805</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="updateSpeciesDexIvs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update<wbr/>Species<wbr/>Dex<wbr/>Ivs</span><a href="#updateSpeciesDexIvs" 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="updateSpeciesDexIvs.updateSpeciesDexIvs-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Species<wbr/>Dex<wbr/>Ivs</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">speciesId</span>, <span class="tsd-kind-parameter">ivs</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#updateSpeciesDexIvs.updateSpeciesDexIvs-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">speciesId</span>: <a href="../enums/enums_species.Species.html" class="tsd-signature-type tsd-kind-enum">Species</a></span></li><li><span><span class="tsd-kind-parameter">ivs</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L1820">src/system/game-data.ts:1820</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="verify" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>verify</span><a href="#verify" 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="verify.verify-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">verify</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><a href="#verify.verify-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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/pagefaultgames/pokerogue/blob/dd904fe7827eb2695c5362f0864e32d58df10c6c/src/system/game-data.ts#L702">src/system/game-data.ts:702</a></li></ul></aside></li></ul></section></section