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

35 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>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.DmIfVXia.css" as="style">
<script type="module" src="/assets/app.CUg-jexE.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.CsM8T_AH.js">
<link rel="modulepreload" href="/assets/chunks/theme.CQ2FI30M.js">
<link rel="modulepreload" href="/assets/public_lit_docs_main-mod-info.md.DRRZpczv.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-f6fd5357 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:#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/my-personal-website" data-v-d4a0bba5><!--[--><span class="desc" data-v-d4a0bba5>Next page</span><span class="title" data-v-d4a0bba5>My Personal Website</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><!----><!--[--><footer class="vp-doc" data-v-f6fd5357><div data-v-f6fd5357>CC 2024 The Paper Pilot. <a rel="license" href="https://creativecommons.org/licenses/by-nc-sa/4.0/" data-v-f6fd5357>CC BY-NC-SA 4.0</a>.</div><div data-v-f6fd5357>Any and all opinions listed here are my own and not representative of my employers; future, past and present.</div><div data-v-f6fd5357><a href="https://resume.incremental.social/thepaperpilot/thepaperpilot" data-v-f6fd5357>Resume</a> (not actively seeking new opportunities).</div><div data-v-f6fd5357>Site built from <a href="https://code.incremental.social/thepaperpilot/pages/commit/5632b8a6fd71754f0e7e2fc6ac9a1608b51e57da" data-v-f6fd5357>this commit</a> on <time data-v-f6fd5357>Monday, June 17, 2024 at 00:08:45</time>.</div></footer><!--]--></div></div>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"garden_activitypub_index.md\":\"BV59cLlG\",\"garden_advent-incremental_index.md\":\"BS9rAf-1\",\"garden_artificial-intelligence_index.md\":\"zTAA57sX\",\"garden_atproto_index.md\":\"CDsgaffu\",\"changelog_index.md\":\"01QXd8qO\",\"garden_babble-buds_index.md\":\"2TO6MC6H\",\"garden_chronological_index.md\":\"DPJgZOfj\",\"garden_capture-the-citadel_index.md\":\"CgUg9nJO\",\"garden_chat-glue_index.md\":\"CtC1nuRo\",\"garden_federated-identity_index.md\":\"RhhMqcR5\",\"garden_forgejo_index.md\":\"BVn9xNIG\",\"garden_freeform-vs-chronological-dichotomy_index.md\":\"eWvaR5LG\",\"garden_freeform_index.md\":\"CEtwJtQp\",\"garden_game-dev-tree_index.md\":\"V1pxiJ6L\",\"garden_commune_index.md\":\"Dw-ZwG9G\",\"garden_cinny_index.md\":\"e9Y6M4GO\",\"garden_command-palettes_index.md\":\"YDkY--Z9\",\"garden_davey-wreden_index.md\":\"CeB-NANC\",\"garden_decentralized_index.md\":\"DuGospk-\",\"garden_digital-gardens_index.md\":\"CViWKYjz\",\"garden_fedi-v2_index.md\":\"L9pux3Gb\",\"garden_this-knowledge-hub_index.md\":\"AyVyJZDZ\",\"garden_premium-currency_index.md\":\"D29QciSJ\",\"garden_the-cozy-web_index.md\":\"CvQSFAlk\",\"garden_social-media_index.md\":\"CwFSNRgj\",\"garden_the-beginner-s-guide_index.md\":\"bBlUJGOa\",\"garden_the-indieweb_signature-blocks_index.md\":\"HZYmu2wP\",\"garden_the-indieweb_amplification_index.md\":\"BTv5ugtq\",\"garden_the-small-web_index.md\":\"DovgqRM0\",\"garden_dice-armor_index.md\":\"DrCOvNY3\",\"garden_guide-to-incrementals_defining-the-genre_index.md\":\"D7Jq278G\",\"garden_synapse_index.md\":\"Dj86cLF0\",\"garden_garden-rss_index.md\":\"VgDaaUmh\",\"garden_nostr_index.md\":\"D9GgXcM5\",\"garden_incremental-social_index.md\":\"DvHIZZlT\",\"garden_matrix_index.md\":\"V9cXZC8-\",\"garden_my-personal-website_index.md\":\"B0wm2x7s\",\"garden_life-is-strange_index.md\":\"CcRTXc3G\",\"garden_mtx_index.md\":\"CoBR6azT\",\"garden_mbin_index.md\":\"BvexJqcK\",\"garden_my-projects_index.md\":\"Cjv9Uwos\",\"garden_guide-to-incrementals_index.md\":\"BBc_hYCl\",\"garden_planar-pioneers_index.md\":\"i4rnBqZt\",\"garden_guide-to-incrementals_what-is-content_index.md\":\"CUIN_xFH\",\"garden_guide-to-incrementals_appeal-to-players_index.md\":\"CQQAkpoq\",\"garden_open-source_index.md\":\"DW40BfSK\",\"garden_video-game-monetization_index.md\":\"vNfw2iDP\",\"public_gamedevtree_2.0-format-changes.md\":\"RKYFgQQ9\",\"garden_wanderstop_index.md\":\"BffmcnoL\",\"guide-to-incrementals_index.md\":\"_7jj99qf\",\"public_gamedevtree_readme.md\":\"lDjo0jHq\",\"public_gamedevtree_docs_bars.md\":\"DQqf-mF_\",\"public_gamedevtree_docs_milestones.md\":\"BNK2YMiG\",\"now_index.md\":\"Do_skiE-\",\"guide-to-incrementals_ludology_definition_index.md\":\"BuhQk41i\",\"public_gamedevtree_docs_main-mod-info.md\":\"C3ljTATd\",\"garden_ivy-road_index.md\":\"BpnIsnPz\",\"garden_guide-to-incrementals_appeal-to-developers_index.md\":\"PiTTC8-2\",\"garden_pre-order-bonuses_index.md\":\"D9RveayD\",\"garden_v-ecs_index.md\":\"Cfdfjqwk\",\"garden_fediverse_index.md\":\"Cll-9PdR\",\"garden_kronos_index.md\":\"C7rrzAAZ\",\"public_gamedevtree_docs_getting-started.md\":\"T7yT8BXV\",\"public_gamedevtree_docs_challenges.md\":\"CbQh7JEF\",\"guide-to-incrementals_ludology_appeal-developers_index.md\":\"DkiyDwlS\",\"garden_opti-speech_index.md\":\"CU6sA5m6\",\"public_gamedevtree_docs_buyables.md\":\"BdEyvHe3\",\"garden_logseq_index.md\":\"D898tAlt\",\"garden_guide-to-incrementals_navigating-criticism_index.md\":\"kkQBzeio\",\"public_gamedevtree_docs_basic-layer-breakdown.md\":\"CVnDvIuC\",\"public_gamedevtree_docs_achievements.md\":\"BAT-kcHv\",\"garden_webrings_index.md\":\"C_GVn4N5\",\"guide-to-incrementals_design_criticism_index.md\":\"DsK2Qz92\",\"garden_vitepress_index.md\":\"B5Rb4s8Q\",\"public_gamedevtree_docs_infoboxes.md\":\"D50pt2wd\",\"guide-to-incrementals_ludology_content_index.md\":\"CKSnnKKk\",\"index.md\":\"DDhfaQq8\",\"public_gamedevtree_docs_clickables.md\":\"BGp5D6_0\",\"public_gamedevtree_docs_custom-tab-layouts.md\":\"Cr7LxC03\",\"garden_weird_index.md\":\"DjGnP6eb\",\"public_gamed
</body>
</html>