27 lines
13 KiB
JavaScript
27 lines
13 KiB
JavaScript
import{_ as s,o as a,c as o,Q as t}from"./chunks/framework.1169fbc9.js";const d=JSON.parse('{"title":"Custom tab layouts","description":"","frontmatter":{},"headers":[],"relativePath":"public/kronos/docs/custom-tab-layouts.md","filePath":"public/kronos/docs/custom-tab-layouts.md","lastUpdated":1701136977000}'),n={name:"public/kronos/docs/custom-tab-layouts.md"},e=t(`<h1 id="custom-tab-layouts" tabindex="-1">Custom tab layouts <a class="header-anchor" href="#custom-tab-layouts" aria-label="Permalink to "Custom tab layouts""></a></h1><p>Note: If you are using subtabs, <code>tabFormat</code> is used differently, but the same format is used for defining their layouts. <a href="./subtabs-and-microtabs">See here for more on subtabs</a>.</p><p>Custom tab layouts can be used to do basically anything in a tab window, especially combined with the "style" layer feature. The <code>tabFormat</code> feature is an array of things, like this:</p><div class="language-js vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">js</span><pre class="shiki github-dark vp-code-dark"><code><span class="line"><span style="color:#B392F0;">tabFormat</span><span style="color:#E1E4E8;">: [</span></span>
|
||
<span class="line"><span style="color:#E1E4E8;"> </span><span style="color:#9ECBFF;">"main-display"</span><span style="color:#E1E4E8;">,</span></span>
|
||
<span class="line"><span style="color:#E1E4E8;"> [</span><span style="color:#9ECBFF;">"prestige-button"</span><span style="color:#E1E4E8;">, </span><span style="color:#F97583;">function</span><span style="color:#E1E4E8;">() { </span><span style="color:#F97583;">return</span><span style="color:#E1E4E8;"> </span><span style="color:#9ECBFF;">"Melt your points into "</span><span style="color:#E1E4E8;"> }],</span></span>
|
||
<span class="line"><span style="color:#E1E4E8;"> </span><span style="color:#9ECBFF;">"blank"</span><span style="color:#E1E4E8;">,</span></span>
|
||
<span class="line"><span style="color:#E1E4E8;"> [</span><span style="color:#9ECBFF;">"display-text"</span><span style="color:#E1E4E8;">,</span></span>
|
||
<span class="line"><span style="color:#E1E4E8;"> </span><span style="color:#F97583;">function</span><span style="color:#E1E4E8;">() { </span><span style="color:#F97583;">return</span><span style="color:#E1E4E8;"> </span><span style="color:#9ECBFF;">'I have '</span><span style="color:#E1E4E8;"> </span><span style="color:#F97583;">+</span><span style="color:#E1E4E8;"> </span><span style="color:#B392F0;">format</span><span style="color:#E1E4E8;">(player.points) </span><span style="color:#F97583;">+</span><span style="color:#E1E4E8;"> </span><span style="color:#9ECBFF;">' pointy points!'</span><span style="color:#E1E4E8;"> },</span></span>
|
||
<span class="line"><span style="color:#E1E4E8;"> { </span><span style="color:#9ECBFF;">"color"</span><span style="color:#E1E4E8;">: </span><span style="color:#9ECBFF;">"red"</span><span style="color:#E1E4E8;">, </span><span style="color:#9ECBFF;">"font-size"</span><span style="color:#E1E4E8;">: </span><span style="color:#9ECBFF;">"32px"</span><span style="color:#E1E4E8;">, </span><span style="color:#9ECBFF;">"font-family"</span><span style="color:#E1E4E8;">: </span><span style="color:#9ECBFF;">"Comic Sans MS"</span><span style="color:#E1E4E8;"> }],</span></span>
|
||
<span class="line"><span style="color:#E1E4E8;"> </span><span style="color:#9ECBFF;">"blank"</span><span style="color:#E1E4E8;">,</span></span>
|
||
<span class="line"><span style="color:#E1E4E8;"> [</span><span style="color:#9ECBFF;">"toggle"</span><span style="color:#E1E4E8;">, [</span><span style="color:#9ECBFF;">"c"</span><span style="color:#E1E4E8;">, </span><span style="color:#9ECBFF;">"beep"</span><span style="color:#E1E4E8;">]],</span></span>
|
||
<span class="line"><span style="color:#E1E4E8;"> </span><span style="color:#9ECBFF;">"milestones"</span><span style="color:#E1E4E8;">,</span></span>
|
||
<span class="line"><span style="color:#E1E4E8;"> </span><span style="color:#9ECBFF;">"blank"</span><span style="color:#E1E4E8;">,</span></span>
|
||
<span class="line"><span style="color:#E1E4E8;"> </span><span style="color:#9ECBFF;">"blank"</span><span style="color:#E1E4E8;">,</span></span>
|
||
<span class="line"><span style="color:#E1E4E8;"> </span><span style="color:#9ECBFF;">"upgrades"</span></span>
|
||
<span class="line"><span style="color:#E1E4E8;">]</span></span></code></pre><pre class="shiki github-light vp-code-light"><code><span class="line"><span style="color:#6F42C1;">tabFormat</span><span style="color:#24292E;">: [</span></span>
|
||
<span class="line"><span style="color:#24292E;"> </span><span style="color:#032F62;">"main-display"</span><span style="color:#24292E;">,</span></span>
|
||
<span class="line"><span style="color:#24292E;"> [</span><span style="color:#032F62;">"prestige-button"</span><span style="color:#24292E;">, </span><span style="color:#D73A49;">function</span><span style="color:#24292E;">() { </span><span style="color:#D73A49;">return</span><span style="color:#24292E;"> </span><span style="color:#032F62;">"Melt your points into "</span><span style="color:#24292E;"> }],</span></span>
|
||
<span class="line"><span style="color:#24292E;"> </span><span style="color:#032F62;">"blank"</span><span style="color:#24292E;">,</span></span>
|
||
<span class="line"><span style="color:#24292E;"> [</span><span style="color:#032F62;">"display-text"</span><span style="color:#24292E;">,</span></span>
|
||
<span class="line"><span style="color:#24292E;"> </span><span style="color:#D73A49;">function</span><span style="color:#24292E;">() { </span><span style="color:#D73A49;">return</span><span style="color:#24292E;"> </span><span style="color:#032F62;">'I have '</span><span style="color:#24292E;"> </span><span style="color:#D73A49;">+</span><span style="color:#24292E;"> </span><span style="color:#6F42C1;">format</span><span style="color:#24292E;">(player.points) </span><span style="color:#D73A49;">+</span><span style="color:#24292E;"> </span><span style="color:#032F62;">' pointy points!'</span><span style="color:#24292E;"> },</span></span>
|
||
<span class="line"><span style="color:#24292E;"> { </span><span style="color:#032F62;">"color"</span><span style="color:#24292E;">: </span><span style="color:#032F62;">"red"</span><span style="color:#24292E;">, </span><span style="color:#032F62;">"font-size"</span><span style="color:#24292E;">: </span><span style="color:#032F62;">"32px"</span><span style="color:#24292E;">, </span><span style="color:#032F62;">"font-family"</span><span style="color:#24292E;">: </span><span style="color:#032F62;">"Comic Sans MS"</span><span style="color:#24292E;"> }],</span></span>
|
||
<span class="line"><span style="color:#24292E;"> </span><span style="color:#032F62;">"blank"</span><span style="color:#24292E;">,</span></span>
|
||
<span class="line"><span style="color:#24292E;"> [</span><span style="color:#032F62;">"toggle"</span><span style="color:#24292E;">, [</span><span style="color:#032F62;">"c"</span><span style="color:#24292E;">, </span><span style="color:#032F62;">"beep"</span><span style="color:#24292E;">]],</span></span>
|
||
<span class="line"><span style="color:#24292E;"> </span><span style="color:#032F62;">"milestones"</span><span style="color:#24292E;">,</span></span>
|
||
<span class="line"><span style="color:#24292E;"> </span><span style="color:#032F62;">"blank"</span><span style="color:#24292E;">,</span></span>
|
||
<span class="line"><span style="color:#24292E;"> </span><span style="color:#032F62;">"blank"</span><span style="color:#24292E;">,</span></span>
|
||
<span class="line"><span style="color:#24292E;"> </span><span style="color:#032F62;">"upgrades"</span></span>
|
||
<span class="line"><span style="color:#24292E;">]</span></span></code></pre></div><p>It is a list of components, which can be either just a name, or an array with arguments. If it's an array, the first item is the name of the component, the second is the data passed into it, and the third (optional) applies a CSS style to it with a "CSS object", where the keys are CSS attributes.</p><p>These are the existing components, but you can create more in <a href="/js/components.js">components.js</a>:</p><ul><li><p>display-text: Displays some text (can use basic HTML). The argument is the text to display. It can also be a function that returns updating text.</p></li><li><p>raw-html: Displays some basic HTML, can also be a function.</p></li><li><p>blank: Adds empty space. The default dimensions are 8px x 17px. The argument changes the dimensions. If it's a single value (e.g. "20px"), that determines the height. If you have a pair of arguments, the first is width and the second is height.</p></li><li><p>row: Display a list of components horizontally. The argument is an array of components in the tab layout format.</p></li><li><p>column: Display a list of components vertically. The argument is an array of components in the tab layout format. This is useful to display columns within a row.</p></li><li><p>main-display: The text that displays the main currency for the layer and its effects. The argument is the amount of precision to use, allowing it to display non-whole numbers.</p></li><li><p>resource-display: The text that displays the currency that this layer is based on, as well as the best and/or total values for this layer's prestige currency (if they are put in <code>startData</code> for this layer).</p></li><li><p>prestige-button: The argument is a string that the prestige button should say before the amount of currency you will gain. It can also be a function that returns updating text.</p></li><li><p>text-input: A text input box. The argument is the name of the variable in player[layer] that the input is for, player[layer][argument] (Works with strings, numbers, and Decimals!)</p></li><li><p>slider: Lets the user input a value with a slider. The argument a 3-element array: [name, min, max]. The name is the name of the variable in player[layer] that the input that the input is for, and min and max are the limits of the slider. (Does not work for Decimal values)</p></li><li><p>upgrades: The layer's upgrades. The argument is optional, and is a the list of rows this component should include, if it doesn't have all of them.</p></li><li><p>milestones, challenges, achievements: Display the upgrades, milestones, and challenges for a layer, as appropriate.</p></li><li><p>buyables, clickables: Display all of the buyables/clickables for this layer, as appropriate. The argument is optional and is the size of the boxes in pixels.</p></li><li><p>microtabs: Display a set of subtabs for an area. The argument is the name of the set of microtabs in the "microtabs" feature.</p></li><li><p>bar: Display a bar. The argument is the id of the bar to display.</p></li><li><p>infobox: Display an infobox. The argument is the id of the infobox to display.</p></li><li><p>tree: Displays a tree. The argument is an array of arrays containing the names of the nodes in the tree (first by row, then by column) <a href="./trees-and-tree-customization">See here for more information on tree layouts and nodes!</a></p></li><li><p>toggle: A toggle button that toggles a bool value. The argument is a pair that identifies the location in player of the bool to toggle, e.g. <code>[layer, id]</code>. 'layer' also affects the color of the toggle.</p></li><li><p>grid: Displays the gridable grid for the layer. If you need more than one grid, use a layer proxy.</p></li><li><p>layer-proxy: Lets you use components from another layer. The argument is a pair, <code>[layer, data]</code>, consisting of the id of the layer to proxy from, and the tabFormat for the components to show. (Note: you cannot use a microtab within a layer proxy)</p></li></ul><p>The rest of the components are sub-components. They can be used just like other components, but are typically part of another component.</p><ul><li><p>upgrade, milestone, challenge, buyable, clickable, achievement, gridable: An individual upgrade, challenge, etc. The argument is the id. This can be used if you want to have upgrades split up across multiple subtabs, for example.</p></li><li><p>respec-button, master-button: The respec and master buttons for buyables and clickables, respectively.</p></li><li><p>sell-one, sell-all: The "sell one" and "sell all" for buyables, respectively. The argument is the id of the buyable.</p></li></ul>`,9),l=[e];function p(r,i,c,y,u,E){return a(),o("div",null,l)}const m=s(n,[["render",p]]);export{d as __pageData,m as default};
|