alexandru.stanciu/immersive-home
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

update and fix reference docs

Browse Source
This commit is contained in:
Nitwel 2024-03-17 00:14:31 +01:00
parent 17d1ad9ae4
commit ae4fca328a
68 changed files with 798 additions and 643 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
app/lib/events/event.gd
View File

@ -1,6 +1,8 @@
extends Resource
## Base class for all events
class_name Event
## Merges the current event with another event. This is used in the EventSystem internally.
func merge(event: Event):
assert(self.is_class(event.get_class()), "Can only merge events of the same type.")

6
app/lib/events/event_action.gd
View File

@ -1,6 +1,10 @@
extends Event
## EventAction is emitted when the user presses a button or trigger on the controller.
class_name EventAction
## The name of the action that was triggered.
var name: String
## True if the right controller triggered the action, false if the left controller triggered the action.
var right_controller: bool
var value # Boolean, Float or Vector2
## Boolean, Float or Vector2
var value

3
app/lib/events/event_bubble.gd
View File

@ -1,5 +1,8 @@
extends Event
## Abstract Event to represent events that move "bubble" up the Node tree.
class_name EventBubble
## If set to false, the event will stop bubbling up the Node tree.
var bubbling := true
## The Node that caused the event to start.
var target: Node

3
app/lib/events/event_focus.gd
View File

@ -1,5 +1,8 @@
extends Event
## Emitted when a Node with the `ui_focus` group is focused or unfocused.
class_name EventFocus
## The Node that is being focused or unfocused.
var target: Node
## The Node that was previously focused or unfocused.
var previous_target: Node

4
app/lib/events/event_key.gd
View File

@ -1,9 +1,13 @@
extends EventWithModifiers
## Events emitted by the Virtual Keyboard
class_name EventKey
## The key that was pressed or released
var key: Key
## true if the event is repeated due to a key being held down for a while
var echo: bool
## Modifies a string based on the key pressed
static func key_to_string(key: Key, caps: bool=false, apply_to: String="") -> String:
match key:
KEY_INSERT: apply_to += DisplayServer.clipboard_get()

8
app/lib/events/event_notify.gd
View File

@ -1,12 +1,20 @@
extends Event
## Emits a message to the user
class_name EventNotify
enum Type {
## The message is informational
INFO,
## The message is a success message
SUCCESS,
## The message is a warning
WARNING,
## The message is an error
DANGER
}
## The message to emit
var message: String
## The type of message to emit
var type: Type

3
app/lib/events/event_pointer.gd
View File

@ -1,7 +1,10 @@
extends EventBubble
## Triggered when the raycast of the controller or hand hits or clicks on an object.
class_name EventPointer
const Initiator = preload ("res://lib/utils/pointer/initiator.gd")
## Either the controller or the hand that triggered the event.
var initiator: Initiator
## The raycast that collided with the target.
var ray: RayCast3D

3
app/lib/events/event_touch.gd
View File

@ -1,10 +1,13 @@
extends EventBubble
## Emitted when a finger enters or leaves a FingerArea.
class_name EventTouch
const Finger = preload ("res://lib/utils/touch/finger.gd")
## The list of fingers that are currently in the area.
var fingers: Array[Finger] = []
## Checks if a specific finger is currently in the area.
func has_finger(finger: Finger.Type):
for f in fingers:
if f.type == finger:

1
app/lib/events/event_with_modifiers.gd
View File

@ -1,4 +1,5 @@
extends Event
## Base for Events using a Keyboard
class_name EventWithModifiers
var alt_pressed := false

9
app/lib/globals/audio_player.gd
View File

@ -1,13 +1,14 @@
extends AudioStreamPlayer
var click_sound = preload("res://assets/sound/click.wav")
var spawn_sound = preload("res://assets/sound/spawn.wav")
var open_menu = preload("res://assets/sound/open_menu.wav")
var close_menu = preload("res://assets/sound/close_menu.wav")
const click_sound = preload ("res://assets/sound/click.wav")
const spawn_sound = preload ("res://assets/sound/spawn.wav")
const open_menu = preload ("res://assets/sound/open_menu.wav")
const close_menu = preload ("res://assets/sound/close_menu.wav")
func _ready():
volume_db = -18
## Plays a given sound effect
func play_effect(sound):
if sound == "click":
stream = click_sound

32
app/lib/globals/event_system.gd
View File

