ProfectusModule: game/settings
Interfaces
Settings
• Settings: Object
The player's settings object.
| Name | Type | Description |
|---|---|---|
active | string | The ID of the active save. |
alignUnits | boolean | Whether to align modifiers to the unit. |
hideChallenges | boolean | - |
msDisplay | AchievementDisplay | - |
saves | string[] | The IDs of all created saves. |
showTPS | boolean | Whether or not to show the current ticks per second in the lower left corner of the page. |
theme | Themes | The current theme to display the game in. |
unthrottled | boolean | Whether or not to cap the project at 20 ticks per second. |
Defined in
profectus/src/game/settings.ts:10
profectus/src/features/achievements/achievement.tsx:295
profectus/src/features/challenges/challenge.tsx:358
Variables
default
• default: Settings
The player settings object. Stores data that persists across all saves. Automatically saved to localStorage whenever changed.
Defined in
profectus/src/game/settings.ts:56
gameComponents
• Const gameComponents: CoercableComponent[]
A list of components to add to the root of the page.
Defined in
profectus/src/game/settings.ts:119
infoComponents
• Const infoComponents: CoercableComponent[]
A list of components to show in the info modal.
Defined in
profectus/src/game/settings.ts:112
settingFields
• Const settingFields: CoercableComponent[]
A list of fields to append to the settings modal.
Defined in
profectus/src/game/settings.ts:105
Functions
hardResetSettings
▸ hardResetSettings(): void
A function that erases all player settings, including all saves.
Returns
void
Defined in
profectus/src/game/settings.ts:58
loadSettings
▸ loadSettings(): void
Loads the player settings from localStorage. Calls the GlobalEvents.loadSettings event for custom properties to be included. Custom properties should be added by the file they relate to, so they won't be included if the file is tree shaken away. Custom properties should also register the field to modify said setting using registerSettingField.
Returns
void
Defined in
profectus/src/game/settings.ts:77
registerGameComponent
▸ registerGameComponent(component): void
Register a component to be displayed at the root of the page.
Parameters
| Name | Type |
|---|---|
component | CoercableComponent |
Returns
void
Defined in
profectus/src/game/settings.ts:121
registerInfoComponent
▸ registerInfoComponent(component): void
Register a component to be displayed in the info modal.
Parameters
| Name | Type |
|---|---|
component | CoercableComponent |
Returns
void
Defined in
profectus/src/game/settings.ts:114
registerSettingField
▸ registerSettingField(component): void
Register a field to be displayed in the settings modal.
Parameters
| Name | Type |
|---|---|
component | CoercableComponent |
Returns
void