pages/public/lit/docs/upgrades.html

40 lines
38 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="en-US" dir="ltr">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Upgrades | The Paper Pilot</title>
<meta name="description" content="The Paper Pilot's Digital Garden">
<meta name="generator" content="VitePress v1.2.2">
<link rel="preload stylesheet" href="/assets/style.12HpFxmm.css" as="style">
<script type="module" src="/assets/app.DL23qwwQ.js"></script>
<link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
<link rel="modulepreload" href="/assets/chunks/framework.Bq2gx8C2.js">
<link rel="modulepreload" href="/assets/chunks/theme.CtRrZ9fK.js">
<link rel="modulepreload" href="/assets/public_lit_docs_upgrades.md.XTgcmDND.lean.js">
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Itim&amp;family=Roboto+Mono:ital,wght@0,400;0,600;1,400&amp;display=block">
<link rel="manifest" href="/site.webmanifest">
<link rel="alternate" type="text/mf2+html" href="/changelog">
<link rel="alternate" type="application/rss+xml" title="Changelog" href="/changelog/rss">
<link rel="alternate" type="application/atom+xml" title="Changelog" href="/changelog/atom">
<link rel="alternate" type="application/json+xml" title="Changelog" href="/changelog/json">
<meta name="og:description" content="The Paper Pilot's Digital Garden">
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
</head>
<body>
<div id="app"><div class="Layout" data-v-4c30d864 data-v-5d98c3a5><!--[--><!--[--><!--]--><!--]--><!--[--><span tabindex="-1" data-v-0f60ec36></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-0f60ec36> Skip to content </a><!--]--><!----><header class="VPNav" data-v-5d98c3a5 data-v-ae24b3ad><div class="VPNavBar has-sidebar top" data-v-ae24b3ad data-v-ccf7ddec><div class="wrapper" data-v-ccf7ddec><div class="container" data-v-ccf7ddec><div class="title" data-v-ccf7ddec><div class="VPNavBarTitle has-sidebar" data-v-ccf7ddec data-v-ab179fa1><a class="title" href="/" data-v-ab179fa1><!--[--><!--]--><!----><span data-v-ab179fa1>The Paper Pilot</span><!--[--><!--]--></a></div></div><div class="content" data-v-ccf7ddec><div class="content-body" data-v-ccf7ddec><!--[--><!--]--><div class="VPNavBarSearch search" data-v-ccf7ddec><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-ccf7ddec data-v-7f418b0f><span id="main-nav-aria-label" class="visually-hidden" data-v-7f418b0f>Main Navigation</span><!--[--><!--[--><a class="VPLink link vp-external-link-icon VPNavBarMenuLink" href="https://moddingtree.com" target="_blank" rel="noreferrer" tabindex="0" data-v-7f418b0f data-v-9c663999><!--[--><span data-v-9c663999>Profectus</span><!--]--></a><!--]--><!--[--><a class="VPLink link vp-external-link-icon VPNavBarMenuLink" href="https://incremental.social" target="_blank" rel="noreferrer" tabindex="0" data-v-7f418b0f data-v-9c663999><!--[--><span data-v-9c663999>Incremental Social</span><!--]--></a><!--]--><!--]--></nav><!----><!----><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-ccf7ddec data-v-0394ad82 data-v-7bc22406><!--[--><a class="VPSocialLink no-icon" href="https://code.incremental.social/thepaperpilot" aria-label target="_blank" rel="noopener" data-v-7bc22406 data-v-eee4e7cb><svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Forgejo</title><path d="M16.7773 0c1.6018 0 2.9004 1.2986 2.9004 2.9005s-1.2986 2.9004-2.9004 2.9004c-1.0854 0-2.0315-.596-2.5288-1.4787H12.91c-2.3322 0-4.2272 1.8718-4.2649 4.195l-.0007 2.1175a7.0759 7.0759 0 0 1 4.148-1.4205l.1176-.001 1.3385.0002c.4973-.8827 1.4434-1.4788 2.5288-1.4788 1.6018 0 2.9004 1.2986 2.9004 2.9005s-1.2986 2.9004-2.9004 2.9004c-1.0854 0-2.0315-.596-2.5288-1.4787H12.91c-2.3322 0-4.2272 1.8718-4.2649 4.195l-.0007 2.319c.8827.4973 1.4788 1.4434 1.4788 2.5287 0 1.602-1.2986 2.9005-2.9005 2.9005-1.6018 0-2.9004-1.2986-2.9004-2.9005 0-1.0853.596-2.0314 1.4788-2.5287l-.0002-9.9831c0-3.887 3.1195-7.0453 6.9915-7.108l.1176-.001h1.3385C14.7458.5962 15.692 0 16.7773 0ZM7.2227 19.9052c-.6596 0-1.1943.5347-1.1943 1.1943s.5347 1.1943 1.1943 1.1943 1.1944-.5347 1.1944-1.1943-.5348-1.1943-1.1944-1.1943Zm9.5546-10.4644c-.6596 0-1.1944.5347-1.1944 1.1943s.5348 1.1943 1.1944 1.1943c.6596 0 1.1943-.5347 1.1943-1.1943s-.5347-1.1943-1.1943-1.1943Zm0-7.7346c-.6596 0-1.1944.5347-1.1944 1.1943s.5348 1.1943 1.1944 1.1943c.6596 0 1.1943-.5347 1.1943-1.1943s-.5347-1.1943-1.1943-1.1943Z"/></svg></a><a class="VPSocialLink no-icon" href="https://matrix.to/#/@thepaperpilot:incremental.social" aria-label target="_blank" rel="noopener" data-v-7bc22406 data-v-eee4e7cb><svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Matrix</title><path d="M.632.55v22.9H2.28V24H0V0h2.28v.55zm7.043 7.26v1.157h.033c.309-.443.683-.784 1.117-1.024.433-.245.936-.365 1.5-.365.54 0 1.033.107 1.481.314.448.208.785.582 1.02 1.108.254-.374.6-.706 1.034-.992.434-.287.95-.43 1.546-.43.453 0 .872.056 1.26.167.388.11.716.286.993.53.276.245.489.559.646.951.152.392.23.863.23 1.417v5.728h-2.349V11.52c0-.286-.01-.559-.
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> rows</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: # </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">of</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> rows,</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> cols</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: # </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">of</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> columns,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 11</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: {</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> description: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;Blah&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> cost: </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">new</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> Decimal</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">100</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">),</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> etc</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> },</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> etc</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><p>Each upgrade should have an id where the first digit is the row and the second digit is the column.</p><p>Individual upgrades can have these features:</p><ul><li><p>title: <strong>optional</strong>. Displayed at the top in a larger font. It can also be a function that returns updating text. Can use basic HTML.</p></li><li><p>description: A description of the upgrade&#39;s effect. <em>You will also have to implement the effect where it is applied.</em> It can also be a function that returns updating text. Can use basic HTML.</p></li><li><p>effect(): <strong>optional</strong>. A function that calculates and returns the current values of any bonuses from the upgrade. Can return a value or an object containing multiple values.</p></li><li><p>effectDisplay(): <strong>optional</strong>. A function that returns a display of the current effects of the upgrade with formatting. Default displays nothing. Can use basic HTML.</p></li><li><p>fullDisplay(): <strong>OVERRIDE</strong>. Overrides the other displays and descriptions, and lets you set the full text for the upgrade. Can use basic HTML.</p></li><li><p>cost: A Decimal for the cost of the upgrade. By default, upgrades cost the main prestige currency for the layer.</p></li><li><p>unlocked(): <strong>optional</strong>. A function returning a bool to determine if the upgrade is visible or not. Default is unlocked.</p></li><li><p>onPurchase(): <strong>optional</strong>. This function will be called when the upgrade is purchased. Good for upgrades like &quot;makes this layer act like it was unlocked first&quot;.</p></li><li><p>style: <strong>optional</strong>. Applies CSS to this upgrade, in the form of an object where the keys are CSS attributes, and the values are the values for those attributes (both as strings).</p></li><li><p>layer: <strong>assigned automagically</strong>. It&#39;s the same value as the name of this layer, so you can do <code>player[this.layer].points</code> or similar.</p></li><li><p>id: <strong>assigned automagically</strong>. It&#39;s the &quot;key&quot; which the upgrade was stored under, for convenient access. The upgrade in the example&#39;s id is 11.</p></li></ul><p>By default, upgrades use the main prestige currency for the layer. You can include these to change them (but it needs to be a Decimal):</p><ul><li><p>currencyDisplayName: <strong>optional</strong>. The name to display for the currency for the upgrade.</p></li><li><p>currencyInternalName: <strong>optional</strong>. The internal name for that currency.</p></li><li><p>currencyLayer: <strong>optional</strong>. The internal name of the layer that currency is stored in. If it&#39;s not in a layer (like Points), omit. If it&#39;s not stored directly in a layer, instead use the next feature.</p></li><li><p>currencyLocation: <strong>optional</strong>. If your currency is stored in something inside a layer (e.g. a buyable&#39;s amount), you can access it this way. This is a function returning the object in &quot;player&quot; that contains the value (like <code>player[this.layer].buyables</code>)</p></li></ul><p>If you want to do something more complicated like upgrades that cost two currencies, you can override the purchase system with these (and you need to use fullDisplay as well)</p><ul><li><p>canAfford(): <strong>OVERRIDE</strong>, a function determining if you are able to buy the upgrade</p></li><li><p>pay(): <strong>OVERRIDE</strong>, a function that reduces your currencies when you buy the upgrade</p></li></ul></div></div></main><footer class="VPDocFooter" data-v-39a288b8 data-v-d4a0bba5><!--[--><!--]--><!----><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-d4a0bba5><span class="visually-hidden" id="doc-footer-aria-label" data-v-d4a0bba5>Pager</span><div class="pager" data-v-d4a0bba5><!----></div><div class="pager" data-v-d4a0bba5><a class="VPLink link pager-link next" href="/garden/the-small-web" data-v-d4a0bba5><!--[--><span class="desc" data-v-d4a0bba5>Next
<script>window.__VP_HASH_MAP__=JSON.parse("{\"garden_activitypub_index.md\":\"CDeJRXBh\",\"garden_guide-to-incrementals_appeal-to-players_index.md\":\"CXjhYvl-\",\"garden_advent-incremental_index.md\":\"C7S6esaL\",\"garden_matrix_index.md\":\"BghMxHuc\",\"garden_guide-to-incrementals_navigating-criticism_index.md\":\"eB-EMql0\",\"garden_life-is-strange_index.md\":\"CquVjaS0\",\"public_gamedevtree_docs_clickables.md\":\"Dp5mazwD\",\"garden_nostr_index.md\":\"CqDqRzwp\",\"garden_planar-pioneers_index.md\":\"-jYyVXII\",\"garden_profectus_index.md\":\"DcxAABUu\",\"garden_synapse_index.md\":\"CXetwotF\",\"garden_the-beginner-s-guide_index.md\":\"cyJ6almf\",\"garden_the-indieweb_amplification_index.md\":\"ls_5SujA\",\"garden_fediverse_index.md\":\"teBWFQdY\",\"public_kronos_docs_infoboxes.md\":\"DKJQYUVg\",\"public_lit_docs_clickables.md\":\"9bcgPDbp\",\"public_lit_docs_custom-tab-layouts.md\":\"B5ZU6XzB\",\"garden_dice-armor_index.md\":\"q3WatnHP\",\"garden_freeform-vs-chronological-dichotomy_index.md\":\"BWcJ7xvb\",\"garden_fedi-v2_index.md\":\"B5UYOvBa\",\"garden_the-small-web_index.md\":\"Bdjd2JJi\",\"garden_social-media_index.md\":\"zkohyykX\",\"public_kronos_docs_clickables.md\":\"J1mprI1e\",\"public_kronos_docs_getting-started.md\":\"C1NgAIPE\",\"public_kronos_docs_custom-tab-layouts.md\":\"C5fzInqO\",\"public_kronos_docs_bars.md\":\"BkOyjYp3\",\"public_kronos_docs_basic-layer-breakdown.md\":\"fRmgGXSu\",\"public_gamedevtree_docs_custom-tab-layouts.md\":\"BucTqbqO\",\"public_kronos_docs_!general-info.md\":\"C_AEL1us\",\"garden_weird_index.md\":\"DpTEsIQm\",\"guide-to-incrementals_ludology_content_index.md\":\"BFSRVZRG\",\"guide-to-incrementals_ludology_definition_index.md\":\"BcLQADwH\",\"garden_ivy-road_index.md\":\"DU46Drp4\",\"public_kronos_docs_milestones.md\":\"DsU6WNtV\",\"public_gamedevtree_docs_getting-started.md\":\"Bbs6P0XJ\",\"garden_atproto_index.md\":\"BRErnPoj\",\"garden_artificial-intelligence_index.md\":\"DDSkAnZe\",\"garden_video-game-monetization_index.md\":\"DbtgQKpj\",\"garden_mbin_index.md\":\"CbkPhi_d\",\"garden_open-source_index.md\":\"lwZ-aLga\",\"garden_capture-the-citadel_index.md\":\"BXOCTDH0\",\"garden_guide-to-incrementals_defining-the-genre_index.md\":\"1u5rTe1N\",\"garden_guide-to-incrementals_index.md\":\"NXimWKvy\",\"public_kronos_changelog.md\":\"gf8wmilo\",\"public_kronos_docs_achievements.md\":\"CyVZiA6B\",\"public_gamedevtree_docs_layer-features.md\":\"dBK08x7A\",\"public_gamedevtree_2.0-format-changes.md\":\"BD048MX_\",\"public_lit_docs_trees-and-tree-customization.md\":\"De1XkHAz\",\"public_lit_docs_milestones.md\":\"DDpCyhAt\",\"public_gamedevtree_changelog.md\":\"DkNjDmmL\",\"garden_babble-buds_index.md\":\"DyQtPqda\",\"public_gamedevtree_docs_subtabs-and-microtabs.md\":\"Cc5x1x5k\",\"public_gamedevtree_docs_!general-info.md\":\"DN0knJeX\",\"public_gamedevtree_docs_buyables.md\":\"DMEJdImD\",\"garden_chronological_index.md\":\"DRnm8DUT\",\"garden_cinny_index.md\":\"01MjoauA\",\"garden_command-palettes_index.md\":\"CGAuuspP\",\"public_lit_docs_achievements.md\":\"YJu5QDlP\",\"garden_commune_index.md\":\"BWMr9Udf\",\"garden_davey-wreden_index.md\":\"DCiRzYpD\",\"public_gamedevtree_docs_challenges.md\":\"BPerubiE\",\"garden_decentralized_index.md\":\"CoiOsMXD\",\"public_kronos_docs_updating-tmt.md\":\"J412Rs4k\",\"public_lit_docs_getting-started.md\":\"CIqDf8WH\",\"public_lit_docs_infoboxes.md\":\"CFCKtD4n\",\"public_lit_docs_layer-features.md\":\"DnWdAhFI\",\"public_lit_docs_main-mod-info.md\":\"w89kG5q9\",\"garden_pre-order-bonuses_index.md\":\"D-ZTjavq\",\"garden_game-dev-tree_index.md\":\"D4eoxDZD\",\"garden_logseq_index.md\":\"Buu03zlR\",\"garden_premium-currency_index.md\":\"BXifuKGw\",\"garden_federated-identity_index.md\":\"Tm3Z7BCl\",\"garden_digital-gardens_index.md\":\"BqL6HV3p\",\"garden_the-cozy-web_index.md\":\"BKjLg2zY\",\"public_lit_docs_bars.md\":\"Cv-Xtm62\",\"garden_vitepress_index.md\":\"DiPjP1XT\",\"garden_the-indieweb_signature-blocks_index.md\":\"CHzVdTSl\",\"public_lit_docs_subtabs-and-microtabs.md\":\"C0qH5t2v\",\"garden_kronos_index.md\":\"CQ7062fD\",\
</body>
</html>