add initial docs

This commit is contained in:
Nitwel 2024-03-16 18:45:43 +01:00
parent 3064ec3c00
commit 52083a9399
81 changed files with 3465 additions and 0 deletions

1
.gitignore vendored Normal file
View File

@ -0,0 +1 @@
.vscode

1
app/.gitignore vendored
View File

@ -2,6 +2,7 @@
.godot/
android/build/
builds/
reference/
# Godot-specific ignores
.import/

View File

@ -1,7 +1,9 @@
extends Node
## A simple class to manage callbacks for different keys
class_name CallbackMap
## Map of callbacks
var callbacks := {}
var single_callbacks: Array = []

3
docs/.gitignore vendored Normal file
View File

@ -0,0 +1,3 @@
reference/raw/
node_modules/
.vitepress/cache/

View File

@ -0,0 +1,31 @@
import { defineConfig } from 'vitepress'
import sidebar from './data/sidebar'
// https://vitepress.dev/reference/site-config
export default defineConfig({
title: "Immersive Home",
description: "A VitePress Site",
themeConfig: {
siteTitle: false,
logo: {
light: '/logo-dark.png',
dark: '/logo-light.png'
},
// https://vitepress.dev/reference/default-theme-config
nav: [
{ text: 'Usage', link: '/' },
{ text: 'Development', link: '/development/' },
{ text: 'Reference', link: sidebar['/reference/'][0].items[0].link }
],
search: {
provider: 'local'
},
sidebar,
socialLinks: [
{ icon: 'github', link: 'https://github.com/nitwel/immersive-home' },
{ icon: 'twitter', link: 'https://twitter.com/immersive_home' },
{ icon: 'discord', link: 'https://discord.gg/QgUnAzNVTx' }
]
}
})

View File

@ -0,0 +1,93 @@
import fs from 'fs'
import { camelCase } from 'lodash-es'
export default {
'/': [
{
text: 'Getting Started',
items: [
{
text: 'Quick Start',
link: '/'
},
{
text: 'Introduction',
link: '/getting-started/introduction'
},
{
text: 'Installation',
link: '/getting-started/installation'
}
]
}
],
'/development/': [
{
text: 'Development',
items: [
{
text: 'General',
link: '/development/'
}
]
}
],
'/reference/': getReferenceSidebar()
}
function getReferenceSidebar() {
const files: Record<string, any>[] = []
for (const file of fs.readdirSync('./reference')) {
if (!file.endsWith('.md')) continue
let path_parts = file.split('--').filter(part => part !== 'lib').map(part => capitalize(part))
if (path_parts[0].startsWith('Event')) {
path_parts = ['Events', ...path_parts]
}
insert_file(files, path_parts, file)
}
function insert_file(tree: Record<string, any>[], path_parts: string[], full_path: string) {
if (path_parts.length === 1) {
tree.push({
text: getTitle(path_parts[0]),
link: `/reference/${full_path}`
})
return
}
const part = path_parts.shift()!
let node = tree.find(node => node.text === part)
if (!node) {
node = { text: part, items: [] }
tree.push(node)
}
insert_file(node.items, path_parts, full_path)
}
return [
{
text: 'Reference',
items: files
}
]
}
function getTitle(name: string): string {
name = name.split('--').at(-1)!
name = name.split('.').at(0)!
return capitalize(camelCase(name))
}
function capitalize(string: string): string {
return string.charAt(0).toUpperCase() + string.slice(1);
}

View File

@ -0,0 +1,17 @@
// https://vitepress.dev/guide/custom-theme
import { h } from 'vue'
import type { Theme } from 'vitepress'
import DefaultTheme from 'vitepress/theme'
import './style.css'
export default {
extends: DefaultTheme,
Layout: () => {
return h(DefaultTheme.Layout, null, {
// https://vitepress.dev/guide/extending-default-theme#layout-slots
})
},
enhanceApp({ app, router, siteData }) {
// ...
}
} satisfies Theme

View File

