pages/public/lit/docs/main-mod-info.html

57 lines
41 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>mod.js | 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.Bmn3N4Qh.css" as="style">
<script type="module" src="/assets/app.vcvcfcVU.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.DvHfxfnp.js">
<link rel="modulepreload" href="/assets/chunks/theme.B5qRBxWI.js">
<link rel="modulepreload" href="/assets/public_lit_docs_main-mod-info.md.CcRWcMdS.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="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">
<link rel="mask-icon" href="/safari-pinned-tab.svg" color="#3a0839">
<link rel="shortcut icon" href="/favicon.ico">
<meta name="msapplication-TileColor" content="#00FFFF">
<meta name="msapplication-config" content="/browserconfig.xml">
<meta name="theme-color" content="#3B4252">
<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">
<link rel="me" href="mailto:thepaperpilot@incremental.social">
<link rel="me" href="https://incremental.social/u/thepaperpilot">
<link rel="me" href="https://matrix.to/#/@thepaperpilot:incremental.social">
<link rel="me" href="https://code.incremental.social/thepaperpilot">
<link rel="me" href="https://www.linkedin.com/in/anthony-lawn/">
<link rel="me" href="https://mastodon.gamedev.place/@thepaperpilot">
<link rel="me" href="https://beehaw.org/u/thepaperpilot">
<link rel="me" href="https://www.reddit.com/user/ThePaperPilot/">
<link rel="me" href="https://github.com/thepaperpilot">
<link rel="me" href="https://twitter.com/ThePaperPilot">
<script data-goatcounter="https://thepaperpilot.goatcounter.com/count" async src="//gc.zgo.at/count.js"></script>
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
<meta name="og:title" content="mod.js">
<meta name="og:description" content="">
<meta name="og:image" content="https://www.thepaperpilot.org/paperpilot_thumb.png">
<meta name="og:site_name" content="The Paper Pilot's Digital Garden">
</head>
<body>
<div id="app"><div class="Layout" data-v-44029f47 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
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">var</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> doNotCallTheseFunctionsEveryTick </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> [</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;doReset&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;buy&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;onPurchase&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;blowUpEverything&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">]</span></span></code></pre></div><ul><li><p>getStartPoints(): A function to determine the amount of points the player starts with after a reset. (returns a Decimal value)</p></li><li><p>canGenPoints(): A function returning a boolean for if points should be generated. Use this if you want an upgrade to unlock generating points.</p></li><li><p>getPointGen(): A function that calculates your points per second. Anything that affects your point gain should go into the calculation here.</p></li><li><p>addedPlayerData(): A function that returns any non-layer-related data that you want to be added to the save data and &quot;player&quot; object.</p></li></ul><div class="language-js vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">js</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">function</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> addedPlayerData</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">() { </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">return</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> weather: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;Yes&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> happiness: </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;">72</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">),</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}}</span></span></code></pre></div><ul><li><p>displayThings: An array of functions used to display extra things at the top of the tree tab. Each function returns a string, which is a line to display (with basic HTML support). If a function returns nothing, nothing is displayed (and it doesn&#39;t take up a line).</p></li><li><p>isEndgame(): A function to determine if the player has reached the end of the game, at which point the &quot;you win!&quot; screen appears.</p></li></ul><p>Less important things beyond this point!</p><ul><li>maxTickLength(): Returns the maximum tick length, in milliseconds. Only really useful if you have something that reduces over time, which long ticks mess up (usually a challenge).</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/anarchism" data-v-d4a0bba5><!--[--><span class="desc" data-v-d4a0bba5>Next page</span><span class="title" data-v-d4a0bba5>Anarchism</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><!----><!--[--><footer class="vp-doc" data-v-44029f47><div data-v-44029f47>CC 2024 <a class="h-card" rel="me" href="/about" data-v-44029f47><img src="/me.jpg" alt="" data-v-44029f47>The Paper Pilot</a>. <a rel="license" href="https://creativecommons.org/licenses/by-nc-sa/4.0/" data-v-44029f47>CC BY-NC-SA 4.0</a>.</div><div data-v-44029f47>Any and all opinions listed here are my own and not representative of my employers; future, past and present.</div><div data-v-44029f47><a href="https://resume.incremental.social/thepaperpilot/thepaperpilot" data-v-44029f47>Resume</a> (not actively seeking new opportunities).</div><div data-v-44029f47>Site built from <a href="https://code.incremental.social/thepaperpilot/pages/commit/1d40312517f46f87d46cff8f4af27ca0b60fa79c" data-v-44029f47>this commit</a> on <time data-v-44029f47>Friday, August 09, 2024 at 08:25:09</time>. <a href="https://www.thepaperpilot.org/licenses.txt" data-v-44029f47>Legal disclaimers</a>.</div></footer><!--]--></div></div>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"garden_garden-rss_index.md\":\"d-VCQhgl\",\"garden_abolitionism_index.md\":\"HjImmOqX\",\"garden_federated-identity_index.md\":\"DwtOttQ3\",\"garden_game-dev-tree_index.md\":\"DE3agj3d\",\"garden_anarchism_index.md\":\"CvuRo2_4\",\"garden_fedi-v2_index.md\":\"7IZyLMfv\",\"garden_commune_index.md\":\"DSUnilqG\",\"garden_atproto_index.md\":\"BCtowTOK\",\"garden_direct-democracy_index.md\":\"DTREMFCG\",\"about_index.md\":\"DNEsxkhw\",\"garden_digital-gardens_index.md\":\"ye7rN-4y\",\"garden_cinny_index.md\":\"CiQUotMu\",\"garden_logseq_index.md\":\"B10o7vfo\",\"changelog_index.md\":\"BDr1CQ2v\",\"public_gamedevtree_docs_challenges.md\":\"cvYq35wY\",\"public_gamedevtree_docs_updating-tmt.md\":\"Clk0TMnI\",\"garden_guide-to-incrementals_index.md\":\"w8V4Lxkj\",\"garden_opti-speech_index.md\":\"rImom0Pe\",\"garden_guide-to-incrementals_navigating-criticism_index.md\":\"DKa5fpPt\",\"garden_life-is-strange_index.md\":\"CHhgC4FB\",\"garden_incremental-social_index.md\":\"DWGgR578\",\"garden_representative-democracy_index.md\":\"DePKpU-m\",\"garden_synapse_index.md\":\"BHB2NDZF\",\"garden_the-cozy-web_index.md\":\"BNueo8_T\",\"garden_capture-the-citadel_index.md\":\"BrrCL1wl\",\"garden_open-source_index.md\":\"BC2g0v_5\",\"garden_advent-incremental_index.md\":\"CdAF0tdP\",\"garden_the-beginner-s-guide_index.md\":\"CNCAZIou\",\"garden_premium-currency_index.md\":\"Bo5SfVsH\",\"garden_mtx_index.md\":\"C9nQk47o\",\"garden_planar-pioneers_index.md\":\"B2V0Ey-p\",\"garden_chat-glue_index.md\":\"GjRtxZmS\",\"garden_mbin_index.md\":\"jEAOTFmS\",\"garden_command-palettes_index.md\":\"DPmU3boD\",\"garden_profectus_index.md\":\"iOV0eykS\",\"garden_activitypub_index.md\":\"Q0CEUTdo\",\"garden_babble-buds_index.md\":\"3HchoHT4\",\"garden_artificial-intelligence_index.md\":\"D8IuV0iE\",\"garden_consensus-democracy_index.md\":\"C8lkfycK\",\"garden_kronos_index.md\":\"DJlvB23W\",\"garden_matrix_index.md\":\"CaEKzDw6\",\"garden_nostr_index.md\":\"DPIFzQME\",\"garden_wanderstop_index.md\":\"p-xO-HcW\",\"garden_this-knowledge-hub_index.md\":\"Bnn_8wyP\",\"garden_vitepress_index.md\":\"B73LoyEy\",\"garden_my-projects_index.md\":\"TIm-5jxB\",\"garden_chronological_index.md\":\"Dmo7d-SF\",\"now_index.md\":\"DL4fCsp0\",\"public_gamedevtree_readme.md\":\"DVS2_5Qr\",\"garden_guide-to-incrementals_defining-the-genre_index.md\":\"CXRNYa3i\",\"public_gamedevtree_docs_bars.md\":\"CBtj98pG\",\"garden_my-personal-website_index.md\":\"UlWUATeX\",\"public_kronos_docs_clickables.md\":\"C1ENZgWW\",\"public_gamedevtree_docs_upgrades.md\":\"BspSzPzA\",\"public_kronos_docs_challenges.md\":\"DvQ_P73q\",\"garden_freeform-vs-chronological-dichotomy_index.md\":\"DTl6FHYn\",\"public_kronos_old things_2.0-format-changes.md\":\"BM0FXptY\",\"garden_davey-wreden_index.md\":\"BddJZ5s9\",\"public_kronos_docs_!general-info.md\":\"jKiOCSlr\",\"public_kronos_docs_layer-features.md\":\"C1uOzCZ-\",\"public_lit_docs_infoboxes.md\":\"C0nPRfky\",\"garden_pre-order-bonuses_index.md\":\"DjoQUv3i\",\"garden_decentralized_index.md\":\"K5mPhW5C\",\"garden_guide-to-incrementals_appeal-to-developers_index.md\":\"CGzOMsX-\",\"garden_freeform_index.md\":\"DuuiFcC3\",\"garden_guide-to-incrementals_appeal-to-players_index.md\":\"zCSel8sP\",\"garden_v-ecs_index.md\":\"D_X8I8_P\",\"public_lit_docs_layer-features.md\":\"DF81fjyw\",\"public_kronos_docs_trees-and-tree-customization.md\":\"bHBppIK5\",\"public_kronos_docs_subtabs-and-microtabs.md\":\"B3i34UtK\",\"public_lit_docs_achievements.md\":\"D0gRoIWt\",\"public_lit_docs_bars.md\":\"DFEFprv8\",\"public_lit_docs_getting-started.md\":\"BxRLZ8_n\",\"garden_ivy-road_index.md\":\"C8bh6gKg\",\"public_lit_docs_milestones.md\":\"CGwN80sv\",\"public_lit_docs_clickables.md\":\"CoIWXGHw\",\"garden_fediverse_index.md\":\"BuEqUtTv\",\"public_lit_docs_buyables.md\":\"DrqS8H2k\",\"public_kronos_docs_upgrades.md\":\"D1pH3BI1\",\"public_lit_docs_!general-info.md\":\"D2rjMfl1\",\"public_lit_docs_main-mod-info.md\":\"CcRWcMdS\",\"public_lit_docs_upgrades.md\":\"D1Ns9VTR\",\"public_lit_docs_challenges.md\":\"DtmSP6zf
</body>
</html>