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

import{_ as e,c as t,o as a,N as r}from"./chunks/framework.0799945b.js";const u=JSON.parse('{"title":"Interface: Settings","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/game/settings.Settings.md","lastUpdated":null}'),n={name:"api/interfaces/game/settings.Settings.md"},s=r('<h1 id="interface-settings" tabindex="-1">Interface: Settings <a class="header-anchor" href="#interface-settings" aria-label="Permalink to &quot;Interface: Settings&quot;">​</a></h1><p><a href="./../../modules/game/settings">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-label="Permalink to &quot;Properties&quot;">​</a></h2><h3 id="active" tabindex="-1">active <a class="header-anchor" href="#active" aria-label="Permalink to &quot;active&quot;">​</a></h3><p>• <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-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/game/settings.ts#L12" target="_blank" rel="noreferrer">profectus/src/game/settings.ts:12</a></p><hr><h3 id="alignunits" tabindex="-1">alignUnits <a class="header-anchor" href="#alignunits" aria-label="Permalink to &quot;alignUnits&quot;">​</a></h3><p>• <strong>alignUnits</strong>: <code>boolean</code></p><p>Whether to align modifiers to the unit.</p><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/game/settings.ts#L22" target="_blank" rel="noreferrer">profectus/src/game/settings.ts:22</a></p><hr><h3 id="hidechallenges" tabindex="-1">hideChallenges <a class="header-anchor" href="#hidechallenges" aria-label="Permalink to &quot;hideChallenges&quot;">​</a></h3><p>• <strong>hideChallenges</strong>: <code>boolean</code></p><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/challenges/challenge.tsx#L345" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:345</a></p><hr><h3 id="msdisplay" tabindex="-1">msDisplay <a class="header-anchor" href="#msdisplay" aria-label="Permalink to &quot;msDisplay&quot;">​</a></h3><p>• <strong>msDisplay</strong>: <a href="../../enums/features/achievements/achievement.AchievementDisplay"><code>AchievementDisplay</code></a></p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/achievements/achievement.tsx#L270" target="_blank" rel="noreferrer">profectus/src/features/achievements/achievement.tsx:270</a></p><hr><h3 id="saves" tabindex="-1">saves <a class="header-anchor" href="#saves" aria-label="Permalink to &quot;saves&quot;">​</a></h3><p>• <strong>saves</strong>: <code>string</code>[]</p><p>The IDs of all created saves.</p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/game/settings.ts#L14" target="_blank" rel="noreferrer">profectus/src/game/settings.ts:14</a></p><hr><h3 id="showtps" tabindex="-1">showTPS <a class="header-anchor" href="#showtps" aria-label="Permalink to &quot;showTPS&quot;">​</a></h3><p>• <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-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/game/settings.ts#L16" target="_blank" rel="noreferrer">profectus/src/game/settings.ts:16</a></p><hr><h3 id="theme" tabindex="-1">theme <a class="header-anchor" href="#theme" aria-label="Permalink to &quot;theme&quot;">​</a></h3><p>• <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-6" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-6" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/game/settings.ts#L18" target="_blank" rel="noreferrer">profectus/src/game/settings.ts:18</a></p><hr><h3 id="unthrottled" tabindex="-1">unthrottled <a class="header-anchor" href="#unthrottled" aria-label="Permalink to &quot;unthrottled&quot;">​</a></h3><p>• <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-7" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-7" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/game/settings.ts#L20" target="_blank" rel="noreferrer">profectus/src/game/settings.ts:20</a></p>',49),i=[s];function o(h,c,d,l,f,p){return a(),t("div",null,i)}const m=e(n,[["render",o]]);export{u as __pageData,m as default};