profectus-docs/assets/api_interfaces_game_settings.Settings.md.e8f40252.js

import{_ as e,c as t,o as a,a as r}from"./app.ab34650d.js";const u=JSON.parse('{"title":"Interface: Settings","description":"","frontmatter":{"editLink":false},"headers":[{"level":2,"title":"Properties","slug":"properties"},{"level":3,"title":"active","slug":"active"},{"level":3,"title":"hideChallenges","slug":"hidechallenges"},{"level":3,"title":"msDisplay","slug":"msdisplay"},{"level":3,"title":"saves","slug":"saves"},{"level":3,"title":"showTPS","slug":"showtps"},{"level":3,"title":"theme","slug":"theme"},{"level":3,"title":"unthrottled","slug":"unthrottled"}],"relativePath":"api/interfaces/game/settings.Settings.md","lastUpdated":null}'),s={name:"api/interfaces/game/settings.Settings.md"},n=r('<h1 id="interface-settings" tabindex="-1">Interface: Settings <a class="header-anchor" href="#interface-settings" aria-hidden="true">#</a></h1><p><a href="./../../modules/game/settings.html">game/settings</a>.Settings</p><p>The player&#39;s settings object.</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-hidden="true">#</a></h2><h3 id="active" tabindex="-1">active <a class="header-anchor" href="#active" aria-hidden="true">#</a></h3><p>\u2022 <strong>active</strong>: <code>string</code></p><p>The ID of the active save.</p><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/game/settings.ts#L12" target="_blank" rel="noopener noreferrer">profectus/src/game/settings.ts:12</a></p><hr><h3 id="hidechallenges" tabindex="-1">hideChallenges <a class="header-anchor" href="#hidechallenges" aria-hidden="true">#</a></h3><p>\u2022 <strong>hideChallenges</strong>: <code>boolean</code></p><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/challenges/challenge.tsx#L291" target="_blank" rel="noopener noreferrer">profectus/src/features/challenges/challenge.tsx:291</a></p><hr><h3 id="msdisplay" tabindex="-1">msDisplay <a class="header-anchor" href="#msdisplay" aria-hidden="true">#</a></h3><p>\u2022 <strong>msDisplay</strong>: <a href="../../enums/features/milestones/milestone.MilestoneDisplay"><code>MilestoneDisplay</code></a></p><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/milestones/milestone.tsx#L170" target="_blank" rel="noopener noreferrer">profectus/src/features/milestones/milestone.tsx:170</a></p><hr><h3 id="saves" tabindex="-1">saves <a class="header-anchor" href="#saves" aria-hidden="true">#</a></h3><p>\u2022 <strong>saves</strong>: <code>string</code>[]</p><p>The IDs of all created saves.</p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/game/settings.ts#L14" target="_blank" rel="noopener noreferrer">profectus/src/game/settings.ts:14</a></p><hr><h3 id="showtps" tabindex="-1">showTPS <a class="header-anchor" href="#showtps" aria-hidden="true">#</a></h3><p>\u2022 <strong>showTPS</strong>: <code>boolean</code></p><p>Whether or not to show the current ticks per second in the lower left corner of the page.</p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/game/settings.ts#L16" target="_blank" rel="noopener noreferrer">profectus/src/game/settings.ts:16</a></p><hr><h3 id="theme" tabindex="-1">theme <a class="header-anchor" href="#theme" aria-hidden="true">#</a></h3><p>\u2022 <strong>theme</strong>: <a href="../../enums/data/themes.Themes"><code>Themes</code></a></p><p>The current theme to display the game in.</p><h4 id="defined-in-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/game/settings.ts#L18" target="_blank" rel="noopener noreferrer">profectus/src/game/settings.ts:18</a></p><hr><h3 id="unthrottled" tabindex="-1">unthrottled <a class="header-anchor" href="#unthrottled" aria-hidden="true">#</a></h3><p>\u2022 <strong>unthrottled</strong>: <code>boolean</code></p><p>Whether or not to cap the project at 20 ticks per second.</p><h4 id="defined-in-6" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-6" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/game/settings.ts#L20" target="_blank" rel="noopener noreferrer">profectus/src/game/settings.ts:20</a></p>',43),i=[n];function h(o,d,c,l,p,f){return a(),t("div",null,i)}var m=e(s,[["render",h]]);export{u as __pageData,m as default};