immersive-home/docs/reference/lib--stores--settings.md

66 lines
2.2 KiB
Markdown
Raw Normal View History

2024-03-16 19:45:43 +02:00
# Settings
**Inherits:** [Store](/reference/lib--stores--store.html)
2024-03-16 19:45:43 +02:00
2024-03-17 01:14:31 +02:00
## Description
2024-03-16 19:45:43 +02:00
2024-03-17 01:14:31 +02:00
Stores general settings for the app
2024-03-16 19:45:43 +02:00
## Properties
2024-03-18 14:30:37 +02:00
| Name | Type | Default |
| ------------------------------------------------ | ----------------------------------------------------------------------- | ----------- |
| [onboarding_complete](#prop-onboarding-complete) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | `false` |
| [token](#prop-token) | [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) | `""` |
| [type](#prop-type) | [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) | `"HASS_WS"` |
| [url](#prop-url) | [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) | `""` |
| [voice_assistant](#prop-voice-assistant) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | `false` |
2024-03-16 19:45:43 +02:00
## Methods
| Returns | Name |
| ------- | -------------------- |
| void | [_init](#-init) ( ) |
| void | [clear](#clear) ( ) |
2024-03-17 01:14:31 +02:00
## Constants
### StoreClass = `<Object>` {#const-StoreClass}
No description provided yet.
2024-03-16 19:45:43 +02:00
## Property Descriptions
2024-03-18 14:30:37 +02:00
### onboarding_complete: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#prop-onboarding-complete}
If the onboarding process has been completed
2024-03-17 01:14:31 +02:00
### token: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#prop-token}
2024-03-16 19:45:43 +02:00
No description provided yet.
2024-03-17 01:14:31 +02:00
### type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#prop-type}
2024-03-16 19:45:43 +02:00
2024-03-17 01:14:31 +02:00
The adapter to use for connecting with a backend
2024-03-16 19:45:43 +02:00
2024-03-17 01:14:31 +02:00
### url: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#prop-url}
2024-03-16 19:45:43 +02:00
No description provided yet.
2024-03-17 01:14:31 +02:00
### voice_assistant: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#prop-voice-assistant}
2024-03-16 19:45:43 +02:00
2024-03-17 01:14:31 +02:00
If the voice assistant should be enabled
2024-03-16 19:45:43 +02:00
## Method Descriptions
2024-03-17 01:14:31 +02:00
### _init ( ) -> void {#-init}
2024-03-16 19:45:43 +02:00
No description provided yet.
2024-03-17 01:14:31 +02:00
### clear ( ) -> void {#clear}
2024-03-16 19:45:43 +02:00
No description provided yet.