@ -1,36 +1,62 @@
extends Node
## Prefix for the function names to be called
const FN_PREFIX = "_on_"
## Prefix for the signal names to be emitted
const SIGNAL_PREFIX = "on_"
## Tick rate for the slow tick event
const SLOW_TICK = 0.1
# Interaction Events
## Emitted when a node is clicked
signal on_click(event: EventPointer)
## Emitted when a node is pressed down
signal on_press_down(event: EventPointer)
## Emitted when a node is moved while pressed
signal on_press_move(event: EventPointer)
## Emitted when a node is released
signal on_press_up(event: EventPointer)
## Emitted when a node is grabbed
signal on_grab_down(event: EventPointer)
## Emitted when a node is moved while grabbed
signal on_grab_move(event: EventPointer)
## Emitted when a node is released from being grabbed
signal on_grab_up(event: EventPointer)
## Emitted when a node is hovered
signal on_ray_enter(event: EventPointer)
## Emitted when a node is no longer hovered
signal on_ray_leave(event: EventPointer)
## Emitted when a key on the virtual keyboard is pressed
signal on_key_down(event: EventKey)
## Emitted when a key on the virtual keyboard is released
signal on_key_up(event: EventKey)
## Emitted when a button on the controller is pressed
signal on_action_down(event: EventAction)
## Emitted when a button on the controller is released
signal on_action_up(event: EventAction)
## Emitted when a value changes on the controller (e.g. joystick)
signal on_action_value(event: EventAction)
## Emitted when the node gains focus
signal on_focus_in(event: EventFocus)
## Emitted when the node loses focus
signal on_focus_out(event: EventFocus)
## Emitted when a finger enters a TouchArea
signal on_touch_enter(event: EventTouch)
## Emitted when a finger moves inside a TouchArea
signal on_touch_move(event: EventTouch)
## Emitted when a finger leaves a TouchArea
signal on_touch_leave(event: EventTouch)
## Emitted when a message is sent to the user
signal on_notify(event: EventNotify)
## Emitted when the slow tick event occurs
signal on_slow_tick(delta: float)
var _slow_tick: float = 0.0
@ -42,18 +68,21 @@ func _physics_process(delta):
var _active_node: Node = null
## Emits an event to the node tree
func emit(type: String, event: Event):
if event is EventBubble:
_bubble_call(type, event.target, event)
else:
_root_call(type, event)
## Shortcut for sending a notification
func notify(message: String, type:=EventNotify.Type.INFO):
var event = EventNotify.new()
event.message = message
event.type = type
emit("notify", event)
## Returns true when the node is focused
func is_focused(node: Node):
return _active_node == node
@ -115,6 +144,5 @@ func _bubble_call(type: String, target: Variant, event: EventBubble, focused = f
return true
func _root_call(type: String, event: Event):
get(SIGNAL_PREFIX + type).emit(event)

8
app/lib/globals/home_api.gd
View File

@ -1,4 +1,5 @@
extends Node
## Manages the connection to the home automation system and provides a unified interface to the different home automation systems.
const Hass = preload ("res://lib/home_apis/hass/hass.gd")
const HassWebSocket = preload ("res://lib/home_apis/hass_ws/hass.gd")
@ -16,8 +17,13 @@ const methods = [
"watch_state"
]
## Emitted when the connection to the home automation system is established
signal on_connect()
## Emitted when the connection to the home automation system is lost
signal on_disconnect()
## The current home automation system adapter
var api: Node
func _ready():
@ -28,6 +34,7 @@ func _ready():
if success:
start_adapter(Store.settings.type.to_lower(), Store.settings.url, Store.settings.token)
## Starts the adapter for the given type and url
func start_adapter(type: String, url: String, token: String):
print("Starting adapter: %s" % type)
if api != null:
@ -58,6 +65,7 @@ func _on_connect():
func _on_disconnect():
on_disconnect.emit()
## Returns true if the adapter is connected to the home automation system
func has_connected():
if api == null:
return false

1
app/lib/globals/house_body.gd
View File

@ -1,3 +1,4 @@
extends Node
## Shortcut to get the House node from the Main scene
@onready var body = get_node_or_null("/root/Main/House")

1
app/lib/globals/main_store.gd
View File

@ -1,4 +1,5 @@
extends Node
## Collection of all the stores to save the state persistently
const SettingsStore = preload ("res://lib/stores/settings.gd")
const HouseStore = preload ("res://lib/stores/house.gd")

20
app/lib/stores/house.gd
View File

@ -1,22 +1,22 @@
extends StoreClass
## Stores information about the house, its rooms and entities
const StoreClass = preload ("./store.gd")
# Type Room
# name: String
# corners: Vec2[]
# height: float
## Type Room
## name: String
## corners: Vec2[]
## height: float
var rooms = []
# Type Entity
# id: String
# position: Vec3
# rotation: Vec3
# room: String
## Type Entity
## id: String
## position: Vec3
## rotation: Vec3
## room: String
var entities = []
var align_position1: Vector3
var align_position2: Vector3
func _init():
_save_path = "user://house.json"

4
app/lib/stores/settings.gd
View File

@ -1,10 +1,14 @@
extends StoreClass
## Stores general settings for the app
const StoreClass = preload ("./store.gd")
## The adapter to use for connecting with a backend
var type: String = "HASS_WS"
var url: String = ""
var token: String = ""
## If the voice assistant should be enabled
var voice_assistant: bool = false
func _init():

6
app/lib/stores/store.gd
View File

@ -1,16 +1,22 @@
extends RefCounted
## Abstract class for saving and loading data to and from a file.
const VariantSerializer = preload ("res://lib/utils/variant_serializer.gd")
## Signal emitted when the data is loaded.
signal on_loaded
## Signal emitted when the data is saved.
signal on_saved
var _loaded = false
var _save_path = null
## Returns true if the data has been loaded.
func is_loaded():
return _loaded
## Resets the data to its default state.
func clear():
pass

1
app/lib/utils/entity_factory.gd
View File

@ -1,5 +1,6 @@
extends RefCounted
class_name EntityFactory
## This class is used to create entities based on their type
const Switch = preload ("res://content/entities/switch/switch.tscn")
const Light = preload ("res://content/entities/light/light.tscn")

1
app/lib/utils/font_tools.gd
View File

@ -1,3 +1,4 @@
## Returns the size of a Label3D in standard units
static func get_font_size(label: Label3D, chars=null):
var font = label.font

1
app/lib/utils/pointer/initiator.gd
View File

@ -1,4 +1,5 @@
extends RefCounted
## Defines what triggered a EventPointer
enum Type {
CONTROLLER_LEFT,

1
app/lib/utils/pointer/pointer.gd
View File

@ -1,4 +1,5 @@
extends Node
## Logic for the raycast to interact with objects
const Initiator = preload ("./initiator.gd")

4
app/lib/utils/proxy.gd
View File

@ -1,4 +1,5 @@
extends RefCounted
## A simple proxy class to allow for easy binding of a property to a function call.
class_name Proxy
signal on_set(new_value: Variant)
@ -10,12 +11,9 @@ func _init(gettable: Callable, settable: Callable):
self.gettable = gettable
self.settable = settable
var value: Variant:
get:
return gettable.call()
set(new_value):
settable.call(new_value)
on_set.emit(new_value)

1
app/lib/utils/proxy_group.gd
View File

@ -1,4 +1,5 @@
extends RefCounted
## A group of proxies that will be updated when one of them is updated
class_name ProxyGroup
var proxies = []

1
app/lib/utils/sample_hold.gd
View File

@ -1,3 +1,4 @@
## Reduces the frequency of a signal by sampling and holding the data
static func sample_and_hold(data: PackedVector2Array, sample_rate: float) -> PackedFloat32Array:
var new_data: PackedFloat32Array = PackedFloat32Array()
new_data.resize(int(data.size() / sample_rate))

1
app/lib/utils/state_machine/state.gd
View File

@ -1,4 +1,5 @@
extends Node
## Base Class for all states
class_name State
var state_machine: StateMachine

5
app/lib/utils/state_machine/state_machine.gd
View File

@ -1,5 +1,6 @@
class_name StateMachine
extends Node
## Abstract class for a state machine
class_name StateMachine
signal changed(state_name: String, old_state: String)
@ -18,6 +19,7 @@ func _ready() -> void:
current_state._on_enter()
## Change the current state to the new state
func change_to(new_state: String) -> void:
if states.has(new_state) == false:
return
@ -31,6 +33,7 @@ func change_to(new_state: String) -> void:
current_state._on_enter()
changed.emit(new_state, old_state)
## Get the state with the given name
func get_state(state_name: String) -> Node:
if states.has(state_name) == false:
return null

1
app/lib/utils/touch/collide.gd
View File

@ -1,4 +1,5 @@
extends Node3D
## Calculates collision for fingers and FingerAreas
const Finger = preload ("res://lib/utils/touch/finger.gd")

1
app/lib/utils/touch/finger.gd
View File

@ -1,4 +1,5 @@
extends RefCounted
## Description of a finger area.
enum Type {
THUMB_RIGHT,

1
app/lib/utils/touch/touch.gd
View File

@ -1,4 +1,5 @@
extends Node
## Handles touch events and emits them to the EventSystem
const Finger = preload ("res://lib/utils/touch/finger.gd")

2
app/lib/utils/variant_serializer.gd
View File

@ -1,5 +1,6 @@
extends Object
## Convert a dictionary to be able to be serialized to JSON.
static func stringify_value(value):
match typeof(value):
TYPE_DICTIONARY:
@ -50,6 +51,7 @@ static func stringify_value(value):
_:
assert(false, "Unsupported type: %s" % typeof(value))
## Restore a dictionary from a JSON-serialized dictionary.
static func parse_value(value):
if typeof(value) == TYPE_ARRAY:
return value.map(func(item):

14
docs/reference/CallbackMap.md
View File

@ -8,9 +8,9 @@ A simple class to manage callbacks for different keys
## Properties
| Name | Type | Default |
| ------------------------------------- | ------------------------------------------------------------------------------- | ------- |
| [callbacks](#callbacks) | [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) | |
| [single_callbacks](#single-callbacks) | [Array](https://docs.godotengine.org/de/4.x/classes/class_array.html) | |
| ------------------------------------------ | ------------------------------------------------------------------------------- | ------- |
| [callbacks](#prop-callbacks) | [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) | |
| [single_callbacks](#prop-single-callbacks) | [Array](https://docs.godotengine.org/de/4.x/classes/class_array.html) | |
## Methods
@ -26,13 +26,15 @@ A simple class to manage callbacks for different keys
## Property Descriptions
### callbacks: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) {#callbacks}
### callbacks: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) {#prop-callbacks}
No description provided yet.
Map of callbacks
### single_callbacks: [Array](https://docs.godotengine.org/de/4.x/classes/class_array.html) {#single-callbacks}
### single_callbacks: [Array](https://docs.godotengine.org/de/4.x/classes/class_array.html) {#prop-single-callbacks}
No description provided yet.

20
docs/reference/EntityFactory.md
View File

@ -1,7 +1,9 @@
# EntityFactory
**Inherits:** [RefCounted](https://docs.godotengine.org/de/4.x/classes/class_refcounted.html)
## Description
This class is used to create entities based on their type
@ -13,54 +15,42 @@
## Constants
## Constants
### Switch = `<Object>` {#const-Switch}
No description provided yet.
### Light = `<Object>` {#const-Light}
No description provided yet.
### Sensor = `<Object>` {#const-Sensor}
No description provided yet.
### MediaPlayer = `<Object>` {#const-MediaPlayer}
No description provided yet.
### Camera = `<Object>` {#const-Camera}
No description provided yet.
### ButtonEntity = `<Object>` {#const-ButtonEntity}
No description provided yet.
### NumberEntity = `<Object>` {#const-NumberEntity}
No description provided yet.
## Method Descriptions
### create_entity (id: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#create-entity}
### static create_entity (id: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#create-entity}
No description provided yet.

6
docs/reference/Event.md
View File

@ -1,7 +1,9 @@
# Event
**Inherits:** [Resource](https://docs.godotengine.org/de/4.x/classes/class_resource.html)
## Description
Base class for all events
@ -17,8 +19,10 @@
## Method Descriptions
### merge (event: [Event](/reference/Event.html) ) -> void {#merge}
No description provided yet.
Merges the current event with another event. This is used in the EventSystem internally.

24
docs/reference/EventAction.md
View File

@ -1,15 +1,19 @@
# EventAction
**Inherits:** [Event](/reference/Event.html)
## Description
EventAction is emitted when the user presses a button or trigger on the controller.
## Properties
| Name | Type | Default |
| ------------------------------------- | ------------------------------------------------------------------------- | ------- |
| [name](#name) | [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) | |
| [right_controller](#right-controller) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | |
| [value](#value) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | |
| ------------------------------------------ | ------------------------------------------------------------------------- | ------- |
| [name](#prop-name) | [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) | |
| [right_controller](#prop-right-controller) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | |
| [value](#prop-value) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | |
@ -19,14 +23,14 @@
## Property Descriptions
### name: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#name}
### name: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#prop-name}
No description provided yet.
The name of the action that was triggered.
### right_controller: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#right-controller}
### right_controller: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#prop-right-controller}
No description provided yet.
True if the right controller triggered the action, false if the left controller triggered the action.
### value: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#value}
### value: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#prop-value}
No description provided yet.
Boolean, Float or Vector2

18
docs/reference/EventBubble.md
View File

@ -1,14 +1,18 @@
# EventBubble
**Inherits:** [Event](/reference/Event.html)
## Description
Abstract Event to represent events that move "bubble" up the Node tree.
## Properties
| Name | Type | Default |
| --------------------- | ------------------------------------------------------------------- | ------- |
| [bubbling](#bubbling) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | `true` |
| [target](#target) | [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) | |
| -------------------------- | ------------------------------------------------------------------- | ------- |
| [bubbling](#prop-bubbling) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | `true` |
| [target](#prop-target) | [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) | |
@ -18,10 +22,10 @@
## Property Descriptions
### bubbling: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#bubbling}
### bubbling: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#prop-bubbling}
No description provided yet.
If set to false, the event will stop bubbling up the Node tree.
### target: [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) {#target}
### target: [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) {#prop-target}
No description provided yet.
The Node that caused the event to start.

18
docs/reference/EventFocus.md
View File

@ -1,14 +1,18 @@
# EventFocus
**Inherits:** [Event](/reference/Event.html)
## Description
Emitted when a Node with the `ui_focus` group is focused or unfocused.
## Properties
| Name | Type | Default |
| ----------------------------------- | ------------------------------------------------------------------- | ------- |
| [previous_target](#previous-target) | [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) | |
| [target](#target) | [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) | |
| ---------------------------------------- | ------------------------------------------------------------------- | ------- |
| [previous_target](#prop-previous-target) | [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) | |
| [target](#prop-target) | [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) | |
@ -18,10 +22,10 @@
## Property Descriptions
### previous_target: [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) {#previous-target}
### previous_target: [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) {#prop-previous-target}
No description provided yet.
The Node that was previously focused or unfocused.
### target: [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) {#target}
### target: [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) {#prop-target}
No description provided yet.
The Node that is being focused or unfocused.

22
docs/reference/EventKey.md
View File

@ -1,14 +1,16 @@
# EventKey
**Inherits:** [EventWithModifiers](/reference/EventWithModifiers.html)
## Description
Events emitted by the Virtual Keyboard
## Properties
| Name | Type | Default |
| ------------- | ------------------------------------------------------------------- | ------- |
| [echo](#echo) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | |
| [key](#key) | [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) | |
| ------------------ | ------------------------------------------------------------------- | ------- |
| [echo](#prop-echo) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | |
| [key](#prop-key) | [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) | |
## Methods
@ -20,18 +22,20 @@
## Property Descriptions
### echo: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#echo}
### echo: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#prop-echo}
No description provided yet.
true if the event is repeated due to a key being held down for a while
### key: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) {#key}
### key: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) {#prop-key}
No description provided yet.
The key that was pressed or released
## Method Descriptions
### key_to_string (key: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) , caps: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) , apply_to: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) -> [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#key-to-string}
### static key_to_string (key: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) , caps: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) , apply_to: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) -> [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#key-to-string}
No description provided yet.
Modifies a string based on the key pressed

40
docs/reference/EventNotify.md
View File

@ -1,51 +1,49 @@
# EventNotify
**Inherits:** [Event](/reference/Event.html)
## Description
Emits a message to the user
## Properties
| Name | Type | Default |
| ------------------- | ----------------------------------------------------------------------- | ------- |
| [message](#message) | [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) | |
| [type](#type) | [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) | |
| ------------------------ | ----------------------------------------------------------------------- | ------- |
| [message](#prop-message) | [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) | |
| [type](#prop-type) | [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) | |
## Constants
## Enums
### enum Type
### INFO = `0` {#const-INFO}
#### Type.INFO = `0` {#const-INFO}
No description provided yet.
The message is informational
#### Type.SUCCESS = `1` {#const-SUCCESS}
The message is a success message
### SUCCESS = `1` {#const-SUCCESS}
#### Type.WARNING = `2` {#const-WARNING}
No description provided yet.
The message is a warning
#### Type.DANGER = `3` {#const-DANGER}
The message is an error
### WARNING = `2` {#const-WARNING}
No description provided yet.
### DANGER = `3` {#const-DANGER}
No description provided yet.
## Property Descriptions
### message: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#message}
### message: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#prop-message}
No description provided yet.
The message to emit
### type: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) {#type}
### type: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) {#prop-type}
No description provided yet.
The type of message to emit

20
docs/reference/EventPointer.md
View File

@ -1,14 +1,18 @@
# EventPointer
**Inherits:** [EventBubble](/reference/EventBubble.html)
## Description
Triggered when the raycast of the controller or hand hits or clicks on an object.
## Properties
| Name | Type | Default |
| ----------------------- | ----------------------------------------------------------------------------- | ------- |
| [initiator](#initiator) | [Initiator](/reference/lib--utils--pointer--initiator.html) | |
| [ray](#ray) | [RayCast3D](https://docs.godotengine.org/de/4.x/classes/class_raycast3d.html) | |
| ---------------------------- | ----------------------------------------------------------------------------- | ------- |
| [initiator](#prop-initiator) | [Initiator](/reference/lib--utils--pointer--initiator.html) | |
| [ray](#prop-ray) | [RayCast3D](https://docs.godotengine.org/de/4.x/classes/class_raycast3d.html) | |
@ -16,18 +20,16 @@
## Constants
### Initiator = `<Object>` {#const-Initiator}
No description provided yet.
## Property Descriptions
### initiator: [Initiator](/reference/lib--utils--pointer--initiator.html) {#initiator}
### initiator: [Initiator](/reference/lib--utils--pointer--initiator.html) {#prop-initiator}
No description provided yet.
Either the controller or the hand that triggered the event.
### ray: [RayCast3D](https://docs.godotengine.org/de/4.x/classes/class_raycast3d.html) {#ray}
### ray: [RayCast3D](https://docs.godotengine.org/de/4.x/classes/class_raycast3d.html) {#prop-ray}
No description provided yet.
The raycast that collided with the target.

16
docs/reference/EventTouch.md
View File

@ -1,13 +1,15 @@
# EventTouch
**Inherits:** [EventBubble](/reference/EventBubble.html)
## Description
Emitted when a finger enters or leaves a FingerArea.
## Properties
| Name | Type | Default |
| ------------------- | ----------------------------------------------------- | ------- |
| [fingers](#fingers) | [Finger](/reference/lib--utils--touch--finger.html)[] | |
| ------------------------ | ----------------------------------------------------- | ------- |
| [fingers](#prop-fingers) | [Finger](/reference/lib--utils--touch--finger.html)[] | |
## Methods
@ -17,22 +19,22 @@
## Constants
## Constants
### Finger = `<Object>` {#const-Finger}
No description provided yet.
## Property Descriptions
### fingers: [Finger](/reference/lib--utils--touch--finger.html)[] {#fingers}
### fingers: [Finger](/reference/lib--utils--touch--finger.html)[] {#prop-fingers}
No description provided yet.
The list of fingers that are currently in the area.
## Method Descriptions
### has_finger (finger: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#has-finger}
No description provided yet.
Checks if a specific finger is currently in the area.

22
docs/reference/EventWithModifiers.md
View File

@ -1,16 +1,20 @@
# EventWithModifiers
**Inherits:** [Event](/reference/Event.html)
## Description
Base for Events using a Keyboard
## Properties
| Name | Type | Default |
| ----------------------------------- | ------------------------------------------------------------------- | ------- |
| [alt_pressed](#alt-pressed) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | `false` |
| [control_pressed](#control-pressed) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | `false` |
| [meta_pressed](#meta-pressed) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | `false` |
| [shift_pressed](#shift-pressed) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | `false` |
| ---------------------------------------- | ------------------------------------------------------------------- | ------- |
| [alt_pressed](#prop-alt-pressed) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | `false` |
| [control_pressed](#prop-control-pressed) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | `false` |
| [meta_pressed](#prop-meta-pressed) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | `false` |
| [shift_pressed](#prop-shift-pressed) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | `false` |
@ -20,18 +24,18 @@
## Property Descriptions
### alt_pressed: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#alt-pressed}
### alt_pressed: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#prop-alt-pressed}
No description provided yet.
### control_pressed: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#control-pressed}
### control_pressed: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#prop-control-pressed}
No description provided yet.
### meta_pressed: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#meta-pressed}
### meta_pressed: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#prop-meta-pressed}
No description provided yet.
### shift_pressed: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#shift-pressed}
### shift_pressed: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#prop-shift-pressed}
No description provided yet.

18
docs/reference/Proxy.md
View File

@ -1,15 +1,17 @@
# Proxy
**Inherits:** [RefCounted](https://docs.godotengine.org/de/4.x/classes/class_refcounted.html)
## Description
A simple proxy class to allow for easy binding of a property to a function call.
## Properties
| Name | Type | Default |
| --------------------- | --------------------------------------------------------------------------- | ------- |
| [gettable](#gettable) | [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html) | |
| [settable](#settable) | [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html) | |
| [value](#value) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | |
| -------------------------- | --------------------------------------------------------------------------- | ------- |
| [gettable](#prop-gettable) | [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html) | |
| [settable](#prop-settable) | [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html) | |
| [value](#prop-value) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | |
## Methods
@ -25,17 +27,19 @@ No description provided yet.
## Property Descriptions
### gettable: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html) {#gettable}
### gettable: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html) {#prop-gettable}
No description provided yet.
### settable: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html) {#settable}
### settable: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html) {#prop-settable}
No description provided yet.
### value: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#value}
### value: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#prop-value}
No description provided yet.

10
docs/reference/ProxyGroup.md
View File

@ -1,13 +1,15 @@
# ProxyGroup
**Inherits:** [RefCounted](https://docs.godotengine.org/de/4.x/classes/class_refcounted.html)
## Description
A group of proxies that will be updated when one of them is updated
## Properties
| Name | Type | Default |
| ------------------- | ------------------------------------------------------------------------- | ------- |
| [proxies](#proxies) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | |
| ------------------------ | ------------------------------------------------------------------------- | ------- |
| [proxies](#prop-proxies) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | |
## Methods
@ -19,9 +21,11 @@
## Property Descriptions
### proxies: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#proxies}
### proxies: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#prop-proxies}
No description provided yet.

10
docs/reference/State.md
View File

@ -1,13 +1,15 @@
# State
**Inherits:** [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html)
## Description
Base Class for all states
## Properties
| Name | Type | Default |
| ------------------------------- | -------------------------------------------- | ------- |
| [state_machine](#state-machine) | [StateMachine](/reference/StateMachine.html) | |
| ------------------------------------ | -------------------------------------------- | ------- |
| [state_machine](#prop-state-machine) | [StateMachine](/reference/StateMachine.html) | |
## Methods
@ -21,9 +23,11 @@
## Property Descriptions
### state_machine: [StateMachine](/reference/StateMachine.html) {#state-machine}
### state_machine: [StateMachine](/reference/StateMachine.html) {#prop-state-machine}
No description provided yet.

18
docs/reference/StateMachine.md
View File

@ -1,14 +1,16 @@
# StateMachine
**Inherits:** [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html)
## Description
Abstract class for a state machine
## Properties
| Name | Type | Default |
| ------------------------------- | ------------------------------------------------------------------------------- | ------- |
| [current_state](#current-state) | [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) | |
| [states](#states) | [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) | |
| ------------------------------------ | ------------------------------------------------------------------------------- | ------- |
| [current_state](#prop-current-state) | [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) | |
| [states](#prop-states) | [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) | |
## Methods
@ -26,13 +28,15 @@ No description provided yet.
## Property Descriptions
### current_state: [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) {#current-state}
### current_state: [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) {#prop-current-state}
No description provided yet.
### states: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) {#states}
### states: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) {#prop-states}
No description provided yet.
@ -44,8 +48,8 @@ No description provided yet.
### change_to (new_state: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) -> void {#change-to}
No description provided yet.
Change the current state to the new state
### get_state (state_name: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) -> [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) {#get-state}
No description provided yet.
Get the state with the given name

55
docs/reference/generator/index.ts
View File

@ -9,7 +9,7 @@ import endent from "endent";
const REFERENCE_PATH = './reference/raw'
let custom_types: string[] = []
// export_from_godot()
export_from_godot()
translate()
async function export_from_godot() {
@ -102,20 +102,51 @@ function translate_reference(contents: string): string {
}
let enum_descriptions = ''
let enum_list = to_array(json.class.constants?.constant).filter(constant => ('_enum' in constant) === true)
if (enum_list.length > 0) {
const enums = enum_list.reduce((acc, constant) => {
endent
if ('_enum' in constant) {
if (acc[constant._enum] === undefined) {
acc[constant._enum] = []
}
acc[constant._enum].push(constant)
}
return acc
}, {})
enum_descriptions = '## Enums\n\n' + Object.keys(enums).map(enum_name => {
return endent`
### enum ${enum_name}
${enums[enum_name].map(constant => {
const name = constant._name
return endent`
#### ${enum_name}.${name} = \`${constant._value}\` ${'{#const-' + name_to_anchor(name) + '}'}
${constant['#text'] || 'No description provided yet.'}
`
}).join('\n\n')}
`
}).join('\n\n')
}
let constant_descriptions = ''
let constants_list = to_array(json.class.constants?.constant)
let constants_list = to_array(json.class.constants?.constant).filter(constant => ('_enum' in constant) === false)
if (constants_list.length > 0) {
constant_descriptions = '## Constants\n\n' +
constants_list.map(constant => {
const name = constant._name
console.log('constant', constant._value)
return `
return endent`
### ${name} = \`${constant._value}\` ${'{#const-' + name_to_anchor(name) + '}'}
${constant.description || 'No description provided yet.'}
${constant['#text'] || 'No description provided yet.'}
`
}).join('\n\n')
}
@ -134,7 +165,7 @@ ${constant.description || 'No description provided yet.'}
const name = member._name
return [
`[${name}](#${name_to_anchor(name)})`,
`[${name}](#prop-${name_to_anchor(name)})`,
link_godot_type(member._type),
handle_default(member._default)
]
@ -148,9 +179,9 @@ ${constant.description || 'No description provided yet.'}
const name = member._name
return endent`
### ${name}: ${link_godot_type(member._type)} ${'{#' + name_to_anchor(name) + '}'}
### ${name}: ${link_godot_type(member._type)} ${'{#prop-' + name_to_anchor(name) + '}'}
${member.description || 'No description provided yet.'}
${member['#text'] || 'No description provided yet.'}
`
}).join('\n\n')
}
@ -191,8 +222,10 @@ ${constant.description || 'No description provided yet.'}
return `${param._name}: ${link_godot_type(param._type)} `
}).join(', ')
let qualifiers = to_array(method?._qualifiers).join(', ')
return endent`
### ${name} (${params} ) -> ${link_godot_type(method.return._type)} ${'{#' + name_to_anchor(name) + '}'}
### ${qualifiers} ${name} (${params} ) -> ${link_godot_type(method.return._type)} ${'{#' + name_to_anchor(name) + '}'}
${method.description || 'No description provided yet.'}
`
@ -211,6 +244,8 @@ ${constant.description || 'No description provided yet.'}
${signal_descriptions}
${enum_descriptions}
${constant_descriptions}
${member_descriptions}

21
docs/reference/lib--globals--audio_player.md
View File

@ -3,14 +3,7 @@
## Properties
| Name | Type | Default |
| --------------------------- | ------------------------------------------------------------------------- | ---------- |
| [click_sound](#click-sound) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | `<Object>` |
| [close_menu](#close-menu) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | `<Object>` |
| [open_menu](#open-menu) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | `<Object>` |
| [spawn_sound](#spawn-sound) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | `<Object>` |
## Methods
@ -23,24 +16,26 @@
## Property Descriptions
## Constants
### click_sound: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#click-sound}
### click_sound = `<Object>` {#const-click-sound}
No description provided yet.
### close_menu: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#close-menu}
### spawn_sound = `<Object>` {#const-spawn-sound}
No description provided yet.
### open_menu: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#open-menu}
### open_menu = `<Object>` {#const-open-menu}
No description provided yet.
### spawn_sound: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#spawn-sound}
### close_menu = `<Object>` {#const-close-menu}
No description provided yet.
## Method Descriptions
### _ready ( ) -> void {#-ready}
@ -49,4 +44,4 @@ No description provided yet.
### play_effect (sound: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) -> void {#play-effect}
No description provided yet.
Plays a given sound effect

72
docs/reference/lib--globals--event_system.md
View File

@ -6,9 +6,9 @@
## Properties
| Name | Type | Default |
| ----------------------------- | --------------------------------------------------------------------- | ------- |
| [_active_node](#-active-node) | [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) | `null` |
| [_slow_tick](#-slow-tick) | [float](https://docs.godotengine.org/de/4.x/classes/class_float.html) | `0.0` |
| ---------------------------------- | --------------------------------------------------------------------- | ------- |
| [_active_node](#prop--active-node) | [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) | `null` |
| [_slow_tick](#prop--slow-tick) | [float](https://docs.godotengine.org/de/4.x/classes/class_float.html) | `0.0` |
## Methods
@ -26,115 +26,111 @@
### on_action_down (event: [EventAction](/reference/EventAction.html) ) {#on-action-down}
No description provided yet.
Emitted when a button on the controller is pressed
### on_action_up (event: [EventAction](/reference/EventAction.html) ) {#on-action-up}
No description provided yet.
Emitted when a button on the controller is released
### on_action_value (event: [EventAction](/reference/EventAction.html) ) {#on-action-value}
No description provided yet.
Emitted when a value changes on the controller (e.g. joystick)
### on_click (event: [EventPointer](/reference/EventPointer.html) ) {#on-click}
No description provided yet.
Emitted when a node is clicked
### on_focus_in (event: [EventFocus](/reference/EventFocus.html) ) {#on-focus-in}
No description provided yet.
Emitted when the node gains focus
### on_focus_out (event: [EventFocus](/reference/EventFocus.html) ) {#on-focus-out}
No description provided yet.
Emitted when the node loses focus
### on_grab_down (event: [EventPointer](/reference/EventPointer.html) ) {#on-grab-down}
No description provided yet.
Emitted when a node is grabbed
### on_grab_move (event: [EventPointer](/reference/EventPointer.html) ) {#on-grab-move}
No description provided yet.
Emitted when a node is moved while grabbed
### on_grab_up (event: [EventPointer](/reference/EventPointer.html) ) {#on-grab-up}
No description provided yet.
Emitted when a node is released from being grabbed
### on_key_down (event: [EventKey](/reference/EventKey.html) ) {#on-key-down}
No description provided yet.
Emitted when a key on the virtual keyboard is pressed
### on_key_up (event: [EventKey](/reference/EventKey.html) ) {#on-key-up}
No description provided yet.
Emitted when a key on the virtual keyboard is released
### on_notify (event: [EventNotify](/reference/EventNotify.html) ) {#on-notify}
No description provided yet.
Emitted when a message is sent to the user
### on_press_down (event: [EventPointer](/reference/EventPointer.html) ) {#on-press-down}
No description provided yet.
Emitted when a node is pressed down
### on_press_move (event: [EventPointer](/reference/EventPointer.html) ) {#on-press-move}
No description provided yet.
Emitted when a node is moved while pressed
### on_press_up (event: [EventPointer](/reference/EventPointer.html) ) {#on-press-up}
No description provided yet.
Emitted when a node is released
### on_ray_enter (event: [EventPointer](/reference/EventPointer.html) ) {#on-ray-enter}
No description provided yet.
Emitted when a node is hovered
### on_ray_leave (event: [EventPointer](/reference/EventPointer.html) ) {#on-ray-leave}
No description provided yet.
Emitted when a node is no longer hovered
### on_slow_tick (delta: [float](https://docs.godotengine.org/de/4.x/classes/class_float.html) ) {#on-slow-tick}
No description provided yet.
Emitted when the slow tick event occurs
### on_touch_enter (event: [EventTouch](/reference/EventTouch.html) ) {#on-touch-enter}
No description provided yet.
Emitted when a finger enters a TouchArea
### on_touch_leave (event: [EventTouch](/reference/EventTouch.html) ) {#on-touch-leave}
No description provided yet.
Emitted when a finger leaves a TouchArea
### on_touch_move (event: [EventTouch](/reference/EventTouch.html) ) {#on-touch-move}
No description provided yet.
Emitted when a finger moves inside a TouchArea
## Constants
### FN_PREFIX = `"_on_"` {#const-FN-PREFIX}
No description provided yet.
Prefix for the function names to be called
### SIGNAL_PREFIX = `"on_"` {#const-SIGNAL-PREFIX}
No description provided yet.
Prefix for the signal names to be emitted
### SLOW_TICK = `0.1` {#const-SLOW-TICK}
No description provided yet.
Tick rate for the slow tick event
## Property Descriptions
### _active_node: [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) {#-active-node}
### _active_node: [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) {#prop--active-node}
No description provided yet.
### _slow_tick: [float](https://docs.godotengine.org/de/4.x/classes/class_float.html) {#-slow-tick}
### _slow_tick: [float](https://docs.godotengine.org/de/4.x/classes/class_float.html) {#prop--slow-tick}
No description provided yet.
@ -158,12 +154,12 @@ No description provided yet.
### emit (type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) , event: [Event](/reference/Event.html) ) -> void {#emit}
No description provided yet.
Emits an event to the node tree
### is_focused (node: [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#is-focused}
No description provided yet.
Returns true when the node is focused
### notify (message: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) , type: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) ) -> void {#notify}
No description provided yet.
Shortcut for sending a notification

36
docs/reference/lib--globals--home_api.md
View File

@ -1,13 +1,15 @@
# HomeApi
**Inherits:** [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html)
## Description
Manages the connection to the home automation system and provides a unified interface to the different home automation systems.
## Properties
| Name | Type | Default |
| ----------- | ------------------------------------------------------------------- | ------- |
| [api](#api) | [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) | |
| ---------------- | ------------------------------------------------------------------- | ------- |
| [api](#prop-api) | [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) | |
## Methods
@ -29,43 +31,43 @@
### on_connect ( ) {#on-connect}
No description provided yet.
Emitted when the connection to the home automation system is established
### on_disconnect ( ) {#on-disconnect}
No description provided yet.
Emitted when the connection to the home automation system is lost
## Constants
### Hass = `<Object>` {#const-Hass}
No description provided yet.
### HassWebSocket = `<Object>` {#const-HassWebSocket}
No description provided yet.
### apis = `{"hass": <Object>, "hass_ws": <Object>}` {#const-apis}
No description provided yet.
### methods = `["get_devices", "get_device", "get_state", "set_state", "watch_state"]` {#const-methods}
### methods = `[
"get_devices",
"get_device",
"get_state",
"set_state",
"watch_state"
]` {#const-methods}
No description provided yet.
## Property Descriptions
### api: [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) {#api}
### api: [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) {#prop-api}
No description provided yet.
The current home automation system adapter
## Method Descriptions
@ -99,7 +101,7 @@ Returns the current state of an entity
### has_connected ( ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#has-connected}
No description provided yet.
Returns true if the adapter is connected to the home automation system
### set_state (entity: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) , state: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) , attributes: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#set-state}
@ -107,7 +109,7 @@ Updates the state of the entity and returns the resulting state
### start_adapter (type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) , url: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) , token: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) -> void {#start-adapter}
No description provided yet.
Starts the adapter for the given type and url
### watch_state (entity: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) , callback: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html) ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#watch-state}

10
docs/reference/lib--globals--house_body.md
View File

@ -1,13 +1,17 @@
# HouseBody
**Inherits:** [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html)
## Description
Shortcut to get the House node from the Main scene
## Properties
| Name | Type | Default |
| ------------- | ------------------------------------------------------------------------- | ------- |
| [body](#body) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | |
| ------------------ | ------------------------------------------------------------------------- | ------- |
| [body](#prop-body) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | |
@ -17,6 +21,6 @@
## Property Descriptions
### body: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#body}
### body: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#prop-body}
No description provided yet.

24
docs/reference/lib--globals--main_store.md
View File

@ -1,15 +1,19 @@
# MainStore
**Inherits:** [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html)
## Description
Collection of all the stores to save the state persistently
## Properties
| Name | Type | Default |
| --------------------- | ------------------------------------------------------------------------- | ------- |
| [devices](#devices) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | |
| [house](#house) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | |
| [settings](#settings) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | |
| -------------------------- | ------------------------------------------------------------------------- | ------- |
| [devices](#prop-devices) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | |
| [house](#prop-house) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | |
| [settings](#prop-settings) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | |
@ -17,34 +21,28 @@
## Constants
### SettingsStore = `<Object>` {#const-SettingsStore}
No description provided yet.
### HouseStore = `<Object>` {#const-HouseStore}
No description provided yet.
### DevicesStore = `<Object>` {#const-DevicesStore}
No description provided yet.
## Property Descriptions
### devices: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#devices}
### devices: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#prop-devices}
No description provided yet.
### house: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#house}
### house: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#prop-house}
No description provided yet.
### settings: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#settings}
### settings: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#prop-settings}
No description provided yet.

20
docs/reference/lib--home_apis--hass--hass.md
View File

@ -6,11 +6,11 @@
## Properties
| Name | Type | Default |
| ------------------------------------- | --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [devices_template](#devices-template) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | |
| [headers](#headers) | [PackedStringArray](https://docs.godotengine.org/de/4.x/classes/class_packedstringarray.html) | |
| [token](#token) | [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) | `"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiIzZjQ0ZGM2N2Y3YzY0MDc1OGZlMWI2ZjJlNmIxZjRkNSIsImlhdCI6MTY5ODAxMDcyOCwiZXhwIjoyMDEzMzcwNzI4fQ.K6ydLUC-4Q7BNIRCU1nWlI2s6sg9UCiOu-Lpedw2zJc"` |
| [url](#url) | [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) | `"http://192.168.33.33:8123"` |
| ------------------------------------------ | --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [devices_template](#prop-devices-template) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | |
| [headers](#prop-headers) | [PackedStringArray](https://docs.godotengine.org/de/4.x/classes/class_packedstringarray.html) | |
| [token](#prop-token) | [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) | `"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiIzZjQ0ZGM2N2Y3YzY0MDc1OGZlMWI2ZjJlNmIxZjRkNSIsImlhdCI6MTY5ODAxMDcyOCwiZXhwIjoyMDEzMzcwNzI4fQ.K6ydLUC-4Q7BNIRCU1nWlI2s6sg9UCiOu-Lpedw2zJc"` |
| [url](#prop-url) | [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) | `"http://192.168.33.33:8123"` |
## Methods
@ -25,21 +25,23 @@
## Property Descriptions
### devices_template: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#devices-template}
### devices_template: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#prop-devices-template}
No description provided yet.
### headers: [PackedStringArray](https://docs.godotengine.org/de/4.x/classes/class_packedstringarray.html) {#headers}
### headers: [PackedStringArray](https://docs.godotengine.org/de/4.x/classes/class_packedstringarray.html) {#prop-headers}
No description provided yet.
### token: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#token}
### token: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#prop-token}
No description provided yet.
### url: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#url}
### url: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#prop-url}
No description provided yet.

34
docs/reference/lib--home_apis--hass_ws--handlers--assist.md
View File

@ -6,14 +6,14 @@
## Properties
| Name | Type | Default |
| ----------------------------- | ------------------------------------------------------------------------- | ------- |
| [api](#api) | [Hass](/reference/lib--home_apis--hass_ws--hass.html) | |
| [handler_id](#handler-id) | [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) | `0` |
| [pipe_running](#pipe-running) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | `false` |
| [stt_message](#stt-message) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | `null` |
| [tts_message](#tts-message) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | `null` |
| [tts_sound](#tts-sound) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | `null` |
| [wake_word](#wake-word) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | `null` |
| ---------------------------------- | ------------------------------------------------------------------------- | ------- |
| [api](#prop-api) | [Hass](/reference/lib--home_apis--hass_ws--hass.html) | |
| [handler_id](#prop-handler-id) | [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) | `0` |
| [pipe_running](#prop-pipe-running) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | `false` |
| [stt_message](#prop-stt-message) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | `null` |
| [tts_message](#prop-tts-message) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | `null` |
| [tts_sound](#prop-tts-sound) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | `null` |
| [wake_word](#prop-wake-word) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | `null` |
## Methods
@ -47,41 +47,41 @@ No description provided yet.
No description provided yet.
## Constants
## Constants
### HASS_API = `<Object>` {#const-HASS-API}
No description provided yet.
## Property Descriptions
### api: [Hass](/reference/lib--home_apis--hass_ws--hass.html) {#api}
### api: [Hass](/reference/lib--home_apis--hass_ws--hass.html) {#prop-api}
No description provided yet.
### handler_id: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) {#handler-id}
### handler_id: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) {#prop-handler-id}
No description provided yet.
### pipe_running: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#pipe-running}
### pipe_running: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#prop-pipe-running}
No description provided yet.
### stt_message: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#stt-message}
### stt_message: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#prop-stt-message}
No description provided yet.
### tts_message: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#tts-message}
### tts_message: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#prop-tts-message}
No description provided yet.
### tts_sound: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#tts-sound}
### tts_sound: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#prop-tts-sound}
No description provided yet.
### wake_word: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#wake-word}
### wake_word: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#prop-wake-word}
No description provided yet.

22
docs/reference/lib--home_apis--hass_ws--handlers--auth.md
View File

@ -6,11 +6,11 @@
## Properties
| Name | Type | Default |
| ------------------------------- | ----------------------------------------------------------------------- | ------- |
| [api](#api) | [Hass](/reference/lib--home_apis--hass_ws--hass.html) | |
| [authenticated](#authenticated) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | `false` |
| [token](#token) | [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) | |
| [url](#url) | [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) | |
| ------------------------------------ | ----------------------------------------------------------------------- | ------- |
| [api](#prop-api) | [Hass](/reference/lib--home_apis--hass_ws--hass.html) | |
| [authenticated](#prop-authenticated) | [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) | |
| [url](#prop-url) | [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) | |
## Methods
@ -26,29 +26,29 @@
No description provided yet.
## Constants
## Constants
### HASS_API = `<Object>` {#const-HASS-API}
No description provided yet.
## Property Descriptions
### api: [Hass](/reference/lib--home_apis--hass_ws--hass.html) {#api}
### api: [Hass](/reference/lib--home_apis--hass_ws--hass.html) {#prop-api}
No description provided yet.
### authenticated: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#authenticated}
### authenticated: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#prop-authenticated}
No description provided yet.
### token: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#token}
### token: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#prop-token}
No description provided yet.
### url: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#url}
### url: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#prop-url}
No description provided yet.

14
docs/reference/lib--home_apis--hass_ws--handlers--integration.md
View File

@ -6,9 +6,9 @@
## Properties
| Name | Type | Default |
| ----------------------------------------- | ------------------------------------------------------------------- | ------- |
| [api](#api) | [Hass](/reference/lib--home_apis--hass_ws--hass.html) | |
| [integration_exists](#integration-exists) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | `false` |
| ---------------------------------------------- | ------------------------------------------------------------------- | ------- |
| [api](#prop-api) | [Hass](/reference/lib--home_apis--hass_ws--hass.html) | |
| [integration_exists](#prop-integration-exists) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | `false` |
## Methods
@ -19,21 +19,21 @@
## Constants
## Constants
### HASS_API = `<Object>` {#const-HASS-API}
No description provided yet.
## Property Descriptions
### api: [Hass](/reference/lib--home_apis--hass_ws--hass.html) {#api}
### api: [Hass](/reference/lib--home_apis--hass_ws--hass.html) {#prop-api}
No description provided yet.
### integration_exists: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#integration-exists}
### integration_exists: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#prop-integration-exists}
No description provided yet.

66
docs/reference/lib--home_apis--hass_ws--hass.md
View File

@ -6,21 +6,21 @@
## Properties
| Name | Type | Default |
| ------------------------------------------- | ------------------------------------------------------------------------------------- | ------- |
| [LOG_MESSAGES](#LOG-MESSAGES) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | `false` |
| [assist_handler](#assist-handler) | [Assist](/reference/lib--home_apis--hass_ws--handlers--assist.html) | |
| [auth_handler](#auth-handler) | [Auth](/reference/lib--home_apis--hass_ws--handlers--auth.html) | |
| [connected](#connected) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | `false` |
| [devices_template](#devices-template) | [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) | |
| [entities](#entities) | [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) | |
| [entitiy_callbacks](#entitiy-callbacks) | [CallbackMap](/reference/CallbackMap.html) | |
| [id](#id) | [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) | `1` |
| [integration_handler](#integration-handler) | [Integration](/reference/lib--home_apis--hass_ws--handlers--integration.html) | |
| [packet_callbacks](#packet-callbacks) | [CallbackMap](/reference/CallbackMap.html) | |
| [request_timeout](#request-timeout) | [float](https://docs.godotengine.org/de/4.x/classes/class_float.html) | `10.0` |
| [socket](#socket) | [WebSocketPeer](https://docs.godotengine.org/de/4.x/classes/class_websocketpeer.html) | |
| [token](#token) | [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) | `""` |
| [url](#url) | [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) | `""` |
| ------------------------------------------------ | ------------------------------------------------------------------------------------- | ------- |
| [LOG_MESSAGES](#prop-LOG-MESSAGES) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | `false` |
| [assist_handler](#prop-assist-handler) | [Assist](/reference/lib--home_apis--hass_ws--handlers--assist.html) | |
| [auth_handler](#prop-auth-handler) | [Auth](/reference/lib--home_apis--hass_ws--handlers--auth.html) | |
| [connected](#prop-connected) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | `false` |
| [devices_template](#prop-devices-template) | [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) | |
| [entities](#prop-entities) | [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) | |
| [entitiy_callbacks](#prop-entitiy-callbacks) | [CallbackMap](/reference/CallbackMap.html) | |
| [id](#prop-id) | [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) | `1` |
| [integration_handler](#prop-integration-handler) | [Integration](/reference/lib--home_apis--hass_ws--handlers--integration.html) | |
| [packet_callbacks](#prop-packet-callbacks) | [CallbackMap](/reference/CallbackMap.html) | |
| [request_timeout](#prop-request-timeout) | [float](https://docs.godotengine.org/de/4.x/classes/class_float.html) | `10.0` |
| [socket](#prop-socket) | [WebSocketPeer](https://docs.godotengine.org/de/4.x/classes/class_websocketpeer.html) | |
| [token](#prop-token) | [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) | `""` |
| [url](#prop-url) | [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) | `""` |
## Methods
@ -58,81 +58,77 @@ No description provided yet.
No description provided yet.
## Constants
## Constants
### AuthHandler = `<Object>` {#const-AuthHandler}
No description provided yet.
### IntegrationHandler = `<Object>` {#const-IntegrationHandler}
No description provided yet.
### AssistHandler = `<Object>` {#const-AssistHandler}
No description provided yet.
## Property Descriptions
### LOG_MESSAGES: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#LOG-MESSAGES}
### LOG_MESSAGES: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#prop-LOG-MESSAGES}
No description provided yet.
### assist_handler: [Assist](/reference/lib--home_apis--hass_ws--handlers--assist.html) {#assist-handler}
### assist_handler: [Assist](/reference/lib--home_apis--hass_ws--handlers--assist.html) {#prop-assist-handler}
No description provided yet.
### auth_handler: [Auth](/reference/lib--home_apis--hass_ws--handlers--auth.html) {#auth-handler}
### auth_handler: [Auth](/reference/lib--home_apis--hass_ws--handlers--auth.html) {#prop-auth-handler}
No description provided yet.
### connected: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#connected}
### connected: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#prop-connected}
No description provided yet.
### devices_template: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#devices-template}
### devices_template: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#prop-devices-template}
No description provided yet.
### entities: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) {#entities}
### entities: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) {#prop-entities}
No description provided yet.
### entitiy_callbacks: [CallbackMap](/reference/CallbackMap.html) {#entitiy-callbacks}
### entitiy_callbacks: [CallbackMap](/reference/CallbackMap.html) {#prop-entitiy-callbacks}
No description provided yet.
### id: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) {#id}
### id: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) {#prop-id}
No description provided yet.
### integration_handler: [Integration](/reference/lib--home_apis--hass_ws--handlers--integration.html) {#integration-handler}
### integration_handler: [Integration](/reference/lib--home_apis--hass_ws--handlers--integration.html) {#prop-integration-handler}
No description provided yet.
### packet_callbacks: [CallbackMap](/reference/CallbackMap.html) {#packet-callbacks}
### packet_callbacks: [CallbackMap](/reference/CallbackMap.html) {#prop-packet-callbacks}
No description provided yet.
### request_timeout: [float](https://docs.godotengine.org/de/4.x/classes/class_float.html) {#request-timeout}
### request_timeout: [float](https://docs.godotengine.org/de/4.x/classes/class_float.html) {#prop-request-timeout}
No description provided yet.
### socket: [WebSocketPeer](https://docs.godotengine.org/de/4.x/classes/class_websocketpeer.html) {#socket}
### socket: [WebSocketPeer](https://docs.godotengine.org/de/4.x/classes/class_websocketpeer.html) {#prop-socket}
No description provided yet.
### token: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#token}
### token: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#prop-token}
No description provided yet.
### url: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#url}
### url: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#prop-url}
No description provided yet.

4
docs/reference/lib--stores--devices.md
View File

@ -13,16 +13,16 @@
## Constants
## Constants
### StoreClass = `<Object>` {#const-StoreClass}
No description provided yet.
## Method Descriptions
### clear ( ) -> void {#clear}

28
docs/reference/lib--stores--house.md
View File

@ -1,16 +1,18 @@
# House
**Inherits:** [Store](/reference/lib--stores--store.html)
## Description
Stores information about the house, its rooms and entities
## Properties
| Name | Type | Default |
| ----------------------------------- | ------------------------------------------------------------------------- | ------- |
| [align_position1](#align-position1) | [Vector3](https://docs.godotengine.org/de/4.x/classes/class_vector3.html) | |
| [align_position2](#align-position2) | [Vector3](https://docs.godotengine.org/de/4.x/classes/class_vector3.html) | |
| [entities](#entities) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | |
| [rooms](#rooms) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | |
| ---------------------------------------- | ------------------------------------------------------------------------- | ------- |
| [align_position1](#prop-align-position1) | [Vector3](https://docs.godotengine.org/de/4.x/classes/class_vector3.html) | |
| [align_position2](#prop-align-position2) | [Vector3](https://docs.godotengine.org/de/4.x/classes/class_vector3.html) | |
| [entities](#prop-entities) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | |
| [rooms](#prop-rooms) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | |
## Methods
@ -22,31 +24,31 @@
## Constants
## Constants
### StoreClass = `<Object>` {#const-StoreClass}
No description provided yet.
## Property Descriptions
### align_position1: [Vector3](https://docs.godotengine.org/de/4.x/classes/class_vector3.html) {#align-position1}
### align_position1: [Vector3](https://docs.godotengine.org/de/4.x/classes/class_vector3.html) {#prop-align-position1}
No description provided yet.
### align_position2: [Vector3](https://docs.godotengine.org/de/4.x/classes/class_vector3.html) {#align-position2}
### align_position2: [Vector3](https://docs.godotengine.org/de/4.x/classes/class_vector3.html) {#prop-align-position2}
No description provided yet.
### entities: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#entities}
### entities: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#prop-entities}
No description provided yet.
Type Entity id: String position: Vec3 rotation: Vec3 room: String
### rooms: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#rooms}
### rooms: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#prop-rooms}
No description provided yet.
Type Room name: String corners: Vec2[] height: float
## Method Descriptions

32
docs/reference/lib--stores--settings.md
View File

@ -1,16 +1,18 @@
# Settings
**Inherits:** [Store](/reference/lib--stores--store.html)
## Description
Stores general settings for the app
## Properties
| Name | Type | Default |
| ----------------------------------- | ----------------------------------------------------------------------- | ----------- |
| [token](#token) | [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) | `""` |
| [type](#type) | [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) | `"HASS_WS"` |
| [url](#url) | [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) | `""` |
| [voice_assistant](#voice-assistant) | [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` |
## Methods
@ -21,31 +23,31 @@
## Constants
## Constants
### StoreClass = `<Object>` {#const-StoreClass}
No description provided yet.
## Property Descriptions
### token: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#token}
### token: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#prop-token}
No description provided yet.
### type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#type}
### type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#prop-type}
The adapter to use for connecting with a backend
### url: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#prop-url}
No description provided yet.
### url: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#url}
### voice_assistant: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#prop-voice-assistant}
No description provided yet.
### voice_assistant: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#voice-assistant}
No description provided yet.
If the voice assistant should be enabled
## Method Descriptions

24
docs/reference/lib--stores--store.md
View File

@ -1,14 +1,16 @@
# Store
**Inherits:** [RefCounted](https://docs.godotengine.org/de/4.x/classes/class_refcounted.html)
## Description
Abstract class for saving and loading data to and from a file.
## Properties
| Name | Type | Default |
| ------------------------- | ------------------------------------------------------------------------- | ------- |
| [_loaded](#-loaded) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | `false` |
| [_save_path](#-save-path) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | `null` |
| ------------------------------ | ------------------------------------------------------------------------- | ------- |
| [_loaded](#prop--loaded) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | `false` |
| [_save_path](#prop--save-path) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | `null` |
## Methods
@ -25,27 +27,27 @@
### on_loaded ( ) {#on-loaded}
No description provided yet.
Signal emitted when the data is loaded.
### on_saved ( ) {#on-saved}
No description provided yet.
Signal emitted when the data is saved.
## Constants
### VariantSerializer = `<Object>` {#const-VariantSerializer}
No description provided yet.
## Property Descriptions
### _loaded: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#-loaded}
### _loaded: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#prop--loaded}
No description provided yet.
### _save_path: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#-save-path}
### _save_path: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#prop--save-path}
No description provided yet.
@ -53,7 +55,7 @@ No description provided yet.
### clear ( ) -> void {#clear}
No description provided yet.
Resets the data to its default state.
### create_dict ( ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#create-dict}
@ -61,7 +63,7 @@ No description provided yet.
### is_loaded ( ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#is-loaded}
No description provided yet.
Returns true if the data has been loaded.
### load_local (path: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#load-local}

6
docs/reference/lib--utils--font_tools.md
View File

@ -17,8 +17,10 @@
## Method Descriptions
### get_font_size (label: [Label3D](https://docs.godotengine.org/de/4.x/classes/class_label3d.html) , chars: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#get-font-size}
### static get_font_size (label: [Label3D](https://docs.godotengine.org/de/4.x/classes/class_label3d.html) , chars: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#get-font-size}
No description provided yet.
Returns the size of a Label3D in standard units

38
docs/reference/lib--utils--pointer--initiator.md
View File

@ -1,14 +1,16 @@
# Initiator
**Inherits:** [RefCounted](https://docs.godotengine.org/de/4.x/classes/class_refcounted.html)
## Description
Defines what triggered a EventPointer
## Properties
| Name | Type | Default |
| ------------- | ----------------------------------------------------------------------- | ------- |
| [node](#node) | [Node3D](https://docs.godotengine.org/de/4.x/classes/class_node3d.html) | |
| [type](#type) | [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) | |
| ------------------ | ----------------------------------------------------------------------- | ------- |
| [node](#prop-node) | [Node3D](https://docs.godotengine.org/de/4.x/classes/class_node3d.html) | |
| [type](#prop-type) | [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) | |
## Methods
@ -26,51 +28,45 @@ No description provided yet.
No description provided yet.
## Constants
## Enums
### enum Type
### CONTROLLER_LEFT = `0` {#const-CONTROLLER-LEFT}
#### Type.CONTROLLER_LEFT = `0` {#const-CONTROLLER-LEFT}
No description provided yet.
### CONTROLLER_RIGHT = `1` {#const-CONTROLLER-RIGHT}
#### Type.CONTROLLER_RIGHT = `1` {#const-CONTROLLER-RIGHT}
No description provided yet.
### HAND_LEFT = `2` {#const-HAND-LEFT}
#### Type.HAND_LEFT = `2` {#const-HAND-LEFT}
No description provided yet.
### HAND_RIGHT = `3` {#const-HAND-RIGHT}
#### Type.HAND_RIGHT = `3` {#const-HAND-RIGHT}
No description provided yet.
### enum EventType
### GRIP = `0` {#const-GRIP}
#### EventType.GRIP = `0` {#const-GRIP}
No description provided yet.
### TRIGGER = `1` {#const-TRIGGER}
#### EventType.TRIGGER = `1` {#const-TRIGGER}
No description provided yet.
## Property Descriptions
### node: [Node3D](https://docs.godotengine.org/de/4.x/classes/class_node3d.html) {#node}
### node: [Node3D](https://docs.godotengine.org/de/4.x/classes/class_node3d.html) {#prop-node}
No description provided yet.
### type: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) {#type}
### type: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) {#prop-type}
No description provided yet.

44
docs/reference/lib--utils--pointer--pointer.md
View File

@ -1,21 +1,23 @@
# Pointer
**Inherits:** [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html)
## Description
Logic for the raycast to interact with objects
## Properties
| Name | Type | Default |
| --------------------------------- | ----------------------------------------------------------------------------- | ------------------ |
| [click_point](#click-point) | [Vector3](https://docs.godotengine.org/de/4.x/classes/class_vector3.html) | `Vector3(0, 0, 0)` |
| [initiator](#initiator) | [Initiator](/reference/lib--utils--pointer--initiator.html) | |
| [is_grabbed](#is-grabbed) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | `false` |
| [is_pressed](#is-pressed) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | `false` |
| [last_collided](#last-collided) | [Object](https://docs.godotengine.org/de/4.x/classes/class_object.html) | `null` |
| [moved](#moved) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | `false` |
| [ray](#ray) | [RayCast3D](https://docs.godotengine.org/de/4.x/classes/class_raycast3d.html) | |
| [time_pressed](#time-pressed) | [float](https://docs.godotengine.org/de/4.x/classes/class_float.html) | `0.0` |
| [timespan_click](#timespan-click) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | `400.0` |
| -------------------------------------- | ----------------------------------------------------------------------------- | ------------------ |
| [click_point](#prop-click-point) | [Vector3](https://docs.godotengine.org/de/4.x/classes/class_vector3.html) | `Vector3(0, 0, 0)` |
| [initiator](#prop-initiator) | [Initiator](/reference/lib--utils--pointer--initiator.html) | |
| [is_grabbed](#prop-is-grabbed) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | `false` |
| [is_pressed](#prop-is-pressed) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | `false` |
| [last_collided](#prop-last-collided) | [Object](https://docs.godotengine.org/de/4.x/classes/class_object.html) | `null` |
| [moved](#prop-moved) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | `false` |
| [ray](#prop-ray) | [RayCast3D](https://docs.godotengine.org/de/4.x/classes/class_raycast3d.html) | |
| [time_pressed](#prop-time-pressed) | [float](https://docs.godotengine.org/de/4.x/classes/class_float.html) | `0.0` |
| [timespan_click](#prop-timespan-click) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | `400.0` |
## Methods
@ -32,49 +34,49 @@
## Constants
## Constants
### Initiator = `<Object>` {#const-Initiator}
No description provided yet.
## Property Descriptions
### click_point: [Vector3](https://docs.godotengine.org/de/4.x/classes/class_vector3.html) {#click-point}
### click_point: [Vector3](https://docs.godotengine.org/de/4.x/classes/class_vector3.html) {#prop-click-point}
No description provided yet.
### initiator: [Initiator](/reference/lib--utils--pointer--initiator.html) {#initiator}
### initiator: [Initiator](/reference/lib--utils--pointer--initiator.html) {#prop-initiator}
No description provided yet.
### is_grabbed: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#is-grabbed}
### is_grabbed: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#prop-is-grabbed}
No description provided yet.
### is_pressed: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#is-pressed}
### is_pressed: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#prop-is-pressed}
No description provided yet.
### last_collided: [Object](https://docs.godotengine.org/de/4.x/classes/class_object.html) {#last-collided}
### last_collided: [Object](https://docs.godotengine.org/de/4.x/classes/class_object.html) {#prop-last-collided}
No description provided yet.
### moved: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#moved}
### moved: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#prop-moved}
No description provided yet.
### ray: [RayCast3D](https://docs.godotengine.org/de/4.x/classes/class_raycast3d.html) {#ray}
### ray: [RayCast3D](https://docs.godotengine.org/de/4.x/classes/class_raycast3d.html) {#prop-ray}
No description provided yet.
### time_pressed: [float](https://docs.godotengine.org/de/4.x/classes/class_float.html) {#time-pressed}
### time_pressed: [float](https://docs.godotengine.org/de/4.x/classes/class_float.html) {#prop-time-pressed}
No description provided yet.
### timespan_click: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#timespan-click}
### timespan_click: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#prop-timespan-click}
No description provided yet.

6
docs/reference/lib--utils--sample_hold.md
View File

@ -17,8 +17,10 @@
## Method Descriptions
### sample_and_hold (data: [PackedVector2Array](https://docs.godotengine.org/de/4.x/classes/class_packedvector2array.html) , sample_rate: [float](https://docs.godotengine.org/de/4.x/classes/class_float.html) ) -> [PackedFloat32Array](https://docs.godotengine.org/de/4.x/classes/class_packedfloat32array.html) {#sample-and-hold}
### static sample_and_hold (data: [PackedVector2Array](https://docs.godotengine.org/de/4.x/classes/class_packedvector2array.html) , sample_rate: [float](https://docs.godotengine.org/de/4.x/classes/class_float.html) ) -> [PackedFloat32Array](https://docs.godotengine.org/de/4.x/classes/class_packedfloat32array.html) {#sample-and-hold}
No description provided yet.
Reduces the frequency of a signal by sampling and holding the data

36
docs/reference/lib--utils--touch--collide.md
View File

@ -1,16 +1,18 @@
# Collide
**Inherits:** [Node3D](https://docs.godotengine.org/de/4.x/classes/class_node3d.html)
## Description
Calculates collision for fingers and FingerAreas
## Properties
| Name | Type | Default |
| --------------------------------- | ------------------------------------------------------------------------------- | ------- |
| [bodies_entered](#bodies-entered) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | |
| [finger_areas](#finger-areas) | [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) | |
| [hand_left](#hand-left) | [Node3D](https://docs.godotengine.org/de/4.x/classes/class_node3d.html) | |
| [hand_right](#hand-right) | [Node3D](https://docs.godotengine.org/de/4.x/classes/class_node3d.html) | |
| -------------------------------------- | ------------------------------------------------------------------------------- | ------- |
| [bodies_entered](#prop-bodies-entered) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | |
| [finger_areas](#prop-finger-areas) | [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) | |
| [hand_left](#prop-hand-left) | [Node3D](https://docs.godotengine.org/de/4.x/classes/class_node3d.html) | |
| [hand_right](#prop-hand-right) | [Node3D](https://docs.godotengine.org/de/4.x/classes/class_node3d.html) | |
## Methods
@ -24,29 +26,29 @@
## Constants
## Constants
### Finger = `<Object>` {#const-Finger}
No description provided yet.
## Property Descriptions
### bodies_entered: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#bodies-entered}
### bodies_entered: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#prop-bodies-entered}
Record<TouchBody3D, Array<Finger.Type>>
### finger_areas: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) {#prop-finger-areas}
Record<Finger.Type, Area3D>
### hand_left: [Node3D](https://docs.godotengine.org/de/4.x/classes/class_node3d.html) {#prop-hand-left}
No description provided yet.
### finger_areas: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) {#finger-areas}
No description provided yet.
### hand_left: [Node3D](https://docs.godotengine.org/de/4.x/classes/class_node3d.html) {#hand-left}
No description provided yet.
### hand_right: [Node3D](https://docs.godotengine.org/de/4.x/classes/class_node3d.html) {#hand-right}
### hand_right: [Node3D](https://docs.godotengine.org/de/4.x/classes/class_node3d.html) {#prop-hand-right}
No description provided yet.

54
docs/reference/lib--utils--touch--finger.md
View File

@ -1,87 +1,73 @@
# Finger
**Inherits:** [RefCounted](https://docs.godotengine.org/de/4.x/classes/class_refcounted.html)
## Description
Description of a finger area.
## Properties
| Name | Type | Default |
| ------------- | ----------------------------------------------------------------------- | ------- |
| [area](#area) | [Area3D](https://docs.godotengine.org/de/4.x/classes/class_area3d.html) | |
| [type](#type) | [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) | |
| ------------------ | ----------------------------------------------------------------------- | ------- |
| [area](#prop-area) | [Area3D](https://docs.godotengine.org/de/4.x/classes/class_area3d.html) | |
| [type](#prop-type) | [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) | |
## Constants
## Enums
### enum Type
### THUMB_RIGHT = `0` {#const-THUMB-RIGHT}
#### Type.THUMB_RIGHT = `0` {#const-THUMB-RIGHT}
No description provided yet.
### INDEX_RIGHT = `1` {#const-INDEX-RIGHT}
#### Type.INDEX_RIGHT = `1` {#const-INDEX-RIGHT}
No description provided yet.
### MIDDLE_RIGHT = `2` {#const-MIDDLE-RIGHT}
#### Type.MIDDLE_RIGHT = `2` {#const-MIDDLE-RIGHT}
No description provided yet.
### RING_RIGHT = `3` {#const-RING-RIGHT}
#### Type.RING_RIGHT = `3` {#const-RING-RIGHT}
No description provided yet.
### LITTLE_RIGHT = `4` {#const-LITTLE-RIGHT}
#### Type.LITTLE_RIGHT = `4` {#const-LITTLE-RIGHT}
No description provided yet.
### THUMB_LEFT = `5` {#const-THUMB-LEFT}
#### Type.THUMB_LEFT = `5` {#const-THUMB-LEFT}
No description provided yet.
### INDEX_LEFT = `6` {#const-INDEX-LEFT}
#### Type.INDEX_LEFT = `6` {#const-INDEX-LEFT}
No description provided yet.
### MIDDLE_LEFT = `7` {#const-MIDDLE-LEFT}
#### Type.MIDDLE_LEFT = `7` {#const-MIDDLE-LEFT}
No description provided yet.
### RING_LEFT = `8` {#const-RING-LEFT}
#### Type.RING_LEFT = `8` {#const-RING-LEFT}
No description provided yet.
### LITTLE_LEFT = `9` {#const-LITTLE-LEFT}
#### Type.LITTLE_LEFT = `9` {#const-LITTLE-LEFT}
No description provided yet.
## Property Descriptions
### area: [Area3D](https://docs.godotengine.org/de/4.x/classes/class_area3d.html) {#area}
### area: [Area3D](https://docs.godotengine.org/de/4.x/classes/class_area3d.html) {#prop-area}
No description provided yet.
### type: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) {#type}
### type: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) {#prop-type}
No description provided yet.

18
docs/reference/lib--utils--touch--touch.md
View File

@ -1,14 +1,16 @@
# Touch
**Inherits:** [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html)
## Description
Handles touch events and emits them to the EventSystem
## Properties
| Name | Type | Default |
| ------------------------------- | ------------------------------------------------------------------------------- | ------- |
| [areas_entered](#areas-entered) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | |
| [finger_areas](#finger-areas) | [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) | |
| ------------------------------------ | ------------------------------------------------------------------------------- | ------- |
| [areas_entered](#prop-areas-entered) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | |
| [finger_areas](#prop-finger-areas) | [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) | |
## Methods
@ -23,23 +25,23 @@
## Constants
## Constants
### Finger = `<Object>` {#const-Finger}
No description provided yet.
## Property Descriptions
### areas_entered: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#areas-entered}
### areas_entered: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#prop-areas-entered}
No description provided yet.
### finger_areas: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) {#finger-areas}
### finger_areas: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) {#prop-finger-areas}
No description provided yet.
Record<Finger.Type, Area3D>
## Method Descriptions

10
docs/reference/lib--utils--variant_serializer.md
View File

@ -18,12 +18,14 @@
## Method Descriptions
### parse_value (value: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) -> void {#parse-value}
### static parse_value (value: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) -> void {#parse-value}
No description provided yet.
Restore a dictionary from a JSON-serialized dictionary.
### stringify_value (value: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) -> void {#stringify-value}
### static stringify_value (value: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) -> void {#stringify-value}
No description provided yet.
Convert a dictionary to be able to be serialized to JSON.