profectus-docs/guide/project-entry.html

28 lines
34 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Project Entry | Profectus</title>
<meta name="description" content="A game engine that grows with you.">
<link rel="stylesheet" href="/assets/style.e3402314.css">
<link rel="modulepreload" href="/assets/app.cf939732.js">
<link rel="modulepreload" href="/assets/guide_project-entry.md.8a9337cf.lean.js">
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,400;0,600;1,400">
<link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png">
<link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png">
<link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png">
<link rel="manifest" href="/site.webmanifest">
<script defer="true" data-domain="moddingtree.com" src="https://plausible.io/js/plausible.js"></script>
<meta name="og:description" content="A game engine that grows with you">
<meta name="og:image" content="/Logo.png">
</head>
<body>
<div id="app"><div class="Layout" data-v-6b5fd0a9><!--[--><!--]--><!--[--><span tabindex="-1" data-v-45f6ae50></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-45f6ae50> Skip to content </a><!--]--><!----><header class="VPNav" data-v-6b5fd0a9 data-v-0e356168><div class="VPNavBar has-sidebar" data-v-0e356168 data-v-8856f192><div class="container" data-v-8856f192><div class="VPNavBarTitle has-sidebar" data-v-8856f192 data-v-6a6f7ff6><a class="title" href="/" data-v-6a6f7ff6><!--[--><img class="VPImage logo" src="/favicon.svg" data-v-73ae1788><!--]--><!--[-->Profectus<!--]--></a></div><div class="content" data-v-8856f192><!----><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-8856f192 data-v-a30758ee><span id="main-nav-aria-label" class="visually-hidden" data-v-a30758ee>Main Navigation</span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink active" href="/guide/" data-v-a30758ee data-v-8fba5fa8 data-v-5704c677><!--[-->Guide<!--]--><!----></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/api/overview.html" data-v-a30758ee data-v-8fba5fa8 data-v-5704c677><!--[-->API<!--]--><!----></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="https://forums.moddingtree.com" target="_blank" rel="noopener noreferrer" data-v-a30758ee data-v-8fba5fa8 data-v-5704c677><!--[-->Forums<!--]--><!----></a><!--]--><!--]--></nav><!----><!----><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-8856f192 data-v-0ae890f7 data-v-4dcbaf3a><!--[--><a class="VPSocialLink" href="https://discord.gg/F3xveHV" title="discord" target="_blank" rel="noopener noreferrer" data-v-4dcbaf3a data-v-48c45ef6><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" viewbox="0 0 24 24" class="icon" data-v-48c45ef6><path d="M20.222 0c1.406 0 2.54 1.137 2.607 2.475V24l-2.677-2.273-1.47-1.338-1.604-1.398.67 2.205H3.71c-1.402 0-2.54-1.065-2.54-2.476V2.48C1.17 1.142 2.31.003 3.715.003h16.5L20.222 0zm-6.118 5.683h-.03l-.202.2c2.073.6 3.076 1.537 3.076 1.537-1.336-.668-2.54-1.002-3.744-1.137-.87-.135-1.74-.064-2.475 0h-.2c-.47 0-1.47.2-2.81.735-.467.203-.735.336-.735.336s1.002-1.002 3.21-1.537l-.135-.135s-1.672-.064-3.477 1.27c0 0-1.805 3.144-1.805 7.02 0 0 1 1.74 3.743 1.806 0 0 .4-.533.805-1.002-1.54-.468-2.14-1.404-2.14-1.404s.134.066.335.2h.06c.03 0 .044.015.06.03v.006c.016.016.03.03.06.03.33.136.66.27.93.4.466.202 1.065.403 1.8.536.93.135 1.996.2 3.21 0 .6-.135 1.2-.267 1.8-.535.39-.2.87-.4 1.397-.737 0 0-.6.936-2.205 1.404.33.466.795 1 .795 1 2.744-.06 3.81-1.8 3.87-1.726 0-3.87-1.815-7.02-1.815-7.02-1.635-1.214-3.165-1.26-3.435-1.26l.056-.02zm.168 4.413c.703 0 1.27.6 1.27 1.335 0 .74-.57 1.34-1.27 1.34-.7 0-1.27-.6-1.27-1.334.002-.74.573-1.338 1.27-1.338zm-4.543 0c.7 0 1.266.6 1.266 1.335 0 .74-.57 1.34-1.27 1.34-.7 0-1.27-.6-1.27-1.334 0-.74.57-1.338 1.27-1.338z"></path></svg><span class="visually-hidden" data-v-48c45ef6>discord</span></a><a class="VPSocialLink" href="https://github.com/profectus-engine/Profectus" title="github" target="_blank" rel="noopener noreferrer" data-v-4dcbaf3a data-v-48c45ef6><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" viewbox="0 0 24 24" class="icon" data-v-48c45ef6><path d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12"></path></svg><span class="visually-hidden" data-v-48c45ef6>github</span></a><!--]--></div><div class="VPFlyout VPNavBarE
<span class="line"></span></code></pre></div><h3 id="fixoldsave" tabindex="-1">fixOldSave <a class="header-anchor" href="#fixoldsave" aria-hidden="true">#</a></h3><ul><li>Type: <code>(oldVersion: string | undefined, player: Partial&lt;PlayerData&gt;) =&gt; void</code></li></ul><p>This function will be run whenever a save is loaded that has a different version than the one in <a href="./project-info.html#versionnumber">project info</a>. It will be given the old version number, and the player save data object currently being loaded.</p><p>The purpose of this function is to perform any necessary migrations, such as capping a resource that accidentally inflated in a previous version of the project. By default it will do nothing.</p></div></div></main><footer class="VPDocFooter" data-v-79ca2460 data-v-04568844><div class="edit-info" data-v-04568844><div class="edit-link" data-v-04568844><a class="VPLink link edit-link-button" href="https://github.com/profectus-engine/profectus-docs/edit/main/docs/guide/project-entry.md" target="_blank" rel="noopener noreferrer" data-v-04568844 data-v-5704c677><!--[--><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="edit-link-icon" data-v-04568844><path d="M18,23H4c-1.7,0-3-1.3-3-3V6c0-1.7,1.3-3,3-3h7c0.6,0,1,0.4,1,1s-0.4,1-1,1H4C3.4,5,3,5.4,3,6v14c0,0.6,0.4,1,1,1h14c0.6,0,1-0.4,1-1v-7c0-0.6,0.4-1,1-1s1,0.4,1,1v7C21,21.7,19.7,23,18,23z"></path><path d="M8,17c-0.3,0-0.5-0.1-0.7-0.3C7,16.5,6.9,16.1,7,15.8l1-4c0-0.2,0.1-0.3,0.3-0.5l9.5-9.5c1.2-1.2,3.2-1.2,4.4,0c1.2,1.2,1.2,3.2,0,4.4l-9.5,9.5c-0.1,0.1-0.3,0.2-0.5,0.3l-4,1C8.2,17,8.1,17,8,17zM9.9,12.5l-0.5,2.1l2.1-0.5l9.3-9.3c0.4-0.4,0.4-1.1,0-1.6c-0.4-0.4-1.2-0.4-1.6,0l0,0L9.9,12.5z M18.5,2.5L18.5,2.5L18.5,2.5z"></path></svg> Edit this page<!--]--><!----></a></div><div class="last-updated" data-v-04568844><p class="VPLastUpdated" data-v-04568844 data-v-0ce8c960>Last updated: <time datatime="2022-07-15T02:59:46.000Z" data-v-0ce8c960></time></p></div></div><div class="prev-next" data-v-04568844><div class="pager" data-v-04568844><a class="pager-link prev" href="/guide/project-info.html" data-v-04568844><span class="desc" data-v-04568844>Previous page</span><span class="title" data-v-04568844>Project Info</span></a></div><div class="has-prev pager" data-v-04568844><a class="pager-link next" href="/guide/changelog.html" data-v-04568844><span class="desc" data-v-04568844>Next page</span><span class="title" data-v-04568844>Changelog</span></a></div></div></footer><!--[--><!--]--></div></div></div></div></div><!----><!--[--><!--]--></div></div>
<script>__VP_HASH_MAP__ = JSON.parse("{\"api_classes_lib_break_eternity.default.md\":\"33aecaab\",\"api_components_contextcomponent.md\":\"4fa7c0a3\",\"api_components_infocomponent.md\":\"d6c04ad3\",\"api_components_layercomponent.md\":\"d5c7e9fb\",\"api_components_marknodecomponent.md\":\"f7aee25b\",\"api_components_modalcomponent.md\":\"2268a3e0\",\"api_components_nodecomponent.md\":\"f9ccbe21\",\"api_components_savecomponent.md\":\"05a7aa38\",\"api_components_fields_dangerbuttoncomponent.md\":\"222ea7f6\",\"api_components_fields_feedbackbuttoncomponent.md\":\"5443218e\",\"api_components_fields_selectcomponent.md\":\"bf5783bc\",\"api_components_fields_slidercomponent.md\":\"66a35ab5\",\"api_components_fields_textcomponent.md\":\"64f2b5e6\",\"api_components_fields_togglecomponent.md\":\"ce0ea3cd\",\"api_components_layout_collapsiblecomponent.md\":\"6d34f6a3\",\"api_components_layout_columncomponent.md\":\"a23b65cf\",\"api_components_layout_rowcomponent.md\":\"dfa7d063\",\"api_components_layout_spacercomponent.md\":\"82dfe511\",\"api_components_layout_stickycomponent.md\":\"148c974e\",\"api_components_layout_verticalrulecomponent.md\":\"0a9ba68c\",\"api_components_math_floorcomponent.md\":\"f61c3cba\",\"api_components_math_sqrtcomponent.md\":\"f1739731\",\"api_enums_data_themes.themes.md\":\"e858827c\",\"api_enums_features_boards_board.progressdisplay.md\":\"c61067e5\",\"api_enums_features_boards_board.shape.md\":\"d6916bb4\",\"api_enums_features_feature.visibility.md\":\"ae747b41\",\"api_enums_features_milestones_milestone.milestonedisplay.md\":\"095aa24c\",\"api_enums_util_common.direction.md\":\"5a6f319c\",\"api_interfaces_data_common.layertreenodeoptions.md\":\"3d2e2417\",\"api_interfaces_data_common.resetbuttonoptions.md\":\"e082eff4\",\"api_interfaces_data_themes.theme.md\":\"7d0cf52f\",\"api_interfaces_data_themes.themevars.md\":\"ca366e89\",\"api_interfaces_features_achievements_achievement.achievementoptions.md\":\"4f839c3e\",\"api_interfaces_features_achievements_achievement.baseachievement.md\":\"147584b2\",\"api_interfaces_features_bars_bar.baroptions.md\":\"b036ae8d\",\"api_interfaces_features_bars_bar.basebar.md\":\"aef2d6d5\",\"api_interfaces_features_boards_board.baseboard.md\":\"0180f57b\",\"api_interfaces_features_boards_board.baseboardnodeaction.md\":\"51bb712e\",\"api_interfaces_features_boards_board.basenodetype.md\":\"552d5564\",\"api_interfaces_features_boards_board.boardnode.md\":\"335daa8f\",\"api_interfaces_features_boards_board.boardnodeactionoptions.md\":\"26e26ee4\",\"api_interfaces_features_boards_board.boardnodelink.md\":\"230c6f00\",\"api_interfaces_features_boards_board.boardoptions.md\":\"abb90f4e\",\"api_interfaces_features_boards_board.nodelabel.md\":\"7e38632c\",\"api_interfaces_features_boards_board.nodetypeoptions.md\":\"cfccdb1d\",\"api_interfaces_features_buyable.basebuyable.md\":\"40da1e4f\",\"api_interfaces_features_buyable.buyableoptions.md\":\"34250161\",\"api_interfaces_features_challenges_challenge.basechallenge.md\":\"cf1e5915\",\"api_interfaces_features_challenges_challenge.challengeoptions.md\":\"70e9bb71\",\"api_interfaces_features_clickables_clickable.baseclickable.md\":\"51276e22\",\"api_interfaces_features_clickables_clickable.clickableoptions.md\":\"7b3936e6\",\"api_interfaces_features_conversion.baseconversion.md\":\"9f84deb6\",\"api_interfaces_features_conversion.conversionoptions.md\":\"73ac9253\",\"api_interfaces_features_conversion.scalingfunction.md\":\"811381f2\",\"api_interfaces_features_grids_grid.basegrid.md\":\"8892a5af\",\"api_interfaces_features_grids_grid.gridcell.md\":\"1b93694a\",\"api_interfaces_features_grids_grid.gridoptions.md\":\"9c8dc29d\",\"api_interfaces_features_hotkey.basehotkey.md\":\"64839d53\",\"api_interfaces_features_hotkey.hotkeyoptions.md\":\"9dac97d9\",\"api_interfaces_features_infoboxes_infobox.baseinfobox.md\":\"e248612d\",\"api_interfaces_features_infoboxes_infobox.infoboxoptions.md\":\"94dbd995\",\"api_interfaces_features_links_links.baselinks.md\":\"5f968863\",\"api_interfaces_features_links_links.link.md\":\"d2462a72\",\"a
<script type="module" async src="/assets/app.cf939732.js"></script>
</body>
</html>