@ -0,0 +1,140 @@
/**
* Customize default theme styling by overriding CSS variables:
* https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
*/
/**
* Colors
*
* Each colors have exact same color scale system with 3 levels of solid
* colors with different brightness, and 1 soft color.
*
* - `XXX-1`: The most solid color used mainly for colored text. It must
* satisfy the contrast ratio against when used on top of `XXX-soft`.
*
* - `XXX-2`: The color used mainly for hover state of the button.
*
* - `XXX-3`: The color for solid background, such as bg color of the button.
* It must satisfy the contrast ratio with pure white (#ffffff) text on
* top of it.
*
* - `XXX-soft`: The color used for subtle background such as custom container
* or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
* on top of it.
*
* The soft color must be semi transparent alpha channel. This is crucial
* because it allows adding multiple "soft" colors on top of each other
* to create a accent, such as when having inline code block inside
* custom containers.
*
* - `default`: The color used purely for subtle indication without any
* special meanings attched to it such as bg color for menu hover state.
*
* - `brand`: Used for primary brand colors, such as link text, button with
* brand theme, etc.
*
* - `tip`: Used to indicate useful information. The default theme uses the
* brand color for this by default.
*
* - `warning`: Used to indicate warning to the users. Used in custom
* container, badges, etc.
*
* - `danger`: Used to show error, or dangerous message to the users. Used
* in custom container, badges, etc.
* -------------------------------------------------------------------------- */
:root {
--vp-c-default-1: var(--vp-c-gray-1);
--vp-c-default-2: var(--vp-c-gray-2);
--vp-c-default-3: var(--vp-c-gray-3);
--vp-c-default-soft: var(--vp-c-gray-soft);
--vp-c-brand-1: var(--vp-c-indigo-1);
--vp-c-brand-2: var(--vp-c-indigo-2);
--vp-c-brand-3: var(--vp-c-indigo-3);
--vp-c-brand-soft: var(--vp-c-indigo-soft);
--vp-c-tip-1: var(--vp-c-brand-1);
--vp-c-tip-2: var(--vp-c-brand-2);
--vp-c-tip-3: var(--vp-c-brand-3);
--vp-c-tip-soft: var(--vp-c-brand-soft);
--vp-c-warning-1: var(--vp-c-yellow-1);
--vp-c-warning-2: var(--vp-c-yellow-2);
--vp-c-warning-3: var(--vp-c-yellow-3);
--vp-c-warning-soft: var(--vp-c-yellow-soft);
--vp-c-danger-1: var(--vp-c-red-1);
--vp-c-danger-2: var(--vp-c-red-2);
--vp-c-danger-3: var(--vp-c-red-3);
--vp-c-danger-soft: var(--vp-c-red-soft);
--vp-nav-logo-height: 36px;
}
/**
* Component: Button
* -------------------------------------------------------------------------- */
:root {
--vp-button-brand-border: transparent;
--vp-button-brand-text: var(--vp-c-white);
--vp-button-brand-bg: var(--vp-c-brand-3);
--vp-button-brand-hover-border: transparent;
--vp-button-brand-hover-text: var(--vp-c-white);
--vp-button-brand-hover-bg: var(--vp-c-brand-2);
--vp-button-brand-active-border: transparent;
--vp-button-brand-active-text: var(--vp-c-white);
--vp-button-brand-active-bg: var(--vp-c-brand-1);
}
/**
* Component: Home
* -------------------------------------------------------------------------- */
:root {
--vp-home-hero-name-color: transparent;
--vp-home-hero-name-background: -webkit-linear-gradient(
120deg,
#bd34fe 30%,
#41d1ff
);
--vp-home-hero-image-background-image: linear-gradient(
-45deg,
#bd34fe 50%,
#47caff 50%
);
--vp-home-hero-image-filter: blur(44px);
}
@media (min-width: 640px) {
:root {
--vp-home-hero-image-filter: blur(56px);
}
}
@media (min-width: 960px) {
:root {
--vp-home-hero-image-filter: blur(68px);
}
}
/**
* Component: Custom Block
* -------------------------------------------------------------------------- */
:root {
--vp-custom-block-tip-border: transparent;
--vp-custom-block-tip-text: var(--vp-c-text-1);
--vp-custom-block-tip-bg: var(--vp-c-brand-soft);
--vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
}
/**
* Component: Algolia
* -------------------------------------------------------------------------- */
.DocSearch {
--docsearch-primary-color: var(--vp-c-brand-1) !important;
}

View File

View File

View File

View File

@ -0,0 +1,7 @@
# Libglobalsaudioplayer

View File

@ -0,0 +1,7 @@
# Libglobalseventsystem

7
docs/globals/Homeapi.md Normal file
View File

@ -0,0 +1,7 @@
# Libglobalshomeapi

View File

@ -0,0 +1,7 @@
# Libglobalshousebody

View File

@ -0,0 +1,7 @@
# Libglobalsmainstore

7
docs/globals/Request.md Normal file
View File

@ -0,0 +1,7 @@
# Libglobalsrequest

View File

@ -0,0 +1,7 @@
# Libhomeapishasshass

View File

@ -0,0 +1,7 @@
# Libhomeapishasswshass

View File

@ -0,0 +1,7 @@
# Libhomeapishasswshandlersassist

View File

@ -0,0 +1,7 @@
# Libhomeapishasswshandlersauth

View File

@ -0,0 +1,7 @@
# Libhomeapishasswshandlersintegration

1
docs/index.md Normal file
View File

@ -0,0 +1 @@
# Quick Start Guide

26
docs/package.json Normal file
View File

@ -0,0 +1,26 @@
{
"name": "docs",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"generate": "tsx reference/generator/index.ts",
"dev": "vitepress dev",
"build": "vitepress build",
"preview": "vitepress preview"
},
"keywords": [],
"author": "",
"license": "ISC",
"devDependencies": {
"@types/lodash-es": "^4.17.12",
"@types/node": "^20.11.28",
"endent": "^2.1.0",
"fast-xml-parser": "^4.3.6",
"lodash-es": "^4.17.21",
"markdown-table": "^3.0.3",
"tsx": "^4.7.1",
"vitepress": "1.0.0-rc.45",
"vue": "^3.4.21"
}
}

1158
docs/pnpm-lock.yaml Normal file

File diff suppressed because it is too large Load Diff

BIN
docs/public/logo-dark.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

BIN
docs/public/logo-light.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

View File

@ -0,0 +1,54 @@
# CallbackMap
## Description
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) | |
## Methods
| Returns | Name |
| ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| void | [_validate_key](#-validate-key) ( key: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) |
| void | [add](#add) ( key: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), callback: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html) ) |
| void | [add_once](#add-once) ( key: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), callback: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html) ) |
| void | [call_key](#call-key) ( key: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), args: [Array](https://docs.godotengine.org/de/4.x/classes/class_array.html) ) |
| void | [remove](#remove) ( key: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), callback: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html) ) |
## Property Descriptions
### callbacks: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) {#callbacks}
No description provided yet.
### single_callbacks: [Array](https://docs.godotengine.org/de/4.x/classes/class_array.html) {#single-callbacks}
No description provided yet.
## Method Descriptions
### _validate_key ( key: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) -> void {#-validate-key}
No description provided yet.
### add ( key: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), callback: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html) ) -> void {#add}
No description provided yet.
### add_once ( key: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), callback: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html) ) -> void {#add-once}
No description provided yet.
### call_key ( key: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), args: [Array](https://docs.godotengine.org/de/4.x/classes/class_array.html) ) -> void {#call-key}
No description provided yet.
### remove ( key: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), callback: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html) ) -> void {#remove}
No description provided yet.

View File

@ -0,0 +1,19 @@
# EntityFactory
## Methods
| Returns | Name |
| ------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [create_entity](#create-entity) ( id: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) |
## 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}
No description provided yet.

19
docs/reference/Event.md Normal file
View File

@ -0,0 +1,19 @@
# Event
## Methods
| Returns | Name |
| ------- | ------------------------------------------------------------------------------------------------ |
| void | [merge](#merge) ( event: [Event](https://docs.godotengine.org/de/4.x/classes/class_event.html) ) |
## Method Descriptions
### merge ( event: [Event](https://docs.godotengine.org/de/4.x/classes/class_event.html) ) -> void {#merge}
No description provided yet.

View File

@ -0,0 +1,27 @@
# EventAction
## 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) | |
## Property Descriptions
### name: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#name}
No description provided yet.
### right_controller: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#right-controller}
No description provided yet.
### value: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#value}
No description provided yet.

View File

@ -0,0 +1,22 @@
# EventBubble
## 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) | |
## Property Descriptions
### bubbling: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#bubbling}
No description provided yet.
### target: [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) {#target}
No description provided yet.

View File

@ -0,0 +1,22 @@
# EventFocus
## 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) | |
## Property Descriptions
### previous_target: [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) {#previous-target}
No description provided yet.
### target: [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) {#target}
No description provided yet.

View File

@ -0,0 +1,32 @@
# EventKey
## 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) | |
## Methods
| Returns | Name |
| ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) | [key_to_string](#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) ) |
## Property Descriptions
### echo: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#echo}
No description provided yet.
### key: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) {#key}
No description provided yet.
## 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}
No description provided yet.

View File

@ -0,0 +1,22 @@
# EventNotify
## 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) | |
## Property Descriptions
### message: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#message}
No description provided yet.
### type: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) {#type}
No description provided yet.

View File

@ -0,0 +1,22 @@
# EventPointer
## 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) | |
## Property Descriptions
### initiator: [Initiator](/reference/lib--utils--pointer--initiator.html) {#initiator}
No description provided yet.
### ray: [RayCast3D](https://docs.godotengine.org/de/4.x/classes/class_raycast3d.html) {#ray}
No description provided yet.

View File

@ -0,0 +1,27 @@
# EventTouch
## Properties
| Name | Type | Default |
| ------------------- | ----------------------------------------------------- | ------- |
| [fingers](#fingers) | [Finger](/reference/lib--utils--touch--finger.html)[] | |
## Methods
| Returns | Name |
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [has_finger](#has-finger) ( finger: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) ) |
## Property Descriptions
### fingers: [Finger](/reference/lib--utils--touch--finger.html)[] {#fingers}
No description provided yet.
## 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.

View File

@ -0,0 +1,32 @@
# EventWithModifiers
## 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` |
## Property Descriptions
### alt_pressed: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#alt-pressed}
No description provided yet.
### control_pressed: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#control-pressed}
No description provided yet.
### meta_pressed: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#meta-pressed}
No description provided yet.
### shift_pressed: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#shift-pressed}
No description provided yet.

37
docs/reference/Proxy.md Normal file
View File

@ -0,0 +1,37 @@
# Proxy
## 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) | |
## Methods
| Returns | Name |
| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| void | [_init](#-init) ( gettable: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html), settable: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html) ) |
## Property Descriptions
### gettable: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html) {#gettable}
No description provided yet.
### settable: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html) {#settable}
No description provided yet.
### value: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#value}
No description provided yet.
## Method Descriptions
### _init ( gettable: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html), settable: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html) ) -> void {#-init}
No description provided yet.

View File

@ -0,0 +1,27 @@
# ProxyGroup
## Properties
| Name | Type | Default |
| ------------------- | ------------------------------------------------------------------------- | ------- |
| [proxies](#proxies) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | |
## Methods
| Returns | Name |
| ------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [proxy](#proxy) ( _get: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html), _set: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html) ) |
## Property Descriptions
### proxies: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#proxies}
No description provided yet.
## Method Descriptions
### proxy ( _get: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html), _set: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html) ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#proxy}
No description provided yet.

37
docs/reference/State.md Normal file
View File

@ -0,0 +1,37 @@
# State
## Properties
| Name | Type | Default |
| ------------------------------- | ----------------------------------------------------------------------------------- | ------- |
| [state_machine](#state-machine) | [StateMachine](https://docs.godotengine.org/de/4.x/classes/class_statemachine.html) | |
## Methods
| Returns | Name |
| ------------------------------------------------------------------------- | ---------------------------- |
| void | [_on_enter](#-on-enter) ( ) |
| void | [_on_leave](#-on-leave) ( ) |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [is_active](#is-active) ( ) |
## Property Descriptions
### state_machine: [StateMachine](https://docs.godotengine.org/de/4.x/classes/class_statemachine.html) {#state-machine}
No description provided yet.
## Method Descriptions
### _on_enter ( ) -> void {#-on-enter}
No description provided yet.
### _on_leave ( ) -> void {#-on-leave}
No description provided yet.
### is_active ( ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#is-active}
No description provided yet.

View File

@ -0,0 +1,42 @@
# StateMachine
## 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) | |
## Methods
| Returns | Name |
| ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| void | [_ready](#-ready) ( ) |
| void | [change_to](#change-to) ( new_state: [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](#get-state) ( state_name: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) |
## Property Descriptions
### current_state: [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) {#current-state}
No description provided yet.
### states: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) {#states}
No description provided yet.
## Method Descriptions
### _ready ( ) -> void {#-ready}
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.
### 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.

View File

@ -0,0 +1,215 @@
import { execSync } from 'child_process';
import { join } from 'path';
import { readdir, unlink, readFile, writeFile, mkdir } from 'fs/promises';
import { XMLParser } from 'fast-xml-parser'
import { camelCase } from 'lodash-es'
import { markdownTable } from 'markdown-table'
import endent from "endent";
const REFERENCE_PATH = './reference/raw'
// export_from_godot()
translate()
async function export_from_godot() {
try {
execSync('godot --doctool ../docs/reference/raw --gdscript-docs res://lib ', {
cwd: join(process.cwd(), '../app/'),
});
} catch (error) {
console.log('⚠️ Ignoring error exporting from Godot: ', error)
}
console.log('✅ Exported from Godot');
}
async function translate() {
for (const file of await readdir(REFERENCE_PATH)) {
const contents = await parse_reference(join(REFERENCE_PATH, file))
const markdown = translate_reference(contents)
await save_markdown(join('./reference', file.replace('.gd', '').replace('.xml', '.md')), markdown)
}
console.log('✅ Translated references to markdown');
}
async function parse_reference(path: string): Promise<string> {
return readFile(path, 'utf-8')
}
function translate_reference(contents: string): string {
const parser = new XMLParser({
ignoreAttributes: false,
attributeNamePrefix: '_'
})
const json = parser.parse(contents)
let description = ''
if (json.class.brief_description) {
description = endent`
## Description
${json.class.brief_description}
`
}
if (json.class.description) {
description = endent`
## Description
${json.class.description}
`
}
let members = ''
let member_descriptions = ''
let members_list = to_array(json.class.members?.member)
if (members_list.length > 0) {
members = endent`
## Properties
${markdownTable([
['Name', 'Type', 'Default'],
...members_list.map(member => {
const name = member._name
return [
`[${name}](#${name_to_anchor(name)})`,
link_godot_type(member._type),
handle_default(member._default)
]
})
])}
`
member_descriptions = '## Property Descriptions\n\n' +
members_list.map(member => {
const name = member._name
return endent`
### ${name}: ${link_godot_type(member._type)} ${'{#' + name_to_anchor(name) + '}'}
${member.description || 'No description provided yet.'}
`
}).join('\n\n')
}
let methods = ''
let method_descriptions = ''
let methods_list = to_array(json.class.methods?.method)
if (methods_list.length > 0) {
methods = endent`
## Methods
${markdownTable([
['Returns', 'Name'],
...methods_list.map(method => {
const name = method._name
let params = to_array(method?.param).map(param => {
return `${param._name}: ${link_godot_type(param._type)}`
}).join(', ')
return [
link_godot_type(method.return._type),
`[${name}](#${name_to_anchor(name)}) ( ${params} )`
]
})
])}
`
method_descriptions = '## Method Descriptions\n\n' +
methods_list.map(method => {
const name = method._name
let params = to_array(method?.param).map(param => {
return `${param._name}: ${link_godot_type(param._type)}`
}).join(', ')
return endent`
### ${name} ( ${params} ) -> ${link_godot_type(method.return._type)} ${'{#' + name_to_anchor(name) + '}'}
${method.description || 'No description provided yet.'}
`
}).join('\n\n')
}
let markdown = endent`
# ${getTitle(json.class._name)}
${description}
${members}
${methods}
${member_descriptions}
${method_descriptions}
` + '\n'
return markdown
}
async function save_markdown(path: string, markdown: string) {
return writeFile(path, markdown)
}
function getTitle(name: string): string {
name = name.split(/(?:--|\\|\/)/g).at(-1)
name = name.split('.').at(0)
return capitalize(camelCase(name))
}
function capitalize(string: string): string {
return string.charAt(0).toUpperCase() + string.slice(1);
}
function name_to_anchor(name: string): string {
return name.replace(/_/g, '-')
}
function link_godot_type(type: string): string {
if (!type || type === 'void') {
return 'void'
}
if (/"lib\/.*?\.gd"/g.test(type)) {
return type.replace(/"lib\/.*?\.gd"/, (match) => {
match = match.replace(/"/g, '')
const link = match.replace('.gd', '').replace(/\//g, '--')
return `[${getTitle(match)}](/reference/${link}.html)`
})
}
return `[${type}](https://docs.godotengine.org/de/4.x/classes/class_${type.toLowerCase()}.html)`
}
function to_array(object: any): any[] {
if (!object) {
return []
}
if (Array.isArray(object)) {
return object
} else {
return [object]
}
}
function handle_default(value: string): string {
if (!value || value === '<unknown>') {
return ''
}
return `\`${value}\``
}

View File

@ -0,0 +1,47 @@
# AudioPlayer
## 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
| Returns | Name |
| ------- | ---------------------------------------------------------------------------------------------------------------- |
| void | [_ready](#-ready) ( ) |
| void | [play_effect](#play-effect) ( sound: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) |
## Property Descriptions
### click_sound: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#click-sound}
No description provided yet.
### close_menu: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#close-menu}
No description provided yet.
### open_menu: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#open-menu}
No description provided yet.
### spawn_sound: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#spawn-sound}
No description provided yet.
## Method Descriptions
### _ready ( ) -> void {#-ready}
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.

View File

@ -0,0 +1,62 @@
# EventSystem
## 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` |
## Methods
| Returns | Name |
| ------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [_bubble_call](#-bubble-call) ( type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), target: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), event: [EventBubble](https://docs.godotengine.org/de/4.x/classes/class_eventbubble.html), focused: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [_handle_focus](#-handle-focus) ( target: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), event: [EventBubble](https://docs.godotengine.org/de/4.x/classes/class_eventbubble.html) ) |
| void | [_physics_process](#-physics-process) ( delta: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) |
| void | [_root_call](#-root-call) ( type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), event: [Event](https://docs.godotengine.org/de/4.x/classes/class_event.html) ) |
| void | [emit](#emit) ( type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), event: [Event](https://docs.godotengine.org/de/4.x/classes/class_event.html) ) |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [is_focused](#is-focused) ( node: [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) ) |
| void | [notify](#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) ) |
## Property Descriptions
### _active_node: [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) {#-active-node}
No description provided yet.
### _slow_tick: [float](https://docs.godotengine.org/de/4.x/classes/class_float.html) {#-slow-tick}
No description provided yet.
## Method Descriptions
### _bubble_call ( type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), target: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), event: [EventBubble](https://docs.godotengine.org/de/4.x/classes/class_eventbubble.html), focused: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#-bubble-call}
No description provided yet.
### _handle_focus ( target: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), event: [EventBubble](https://docs.godotengine.org/de/4.x/classes/class_eventbubble.html) ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#-handle-focus}
No description provided yet.
### _physics_process ( delta: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) -> void {#-physics-process}
No description provided yet.
### _root_call ( type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), event: [Event](https://docs.godotengine.org/de/4.x/classes/class_event.html) ) -> void {#-root-call}
No description provided yet.
### emit ( type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), event: [Event](https://docs.godotengine.org/de/4.x/classes/class_event.html) ) -> void {#emit}
No description provided yet.
### 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.
### 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.

View File

@ -0,0 +1,77 @@
# HomeApi
## Properties
| Name | Type | Default |
| ----------- | ------------------------------------------------------------------- | ------- |
| [api](#api) | [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) | |
## Methods
| Returns | Name |
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| void | [_notification](#-notification) ( what: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) |
| void | [_on_connect](#-on-connect) ( ) |
| void | [_on_disconnect](#-on-disconnect) ( ) |
| void | [_ready](#-ready) ( ) |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [get_device](#get-device) ( 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) | [get_devices](#get-devices) ( ) |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [get_state](#get-state) ( entity: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [has_connected](#has-connected) ( ) |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [set_state](#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) ) |
| void | [start_adapter](#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) ) |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [watch_state](#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) ) |
## Property Descriptions
### api: [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) {#api}
No description provided yet.
## Method Descriptions
### _notification ( what: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) -> void {#-notification}
No description provided yet.
### _on_connect ( ) -> void {#-on-connect}
No description provided yet.
### _on_disconnect ( ) -> void {#-on-disconnect}
No description provided yet.
### _ready ( ) -> void {#-ready}
No description provided yet.
### get_device ( 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) {#get-device}
Get a single device by id
### get_devices ( ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#get-devices}
Get a list of all devices
### get_state ( entity: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#get-state}
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.
### 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}
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.
### 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}
Watches the state and each time it changes, calls the callback with the changed state, returns a function to stop watching the state

View File

@ -0,0 +1,17 @@
# HouseBody
## Properties
| Name | Type | Default |
| ------------- | ------------------------------------------------------------------------- | ------- |
| [body](#body) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | |
## Property Descriptions
### body: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#body}
No description provided yet.

View File

@ -0,0 +1,27 @@
# MainStore
## 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) | |
## Property Descriptions
### devices: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#devices}
No description provided yet.
### house: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#house}
No description provided yet.
### settings: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#settings}
No description provided yet.

View File

@ -0,0 +1 @@
# Request

View File

@ -0,0 +1,57 @@
# Hass
## 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"` |
## Methods
| Returns | Name |
| ------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| void | [_init](#-init) ( 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) ) |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [get_devices](#get-devices) ( ) |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [get_state](#get-state) ( entity: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [set_state](#set-state) ( entity: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), state: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), attributes: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) ) |
## Property Descriptions
### devices_template: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#devices-template}
No description provided yet.
### headers: [PackedStringArray](https://docs.godotengine.org/de/4.x/classes/class_packedstringarray.html) {#headers}
No description provided yet.
### token: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#token}
No description provided yet.
### url: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#url}
No description provided yet.
## Method Descriptions
### _init ( 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 {#-init}
No description provided yet.
### get_devices ( ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#get-devices}
No description provided yet.
### get_state ( entity: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#get-state}
No description provided yet.
### set_state ( entity: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), state: [String](https://docs.godotengine.org/de/4.x/classes/class_string.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}
No description provided yet.

View File

@ -0,0 +1,77 @@
# Assist
## 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` |
## Methods
| Returns | Name |
| ------- | ------------------------------------------------------------------------------------------------------------------------------ |
| void | [_init](#-init) ( hass: [Hass](/reference/lib--home_apis--hass_ws--hass.html) ) |
| void | [handle_message](#handle-message) ( message: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) ) |
| void | [on_connect](#on-connect) ( ) |
| void | [send_data](#send-data) ( data: [PackedByteArray](https://docs.godotengine.org/de/4.x/classes/class_packedbytearray.html) ) |
| void | [start_wakeword](#start-wakeword) ( ) |
## Property Descriptions
### api: [Hass](/reference/lib--home_apis--hass_ws--hass.html) {#api}
No description provided yet.
### handler_id: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) {#handler-id}
No description provided yet.
### pipe_running: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#pipe-running}
No description provided yet.
### stt_message: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#stt-message}
No description provided yet.
### tts_message: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#tts-message}
No description provided yet.
### tts_sound: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#tts-sound}
No description provided yet.
### wake_word: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#wake-word}
No description provided yet.
## Method Descriptions
### _init ( hass: [Hass](/reference/lib--home_apis--hass_ws--hass.html) ) -> void {#-init}
No description provided yet.
### handle_message ( message: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) ) -> void {#handle-message}
No description provided yet.
### on_connect ( ) -> void {#on-connect}
No description provided yet.
### send_data ( data: [PackedByteArray](https://docs.godotengine.org/de/4.x/classes/class_packedbytearray.html) ) -> void {#send-data}
No description provided yet.
### start_wakeword ( ) -> void {#start-wakeword}
No description provided yet.

View File

@ -0,0 +1,52 @@
# Auth
## 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) | |
## Methods
| Returns | Name |
| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| void | [_init](#-init) ( hass: [Hass](/reference/lib--home_apis--hass_ws--hass.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 | [handle_message](#handle-message) ( message: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) |
| void | [on_disconnect](#on-disconnect) ( ) |
## Property Descriptions
### api: [Hass](/reference/lib--home_apis--hass_ws--hass.html) {#api}
No description provided yet.
### authenticated: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#authenticated}
No description provided yet.
### token: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#token}
No description provided yet.
### url: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#url}
No description provided yet.
## Method Descriptions
### _init ( hass: [Hass](/reference/lib--home_apis--hass_ws--hass.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 {#-init}
No description provided yet.
### handle_message ( message: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) -> void {#handle-message}
No description provided yet.
### on_disconnect ( ) -> void {#on-disconnect}
No description provided yet.

View File

@ -0,0 +1,37 @@
# Integration
## 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` |
## Methods
| Returns | Name |
| ------- | ------------------------------------------------------------------------------- |
| void | [_init](#-init) ( hass: [Hass](/reference/lib--home_apis--hass_ws--hass.html) ) |
| void | [on_connect](#on-connect) ( ) |
## Property Descriptions
### api: [Hass](/reference/lib--home_apis--hass_ws--hass.html) {#api}
No description provided yet.
### integration_exists: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#integration-exists}
No description provided yet.
## Method Descriptions
### _init ( hass: [Hass](/reference/lib--home_apis--hass_ws--hass.html) ) -> void {#-init}
No description provided yet.
### on_connect ( ) -> void {#on-connect}
No description provided yet.

View File

@ -0,0 +1,192 @@
# Hass
## 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](https://docs.godotengine.org/de/4.x/classes/class_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](https://docs.godotengine.org/de/4.x/classes/class_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) | `""` |
## Methods
| Returns | Name |
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| void | [_init](#-init) ( 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 | [_process](#-process) ( delta: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) |
| void | [connect_ws](#connect-ws) ( ) |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [decode_packet](#decode-packet) ( packet: [PackedByteArray](https://docs.godotengine.org/de/4.x/classes/class_packedbytearray.html) ) |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [encode_packet](#encode-packet) ( packet: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) ) |
| void | [get_device](#get-device) ( 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) | [get_devices](#get-devices) ( ) |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [get_state](#get-state) ( entity: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) |
| void | [handle_connect](#handle-connect) ( ) |
| void | [handle_disconnect](#handle-disconnect) ( ) |
| void | [handle_packet](#handle-packet) ( packet: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) ) |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [has_connected](#has-connected) ( ) |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [has_integration](#has-integration) ( ) |
| void | [send_packet](#send-packet) ( packet: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html), with_id: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) ) |
| void | [send_raw](#send-raw) ( packet: [PackedByteArray](https://docs.godotengine.org/de/4.x/classes/class_packedbytearray.html) ) |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [send_request_packet](#send-request-packet) ( packet: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html), ignore_initial: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) ) |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [send_subscribe_packet](#send-subscribe-packet) ( packet: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.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) | [set_state](#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) ) |
| void | [start_subscriptions](#start-subscriptions) ( ) |
| void | [update_room](#update-room) ( room: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [watch_state](#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) ) |
## Property Descriptions
### LOG_MESSAGES: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#LOG-MESSAGES}
No description provided yet.
### assist_handler: [Assist](/reference/lib--home_apis--hass_ws--handlers--assist.html) {#assist-handler}
No description provided yet.
### auth_handler: [Auth](/reference/lib--home_apis--hass_ws--handlers--auth.html) {#auth-handler}
No description provided yet.
### connected: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#connected}
No description provided yet.
### devices_template: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#devices-template}
No description provided yet.
### entities: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) {#entities}
No description provided yet.
### entitiy_callbacks: [CallbackMap](https://docs.godotengine.org/de/4.x/classes/class_callbackmap.html) {#entitiy-callbacks}
No description provided yet.
### id: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) {#id}
No description provided yet.
### integration_handler: [Integration](/reference/lib--home_apis--hass_ws--handlers--integration.html) {#integration-handler}
No description provided yet.
### packet_callbacks: [CallbackMap](https://docs.godotengine.org/de/4.x/classes/class_callbackmap.html) {#packet-callbacks}
No description provided yet.
### request_timeout: [float](https://docs.godotengine.org/de/4.x/classes/class_float.html) {#request-timeout}
No description provided yet.
### socket: [WebSocketPeer](https://docs.godotengine.org/de/4.x/classes/class_websocketpeer.html) {#socket}
No description provided yet.
### token: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#token}
No description provided yet.
### url: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#url}
No description provided yet.
## Method Descriptions
### _init ( 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 {#-init}
No description provided yet.
### _process ( delta: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) -> void {#-process}
No description provided yet.
### connect_ws ( ) -> void {#connect-ws}
No description provided yet.
### decode_packet ( packet: [PackedByteArray](https://docs.godotengine.org/de/4.x/classes/class_packedbytearray.html) ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#decode-packet}
No description provided yet.
### encode_packet ( packet: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#encode-packet}
No description provided yet.
### get_device ( id: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) -> void {#get-device}
No description provided yet.
### get_devices ( ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#get-devices}
No description provided yet.
### get_state ( entity: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#get-state}
No description provided yet.
### handle_connect ( ) -> void {#handle-connect}
No description provided yet.
### handle_disconnect ( ) -> void {#handle-disconnect}
No description provided yet.
### handle_packet ( packet: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) ) -> void {#handle-packet}
No description provided yet.
### has_connected ( ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#has-connected}
No description provided yet.
### has_integration ( ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#has-integration}
No description provided yet.
### send_packet ( packet: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html), with_id: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) ) -> void {#send-packet}
No description provided yet.
### send_raw ( packet: [PackedByteArray](https://docs.godotengine.org/de/4.x/classes/class_packedbytearray.html) ) -> void {#send-raw}
No description provided yet.
### send_request_packet ( packet: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html), ignore_initial: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#send-request-packet}
No description provided yet.
### send_subscribe_packet ( packet: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.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) {#send-subscribe-packet}
No description provided yet.
### 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}
No description provided yet.
### start_subscriptions ( ) -> void {#start-subscriptions}
No description provided yet.
### update_room ( room: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) -> void {#update-room}
No description provided yet.
### 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}
No description provided yet.

View File

@ -0,0 +1,19 @@
# Devices
## Methods
| Returns | Name |
| ------- | -------------------- |
| void | [clear](#clear) ( ) |
## Method Descriptions
### clear ( ) -> void {#clear}
No description provided yet.

View File

@ -0,0 +1,52 @@
# House
## 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) | |
## Methods
| Returns | Name |
| ------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| void | [_init](#-init) ( ) |
| void | [clear](#clear) ( ) |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [get_room](#get-room) ( name: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) |
## Property Descriptions
### align_position1: [Vector3](https://docs.godotengine.org/de/4.x/classes/class_vector3.html) {#align-position1}
No description provided yet.
### align_position2: [Vector3](https://docs.godotengine.org/de/4.x/classes/class_vector3.html) {#align-position2}
No description provided yet.
### entities: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#entities}
No description provided yet.
### rooms: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#rooms}
No description provided yet.
## Method Descriptions
### _init ( ) -> void {#-init}
No description provided yet.
### clear ( ) -> void {#clear}
No description provided yet.
### get_room ( name: [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-room}
No description provided yet.

View File

@ -0,0 +1,47 @@
# Settings
## 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` |
## Methods
| Returns | Name |
| ------- | -------------------- |
| void | [_init](#-init) ( ) |
| void | [clear](#clear) ( ) |
## Property Descriptions
### token: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#token}
No description provided yet.
### type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#type}
No description provided yet.
### url: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) {#url}
No description provided yet.
### voice_assistant: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#voice-assistant}
No description provided yet.
## Method Descriptions
### _init ( ) -> void {#-init}
No description provided yet.
### clear ( ) -> void {#clear}
No description provided yet.

View File

@ -0,0 +1,57 @@
# Store
## 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` |
## Methods
| Returns | Name |
| ------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| void | [clear](#clear) ( ) |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [create_dict](#create-dict) ( ) |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [is_loaded](#is-loaded) ( ) |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [load_local](#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) | [save_local](#save-local) ( path: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) |
| void | [use_dict](#use-dict) ( dict: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) ) |
## Property Descriptions
### _loaded: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#-loaded}
No description provided yet.
### _save_path: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#-save-path}
No description provided yet.
## Method Descriptions
### clear ( ) -> void {#clear}
No description provided yet.
### create_dict ( ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#create-dict}
No description provided yet.
### is_loaded ( ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#is-loaded}
No description provided yet.
### 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}
No description provided yet.
### save_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) {#save-local}
No description provided yet.
### use_dict ( dict: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) ) -> void {#use-dict}
No description provided yet.

View File

@ -0,0 +1,19 @@
# FontTools
## Methods
| Returns | Name |
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [get_font_size](#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) ) |
## 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}
No description provided yet.

View File

@ -0,0 +1 @@
# Gesture

View File

@ -0,0 +1,32 @@
# Initiator
## 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) | |
## Methods
| Returns | Name |
| ------------------------------------------------------------------- | -------------------------- |
| [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | [is_right](#is-right) ( ) |
## Property Descriptions
### node: [Node3D](https://docs.godotengine.org/de/4.x/classes/class_node3d.html) {#node}
No description provided yet.
### type: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) {#type}
No description provided yet.
## Method Descriptions
### is_right ( ) -> [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#is-right}
No description provided yet.

View File

@ -0,0 +1,102 @@
# Pointer
## 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` |
## Methods
| Returns | Name |
| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| void | [_emit_event](#-emit-event) ( type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), target: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) |
| void | [_handle_enter_leave](#-handle-enter-leave) ( ) |
| void | [_handle_move](#-handle-move) ( ) |
| void | [_init](#-init) ( initiator: [Initiator](/reference/lib--utils--pointer--initiator.html), ray: [RayCast3D](https://docs.godotengine.org/de/4.x/classes/class_raycast3d.html) ) |
| void | [_on_pressed](#-on-pressed) ( type: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) ) |
| void | [_on_released](#-on-released) ( type: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) ) |
| void | [_physics_process](#-physics-process) ( _delta: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) |
| void | [_ready](#-ready) ( ) |
## Property Descriptions
### click_point: [Vector3](https://docs.godotengine.org/de/4.x/classes/class_vector3.html) {#click-point}
No description provided yet.
### initiator: [Initiator](/reference/lib--utils--pointer--initiator.html) {#initiator}
No description provided yet.
### is_grabbed: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#is-grabbed}
No description provided yet.
### is_pressed: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#is-pressed}
No description provided yet.
### last_collided: [Object](https://docs.godotengine.org/de/4.x/classes/class_object.html) {#last-collided}
No description provided yet.
### moved: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#moved}
No description provided yet.
### ray: [RayCast3D](https://docs.godotengine.org/de/4.x/classes/class_raycast3d.html) {#ray}
No description provided yet.
### time_pressed: [float](https://docs.godotengine.org/de/4.x/classes/class_float.html) {#time-pressed}
No description provided yet.
### timespan_click: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#timespan-click}
No description provided yet.
## Method Descriptions
### _emit_event ( type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), target: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) -> void {#-emit-event}
No description provided yet.
### _handle_enter_leave ( ) -> void {#-handle-enter-leave}
No description provided yet.
### _handle_move ( ) -> void {#-handle-move}
No description provided yet.
### _init ( initiator: [Initiator](/reference/lib--utils--pointer--initiator.html), ray: [RayCast3D](https://docs.godotengine.org/de/4.x/classes/class_raycast3d.html) ) -> void {#-init}
No description provided yet.
### _on_pressed ( type: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) ) -> void {#-on-pressed}
No description provided yet.
### _on_released ( type: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) ) -> void {#-on-released}
No description provided yet.
### _physics_process ( _delta: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) -> void {#-physics-process}
No description provided yet.
### _ready ( ) -> void {#-ready}
No description provided yet.

View File

@ -0,0 +1,19 @@
# SampleHold
## Methods
| Returns | Name |
| ----------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [PackedFloat32Array](https://docs.godotengine.org/de/4.x/classes/class_packedfloat32array.html) | [sample_and_hold](#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) ) |
## 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}
No description provided yet.

View File

@ -0,0 +1,62 @@
# Collide
## 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) | |
## Methods
| Returns | Name |
| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| void | [_init](#-init) ( hand_left: [OpenXRHand](https://docs.godotengine.org/de/4.x/classes/class_openxrhand.html), hand_right: [OpenXRHand](https://docs.godotengine.org/de/4.x/classes/class_openxrhand.html), finger_areas: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) ) |
| void | [_on_body_entered](#-on-body-entered) ( finger_type: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), body: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) |
| void | [_on_body_exited](#-on-body-exited) ( finger_type: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), body: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) |
| void | [_physics_process](#-physics-process) ( _delta: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) |
| void | [_ready](#-ready) ( ) |
## Property Descriptions
### bodies_entered: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#bodies-entered}
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}
No description provided yet.
## Method Descriptions
### _init ( hand_left: [OpenXRHand](https://docs.godotengine.org/de/4.x/classes/class_openxrhand.html), hand_right: [OpenXRHand](https://docs.godotengine.org/de/4.x/classes/class_openxrhand.html), finger_areas: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) ) -> void {#-init}
No description provided yet.
### _on_body_entered ( finger_type: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), body: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) -> void {#-on-body-entered}
No description provided yet.
### _on_body_exited ( finger_type: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), body: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) -> void {#-on-body-exited}
No description provided yet.
### _physics_process ( _delta: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) -> void {#-physics-process}
No description provided yet.
### _ready ( ) -> void {#-ready}
No description provided yet.

View File

@ -0,0 +1,22 @@
# Finger
## 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) | |
## Property Descriptions
### area: [Area3D](https://docs.godotengine.org/de/4.x/classes/class_area3d.html) {#area}
No description provided yet.
### type: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) {#type}
No description provided yet.

View File

@ -0,0 +1,57 @@
# Touch
## 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) | |
## Methods
| Returns | Name |
| ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| void | [_emit_event](#-emit-event) ( type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), target: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) |
| void | [_init](#-init) ( finger_areas: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) ) |
| void | [_on_area_entered](#-on-area-entered) ( finger_type: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), area: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) |
| void | [_on_area_exited](#-on-area-exited) ( finger_type: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), area: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) |
| void | [_physics_process](#-physics-process) ( _delta: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) |
| void | [_ready](#-ready) ( ) |
## Property Descriptions
### areas_entered: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#areas-entered}
No description provided yet.
### finger_areas: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) {#finger-areas}
No description provided yet.
## Method Descriptions
### _emit_event ( type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), target: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) -> void {#-emit-event}
No description provided yet.
### _init ( finger_areas: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) ) -> void {#-init}
No description provided yet.
### _on_area_entered ( finger_type: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), area: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) -> void {#-on-area-entered}
No description provided yet.
### _on_area_exited ( finger_type: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), area: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) -> void {#-on-area-exited}
No description provided yet.
### _physics_process ( _delta: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) -> void {#-physics-process}
No description provided yet.
### _ready ( ) -> void {#-ready}
No description provided yet.

View File

@ -0,0 +1,24 @@
# VariantSerializer
## Methods
| Returns | Name |
| ------- | ------------------------------------------------------------------------------------------------------------------------ |
| void | [parse_value](#parse-value) ( value: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) |
| void | [stringify_value](#stringify-value) ( value: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) |
## Method Descriptions
### parse_value ( value: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) -> void {#parse-value}
No description provided yet.
### stringify_value ( value: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) -> void {#stringify-value}
No description provided yet.

7
docs/stores/Devices.md Normal file
View File

@ -0,0 +1,7 @@
# Libstoresdevices

7
docs/stores/House.md Normal file
View File

@ -0,0 +1,7 @@
# Libstoreshouse

7
docs/stores/Settings.md Normal file
View File

@ -0,0 +1,7 @@
# Libstoressettings

7
docs/stores/Store.md Normal file
View File

@ -0,0 +1,7 @@
# Libstoresstore

9
docs/tsconfig.json Normal file
View File

@ -0,0 +1,9 @@
{
"compilerOptions": {
"module": "commonjs",
"target": "es6",
"types": [
"node"
]
}
}

7
docs/utils/Fonttools.md Normal file
View File

@ -0,0 +1,7 @@
# Libutilsfonttools

7
docs/utils/Samplehold.md Normal file
View File

@ -0,0 +1,7 @@
# Libutilssamplehold

View File

@ -0,0 +1,7 @@
# Libutilsvariantserializer

View File

@ -0,0 +1,7 @@
# Libutilsgesturegesture

View File

@ -0,0 +1,7 @@
# Libutilspointerinitiator

View File

@ -0,0 +1,7 @@
# Libutilspointerpointer

View File

@ -0,0 +1,7 @@
# Libutilstouchcollide

View File

@ -0,0 +1,7 @@
# Libutilstouchfinger

View File

@ -0,0 +1,7 @@
# Libutilstouchtouch