diff --git a/app/lib/events/event.gd b/app/lib/events/event.gd index 33779f8..c95788b 100644 --- a/app/lib/events/event.gd +++ b/app/lib/events/event.gd @@ -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.") diff --git a/app/lib/events/event_action.gd b/app/lib/events/event_action.gd index d770d9f..59e120c 100644 --- a/app/lib/events/event_action.gd +++ b/app/lib/events/event_action.gd @@ -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 \ No newline at end of file +## Boolean, Float or Vector2 +var value \ No newline at end of file diff --git a/app/lib/events/event_bubble.gd b/app/lib/events/event_bubble.gd index a72ca89..2b715f9 100644 --- a/app/lib/events/event_bubble.gd +++ b/app/lib/events/event_bubble.gd @@ -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 \ No newline at end of file diff --git a/app/lib/events/event_focus.gd b/app/lib/events/event_focus.gd index 24b0449..35f9858 100644 --- a/app/lib/events/event_focus.gd +++ b/app/lib/events/event_focus.gd @@ -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 \ No newline at end of file diff --git a/app/lib/events/event_key.gd b/app/lib/events/event_key.gd index 6f5276f..0ccf79c 100644 --- a/app/lib/events/event_key.gd +++ b/app/lib/events/event_key.gd @@ -1,10 +1,14 @@ 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 -static func key_to_string(key: Key, caps: bool = false, apply_to: String = "") -> String: +## 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() KEY_BACKSPACE: apply_to = apply_to.substr(0, apply_to.length() - 1) diff --git a/app/lib/events/event_notify.gd b/app/lib/events/event_notify.gd index 991a847..6f59222 100644 --- a/app/lib/events/event_notify.gd +++ b/app/lib/events/event_notify.gd @@ -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 \ No newline at end of file diff --git a/app/lib/events/event_pointer.gd b/app/lib/events/event_pointer.gd index 1b87346..f71a010 100644 --- a/app/lib/events/event_pointer.gd +++ b/app/lib/events/event_pointer.gd @@ -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") +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 \ No newline at end of file diff --git a/app/lib/events/event_touch.gd b/app/lib/events/event_touch.gd index 3c38616..726abfb 100644 --- a/app/lib/events/event_touch.gd +++ b/app/lib/events/event_touch.gd @@ -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") +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: diff --git a/app/lib/events/event_with_modifiers.gd b/app/lib/events/event_with_modifiers.gd index 14a7389..7ebc6b5 100644 --- a/app/lib/events/event_with_modifiers.gd +++ b/app/lib/events/event_with_modifiers.gd @@ -1,4 +1,5 @@ extends Event +## Base for Events using a Keyboard class_name EventWithModifiers var alt_pressed := false diff --git a/app/lib/globals/audio_player.gd b/app/lib/globals/audio_player.gd index 2920612..4165940 100644 --- a/app/lib/globals/audio_player.gd +++ b/app/lib/globals/audio_player.gd @@ -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 diff --git a/app/lib/globals/event_system.gd b/app/lib/globals/event_system.gd index 6b4be4b..31c5c6e 100644 --- a/app/lib/globals/event_system.gd +++ b/app/lib/globals/event_system.gd @@ -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) -func notify(message: String, type := EventNotify.Type.INFO): +## 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 @@ -68,23 +97,23 @@ func _handle_focus(target: Variant, event: EventBubble): event_focus.previous_target = _active_node event_focus.target = target - if _active_node != null && _active_node.has_method(FN_PREFIX + "focus_out"): + if _active_node != null&&_active_node.has_method(FN_PREFIX + "focus_out"): _active_node.call(FN_PREFIX + "focus_out", event_focus) on_focus_out.emit(event_focus) - if target == null || target.is_in_group("ui_focus") == false: + if target == null||target.is_in_group("ui_focus") == false: _active_node = null return false _active_node = target - if _active_node != null && _active_node.has_method(FN_PREFIX + "focus_in"): + if _active_node != null&&_active_node.has_method(FN_PREFIX + "focus_in"): _active_node.call(FN_PREFIX + "focus_in", event_focus) on_focus_in.emit(event_focus) return true -func _bubble_call(type: String, target: Variant, event: EventBubble, focused = false): +func _bubble_call(type: String, target: Variant, event: EventBubble, focused=false): if target == null: return false @@ -98,16 +127,16 @@ func _bubble_call(type: String, target: Variant, event: EventBubble, focused = f if event.bubbling == false: return false - if (type == "press_down" || type == "touch_enter") && focused == false: + if (type == "press_down"||type == "touch_enter")&&focused == false: focused = _handle_focus(target, event) for child in target.get_children(): - if child is Function && child.has_method(FN_PREFIX + type): + if child is Function&&child.has_method(FN_PREFIX + type): child.call(FN_PREFIX + type, event) var parent = target.get_parent() - if parent != null && parent is Node: + if parent != null&&parent is Node: _bubble_call(type, parent, event, focused) else: # in case the top has been reached @@ -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) diff --git a/app/lib/globals/home_api.gd b/app/lib/globals/home_api.gd index 3f4b523..97b2b0a 100644 --- a/app/lib/globals/home_api.gd +++ b/app/lib/globals/home_api.gd @@ -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 diff --git a/app/lib/globals/house_body.gd b/app/lib/globals/house_body.gd index 4b0b520..5ea5d3c 100644 --- a/app/lib/globals/house_body.gd +++ b/app/lib/globals/house_body.gd @@ -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") \ No newline at end of file diff --git a/app/lib/globals/main_store.gd b/app/lib/globals/main_store.gd index 3d822ea..eebfc97 100644 --- a/app/lib/globals/main_store.gd +++ b/app/lib/globals/main_store.gd @@ -1,8 +1,9 @@ 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") -const DevicesStore = preload("res://lib/stores/devices.gd") +const SettingsStore = preload ("res://lib/stores/settings.gd") +const HouseStore = preload ("res://lib/stores/house.gd") +const DevicesStore = preload ("res://lib/stores/devices.gd") var settings = SettingsStore.new() var house = HouseStore.new() diff --git a/app/lib/stores/house.gd b/app/lib/stores/house.gd index 9726c65..d135c6c 100644 --- a/app/lib/stores/house.gd +++ b/app/lib/stores/house.gd @@ -1,22 +1,22 @@ extends StoreClass +## Stores information about the house, its rooms and entities -const StoreClass = preload("./store.gd") +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" diff --git a/app/lib/stores/settings.gd b/app/lib/stores/settings.gd index d277210..3c39ec0 100644 --- a/app/lib/stores/settings.gd +++ b/app/lib/stores/settings.gd @@ -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(): diff --git a/app/lib/stores/store.gd b/app/lib/stores/store.gd index f2ac103..0392f15 100644 --- a/app/lib/stores/store.gd +++ b/app/lib/stores/store.gd @@ -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 diff --git a/app/lib/utils/entity_factory.gd b/app/lib/utils/entity_factory.gd index 3d56341..3c34cc5 100644 --- a/app/lib/utils/entity_factory.gd +++ b/app/lib/utils/entity_factory.gd @@ -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") diff --git a/app/lib/utils/font_tools.gd b/app/lib/utils/font_tools.gd index a8677c6..b7adc91 100644 --- a/app/lib/utils/font_tools.gd +++ b/app/lib/utils/font_tools.gd @@ -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 diff --git a/app/lib/utils/pointer/initiator.gd b/app/lib/utils/pointer/initiator.gd index d76af07..12e13d0 100644 --- a/app/lib/utils/pointer/initiator.gd +++ b/app/lib/utils/pointer/initiator.gd @@ -1,4 +1,5 @@ extends RefCounted +## Defines what triggered a EventPointer enum Type { CONTROLLER_LEFT, @@ -19,4 +20,4 @@ var node: Node3D var type: Type func is_right() -> bool: - return type == Type.CONTROLLER_RIGHT || type == Type.HAND_RIGHT \ No newline at end of file + return type == Type.CONTROLLER_RIGHT||type == Type.HAND_RIGHT \ No newline at end of file diff --git a/app/lib/utils/pointer/pointer.gd b/app/lib/utils/pointer/pointer.gd index 90bd707..e299a4a 100644 --- a/app/lib/utils/pointer/pointer.gd +++ b/app/lib/utils/pointer/pointer.gd @@ -1,6 +1,7 @@ extends Node +## Logic for the raycast to interact with objects -const Initiator = preload("./initiator.gd") +const Initiator = preload ("./initiator.gd") var initiator: Initiator var ray: RayCast3D @@ -28,7 +29,7 @@ func _physics_process(_delta): func _handle_move(): var time_passed = Time.get_ticks_msec() - time_pressed - if time_passed <= timespan_click || (is_pressed == false && is_grabbed == false): + if time_passed <= timespan_click||(is_pressed == false&&is_grabbed == false): return moved = true @@ -39,19 +40,19 @@ func _handle_move(): return if is_pressed: - _emit_event("press_move", last_collided ) + _emit_event("press_move", last_collided) if is_grabbed: - _emit_event("grab_move", last_collided ) + _emit_event("grab_move", last_collided) func _handle_enter_leave(): var collider = ray.get_collider() - if collider == last_collided || is_grabbed || is_pressed: + if collider == last_collided||is_grabbed||is_pressed: return - _emit_event("ray_enter", collider ) - _emit_event("ray_leave", last_collided ) + _emit_event("ray_enter", collider) + _emit_event("ray_leave", last_collided) last_collided = collider @@ -66,25 +67,25 @@ func _on_pressed(type: Initiator.EventType): is_pressed = true time_pressed = Time.get_ticks_msec() click_point = ray.get_collision_point() - _emit_event("press_down", collider ) + _emit_event("press_down", collider) Initiator.EventType.GRIP: is_grabbed = true click_point = ray.get_collision_point() - _emit_event("grab_down", collider ) + _emit_event("grab_down", collider) func _on_released(type: Initiator.EventType): match type: Initiator.EventType.TRIGGER: if is_pressed: if moved == false: - _emit_event("click", last_collided ) - _emit_event("press_up", last_collided ) + _emit_event("click", last_collided) + _emit_event("press_up", last_collided) is_pressed = false last_collided = null moved = false Initiator.EventType.GRIP: if is_grabbed: - _emit_event("grab_up", last_collided ) + _emit_event("grab_up", last_collided) is_grabbed = false last_collided = null moved = false diff --git a/app/lib/utils/proxy.gd b/app/lib/utils/proxy.gd index e42aefe..0660fed 100644 --- a/app/lib/utils/proxy.gd +++ b/app/lib/utils/proxy.gd @@ -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) - diff --git a/app/lib/utils/proxy_group.gd b/app/lib/utils/proxy_group.gd index 0cd956e..d4c58c2 100644 --- a/app/lib/utils/proxy_group.gd +++ b/app/lib/utils/proxy_group.gd @@ -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 = [] diff --git a/app/lib/utils/sample_hold.gd b/app/lib/utils/sample_hold.gd index 97f25c5..bdbfa28 100644 --- a/app/lib/utils/sample_hold.gd +++ b/app/lib/utils/sample_hold.gd @@ -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)) diff --git a/app/lib/utils/state_machine/state.gd b/app/lib/utils/state_machine/state.gd index 521d0ea..b2a998f 100644 --- a/app/lib/utils/state_machine/state.gd +++ b/app/lib/utils/state_machine/state.gd @@ -1,4 +1,5 @@ extends Node +## Base Class for all states class_name State var state_machine: StateMachine diff --git a/app/lib/utils/state_machine/state_machine.gd b/app/lib/utils/state_machine/state_machine.gd index 0ef6377..6ba1b28 100644 --- a/app/lib/utils/state_machine/state_machine.gd +++ b/app/lib/utils/state_machine/state_machine.gd @@ -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 diff --git a/app/lib/utils/touch/collide.gd b/app/lib/utils/touch/collide.gd index 88a3845..891a210 100644 --- a/app/lib/utils/touch/collide.gd +++ b/app/lib/utils/touch/collide.gd @@ -1,4 +1,5 @@ extends Node3D +## Calculates collision for fingers and FingerAreas const Finger = preload ("res://lib/utils/touch/finger.gd") diff --git a/app/lib/utils/touch/finger.gd b/app/lib/utils/touch/finger.gd index 4b29b84..3226e53 100644 --- a/app/lib/utils/touch/finger.gd +++ b/app/lib/utils/touch/finger.gd @@ -1,4 +1,5 @@ extends RefCounted +## Description of a finger area. enum Type { THUMB_RIGHT, diff --git a/app/lib/utils/touch/touch.gd b/app/lib/utils/touch/touch.gd index 575c677..4a75c7b 100644 --- a/app/lib/utils/touch/touch.gd +++ b/app/lib/utils/touch/touch.gd @@ -1,6 +1,7 @@ extends Node +## Handles touch events and emits them to the EventSystem -const Finger = preload("res://lib/utils/touch/finger.gd") +const Finger = preload ("res://lib/utils/touch/finger.gd") ## Record var finger_areas: Dictionary diff --git a/app/lib/utils/variant_serializer.gd b/app/lib/utils/variant_serializer.gd index bad1869..636ee7d 100644 --- a/app/lib/utils/variant_serializer.gd +++ b/app/lib/utils/variant_serializer.gd @@ -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): diff --git a/docs/reference/CallbackMap.md b/docs/reference/CallbackMap.md index 7ab17f1..1a58aaa 100644 --- a/docs/reference/CallbackMap.md +++ b/docs/reference/CallbackMap.md @@ -7,10 +7,10 @@ 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) | | +| Name | Type | Default | +| ------------------------------------------ | ------------------------------------------------------------------------------- | ------- | +| [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,34 +26,36 @@ 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. ## Method Descriptions -### _validate_key (key: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) -> void {#-validate-key} +### _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} +### 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} +### 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} +### 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} +### 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. diff --git a/docs/reference/EntityFactory.md b/docs/reference/EntityFactory.md index a071353..60f1346 100644 --- a/docs/reference/EntityFactory.md +++ b/docs/reference/EntityFactory.md @@ -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 = `` {#const-Switch} No description provided yet. - - ### Light = `` {#const-Light} No description provided yet. - - ### Sensor = `` {#const-Sensor} No description provided yet. - - ### MediaPlayer = `` {#const-MediaPlayer} No description provided yet. - - ### Camera = `` {#const-Camera} No description provided yet. - - ### ButtonEntity = `` {#const-ButtonEntity} No description provided yet. - - ### NumberEntity = `` {#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. diff --git a/docs/reference/Event.md b/docs/reference/Event.md index d2317ac..bacd353 100644 --- a/docs/reference/Event.md +++ b/docs/reference/Event.md @@ -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} +### 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. diff --git a/docs/reference/EventAction.md b/docs/reference/EventAction.md index e4f64aa..71f0aa4 100644 --- a/docs/reference/EventAction.md +++ b/docs/reference/EventAction.md @@ -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 | Type | Default | +| ------------------------------------------ | ------------------------------------------------------------------------- | ------- | +| [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 diff --git a/docs/reference/EventBubble.md b/docs/reference/EventBubble.md index 4a4b3b5..b63b4fe 100644 --- a/docs/reference/EventBubble.md +++ b/docs/reference/EventBubble.md @@ -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) | | +| Name | Type | Default | +| -------------------------- | ------------------------------------------------------------------- | ------- | +| [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. diff --git a/docs/reference/EventFocus.md b/docs/reference/EventFocus.md index 5d4f985..52a40f9 100644 --- a/docs/reference/EventFocus.md +++ b/docs/reference/EventFocus.md @@ -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) | | +| Name | Type | Default | +| ---------------------------------------- | ------------------------------------------------------------------- | ------- | +| [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. diff --git a/docs/reference/EventKey.md b/docs/reference/EventKey.md index 7a76f90..3215f0d 100644 --- a/docs/reference/EventKey.md +++ b/docs/reference/EventKey.md @@ -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) | | +| Name | Type | Default | +| ------------------ | ------------------------------------------------------------------- | ------- | +| [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 diff --git a/docs/reference/EventNotify.md b/docs/reference/EventNotify.md index 33fd25b..3dad1e4 100644 --- a/docs/reference/EventNotify.md +++ b/docs/reference/EventNotify.md @@ -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) | | +| Name | Type | Default | +| ------------------------ | ----------------------------------------------------------------------- | ------- | +| [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 + +#### Type.INFO = `0` {#const-INFO} + +The message is informational + +#### Type.SUCCESS = `1` {#const-SUCCESS} + +The message is a success message + +#### Type.WARNING = `2` {#const-WARNING} + +The message is a warning + +#### Type.DANGER = `3` {#const-DANGER} + +The message is an error -### INFO = `0` {#const-INFO} - -No description provided yet. - - - -### SUCCESS = `1` {#const-SUCCESS} - -No description provided yet. - - - -### 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 diff --git a/docs/reference/EventPointer.md b/docs/reference/EventPointer.md index 8954013..cd60cd7 100644 --- a/docs/reference/EventPointer.md +++ b/docs/reference/EventPointer.md @@ -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) | | +| Name | Type | Default | +| ---------------------------- | ----------------------------------------------------------------------------- | ------- | +| [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 = `` {#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. diff --git a/docs/reference/EventTouch.md b/docs/reference/EventTouch.md index 92e7c0e..c30bfb4 100644 --- a/docs/reference/EventTouch.md +++ b/docs/reference/EventTouch.md @@ -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)[] | | +| Name | Type | Default | +| ------------------------ | ----------------------------------------------------- | ------- | +| [fingers](#prop-fingers) | [Finger](/reference/lib--utils--touch--finger.html)[] | | ## Methods @@ -17,22 +19,22 @@ -## Constants +## Constants + ### Finger = `` {#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} +### 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. diff --git a/docs/reference/EventWithModifiers.md b/docs/reference/EventWithModifiers.md index 7a04ab1..a308ac8 100644 --- a/docs/reference/EventWithModifiers.md +++ b/docs/reference/EventWithModifiers.md @@ -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` | +| Name | Type | Default | +| ---------------------------------------- | ------------------------------------------------------------------- | ------- | +| [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. diff --git a/docs/reference/Proxy.md b/docs/reference/Proxy.md index 2e61cec..88cdc17 100644 --- a/docs/reference/Proxy.md +++ b/docs/reference/Proxy.md @@ -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) | | +| Name | Type | Default | +| -------------------------- | --------------------------------------------------------------------------- | ------- | +| [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,22 +27,24 @@ 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. ## 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} +### _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. diff --git a/docs/reference/ProxyGroup.md b/docs/reference/ProxyGroup.md index ecfcefc..a5eb806 100644 --- a/docs/reference/ProxyGroup.md +++ b/docs/reference/ProxyGroup.md @@ -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) | | +| Name | Type | Default | +| ------------------------ | ------------------------------------------------------------------------- | ------- | +| [proxies](#prop-proxies) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | | ## Methods @@ -19,14 +21,16 @@ + + ## 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. ## 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} +### 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. diff --git a/docs/reference/State.md b/docs/reference/State.md index 541bb21..e10e443 100644 --- a/docs/reference/State.md +++ b/docs/reference/State.md @@ -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) | | +| Name | Type | Default | +| ------------------------------------ | -------------------------------------------- | ------- | +| [state_machine](#prop-state-machine) | [StateMachine](/reference/StateMachine.html) | | ## Methods @@ -21,22 +23,24 @@ + + ## Property Descriptions -### state_machine: [StateMachine](/reference/StateMachine.html) {#state-machine} +### state_machine: [StateMachine](/reference/StateMachine.html) {#prop-state-machine} No description provided yet. ## Method Descriptions -### _on_enter ( ) -> void {#-on-enter} +### _on_enter ( ) -> void {#-on-enter} No description provided yet. -### _on_leave ( ) -> void {#-on-leave} +### _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} +### is_active ( ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#is-active} No description provided yet. diff --git a/docs/reference/StateMachine.md b/docs/reference/StateMachine.md index 126ff3a..e2c77c0 100644 --- a/docs/reference/StateMachine.md +++ b/docs/reference/StateMachine.md @@ -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) | | +| Name | Type | Default | +| ------------------------------------ | ------------------------------------------------------------------------------- | ------- | +| [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,26 +28,28 @@ 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. ## Method Descriptions -### _ready ( ) -> void {#-ready} +### _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} +### 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} +### 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 diff --git a/docs/reference/generator/index.ts b/docs/reference/generator/index.ts index 85c1c4a..93075ef 100644 --- a/docs/reference/generator/index.ts +++ b/docs/reference/generator/index.ts @@ -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,21 +102,52 @@ 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 endent` + ### ${name} = \`${constant._value}\` ${'{#const-' + name_to_anchor(name) + '}'} - return ` -### ${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} diff --git a/docs/reference/lib--globals--audio_player.md b/docs/reference/lib--globals--audio_player.md index e925a89..078bda7 100644 --- a/docs/reference/lib--globals--audio_player.md +++ b/docs/reference/lib--globals--audio_player.md @@ -3,14 +3,7 @@ -## Properties -| Name | Type | Default | -| --------------------------- | ------------------------------------------------------------------------- | ---------- | -| [click_sound](#click-sound) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | `` | -| [close_menu](#close-menu) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | `` | -| [open_menu](#open-menu) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | `` | -| [spawn_sound](#spawn-sound) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | `` | ## Methods @@ -23,30 +16,32 @@ -## Property Descriptions +## Constants -### click_sound: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#click-sound} +### click_sound = `` {#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 = `` {#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 = `` {#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 = `` {#const-close-menu} No description provided yet. + + ## Method Descriptions -### _ready ( ) -> void {#-ready} +### _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} +### 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 diff --git a/docs/reference/lib--globals--event_system.md b/docs/reference/lib--globals--event_system.md index d629a94..98379a8 100644 --- a/docs/reference/lib--globals--event_system.md +++ b/docs/reference/lib--globals--event_system.md @@ -5,10 +5,10 @@ ## 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` | +| Name | Type | Default | +| ---------------------------------- | --------------------------------------------------------------------- | ------- | +| [_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,144 +26,140 @@ ### 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. ## 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](/reference/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} +### _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](/reference/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](/reference/EventBubble.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](/reference/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} +### _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](/reference/Event.html) ) -> void {#-root-call} +### _root_call (type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) , event: [Event](/reference/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](/reference/Event.html) ) -> void {#emit} +### 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} +### 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} +### 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 diff --git a/docs/reference/lib--globals--home_api.md b/docs/reference/lib--globals--home_api.md index c7e1eba..3a1faf4 100644 --- a/docs/reference/lib--globals--home_api.md +++ b/docs/reference/lib--globals--home_api.md @@ -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) | | +| Name | Type | Default | +| ---------------- | ------------------------------------------------------------------- | ------- | +| [api](#prop-api) | [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) | | ## Methods @@ -29,86 +31,86 @@ ### 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 = `` {#const-Hass} No description provided yet. - - ### HassWebSocket = `` {#const-HassWebSocket} No description provided yet. - - ### apis = `{"hass": , "hass_ws": }` {#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 -### _notification (what: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) -> void {#-notification} +### _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} +### _on_connect ( ) -> void {#-on-connect} No description provided yet. -### _on_disconnect ( ) -> void {#-on-disconnect} +### _on_disconnect ( ) -> void {#-on-disconnect} No description provided yet. -### _ready ( ) -> void {#-ready} +### _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_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_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} +### 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} +### 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} +### 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} +### 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} +### 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 diff --git a/docs/reference/lib--globals--house_body.md b/docs/reference/lib--globals--house_body.md index 9cebcf3..cfbf1be 100644 --- a/docs/reference/lib--globals--house_body.md +++ b/docs/reference/lib--globals--house_body.md @@ -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) | | +| Name | Type | Default | +| ------------------ | ------------------------------------------------------------------------- | ------- | +| [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. diff --git a/docs/reference/lib--globals--main_store.md b/docs/reference/lib--globals--main_store.md index a69b183..e9863c4 100644 --- a/docs/reference/lib--globals--main_store.md +++ b/docs/reference/lib--globals--main_store.md @@ -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) | | +| Name | Type | Default | +| -------------------------- | ------------------------------------------------------------------------- | ------- | +| [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 = `` {#const-SettingsStore} No description provided yet. - - ### HouseStore = `` {#const-HouseStore} No description provided yet. - - ### DevicesStore = `` {#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. diff --git a/docs/reference/lib--home_apis--hass--hass.md b/docs/reference/lib--home_apis--hass--hass.md index 8c25839..df7a189 100644 --- a/docs/reference/lib--home_apis--hass--hass.md +++ b/docs/reference/lib--home_apis--hass--hass.md @@ -5,12 +5,12 @@ ## 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"` | +| Name | Type | Default | +| ------------------------------------------ | --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [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,38 +25,40 @@ + + ## 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. ## 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} +### _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} +### 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} +### 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} +### 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. diff --git a/docs/reference/lib--home_apis--hass_ws--handlers--assist.md b/docs/reference/lib--home_apis--hass_ws--handlers--assist.md index 4f7f95a..640d58d 100644 --- a/docs/reference/lib--home_apis--hass_ws--handlers--assist.md +++ b/docs/reference/lib--home_apis--hass_ws--handlers--assist.md @@ -5,15 +5,15 @@ ## 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` | +| Name | Type | Default | +| ---------------------------------- | ------------------------------------------------------------------------- | ------- | +| [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,62 +47,62 @@ No description provided yet. No description provided yet. -## Constants +## Constants + ### HASS_API = `` {#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. ## Method Descriptions -### _init (hass: [Hass](/reference/lib--home_apis--hass_ws--hass.html) ) -> void {#-init} +### _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} +### 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} +### 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} +### 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} +### start_wakeword ( ) -> void {#start-wakeword} No description provided yet. diff --git a/docs/reference/lib--home_apis--hass_ws--handlers--auth.md b/docs/reference/lib--home_apis--hass_ws--handlers--auth.md index b4016ae..572116f 100644 --- a/docs/reference/lib--home_apis--hass_ws--handlers--auth.md +++ b/docs/reference/lib--home_apis--hass_ws--handlers--auth.md @@ -5,12 +5,12 @@ ## 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) | | +| Name | Type | Default | +| ------------------------------------ | ----------------------------------------------------------------------- | ------- | +| [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,42 +26,42 @@ No description provided yet. -## Constants +## Constants + ### HASS_API = `` {#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. ## 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} +### _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} +### 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} +### on_disconnect ( ) -> void {#on-disconnect} No description provided yet. diff --git a/docs/reference/lib--home_apis--hass_ws--handlers--integration.md b/docs/reference/lib--home_apis--hass_ws--handlers--integration.md index 7d035e4..3863abe 100644 --- a/docs/reference/lib--home_apis--hass_ws--handlers--integration.md +++ b/docs/reference/lib--home_apis--hass_ws--handlers--integration.md @@ -5,10 +5,10 @@ ## 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` | +| Name | Type | Default | +| ---------------------------------------------- | ------------------------------------------------------------------- | ------- | +| [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,30 +19,30 @@ -## Constants +## Constants + ### HASS_API = `` {#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. ## Method Descriptions -### _init (hass: [Hass](/reference/lib--home_apis--hass_ws--hass.html) ) -> void {#-init} +### _init (hass: [Hass](/reference/lib--home_apis--hass_ws--hass.html) ) -> void {#-init} No description provided yet. -### on_connect ( ) -> void {#on-connect} +### on_connect ( ) -> void {#on-connect} No description provided yet. diff --git a/docs/reference/lib--home_apis--hass_ws--hass.md b/docs/reference/lib--home_apis--hass_ws--hass.md index d36366e..28cfb3b 100644 --- a/docs/reference/lib--home_apis--hass_ws--hass.md +++ b/docs/reference/lib--home_apis--hass_ws--hass.md @@ -5,22 +5,22 @@ ## 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) | `""` | +| Name | Type | Default | +| ------------------------------------------------ | ------------------------------------------------------------------------------------- | ------- | +| [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,166 +58,162 @@ No description provided yet. No description provided yet. -## Constants +## Constants + ### AuthHandler = `` {#const-AuthHandler} No description provided yet. - - ### IntegrationHandler = `` {#const-IntegrationHandler} No description provided yet. - - ### AssistHandler = `` {#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. ## 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} +### _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} +### _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} +### 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} +### 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} +### 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} +### 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} +### 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} +### 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} +### handle_connect ( ) -> void {#handle-connect} No description provided yet. -### handle_disconnect ( ) -> void {#handle-disconnect} +### 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} +### 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} +### 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} +### 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} +### 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} +### 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} +### 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} +### 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} +### 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} +### 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} +### 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} +### 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. diff --git a/docs/reference/lib--stores--devices.md b/docs/reference/lib--stores--devices.md index 6d49a09..df90f9e 100644 --- a/docs/reference/lib--stores--devices.md +++ b/docs/reference/lib--stores--devices.md @@ -13,18 +13,18 @@ -## Constants +## Constants + ### StoreClass = `` {#const-StoreClass} No description provided yet. - ## Method Descriptions -### clear ( ) -> void {#clear} +### clear ( ) -> void {#clear} No description provided yet. diff --git a/docs/reference/lib--stores--house.md b/docs/reference/lib--stores--house.md index 2377999..00ce83d 100644 --- a/docs/reference/lib--stores--house.md +++ b/docs/reference/lib--stores--house.md @@ -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) | | +| Name | Type | Default | +| ---------------------------------------- | ------------------------------------------------------------------------- | ------- | +| [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,42 +24,42 @@ -## Constants +## Constants + ### StoreClass = `` {#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 -### _init ( ) -> void {#-init} +### _init ( ) -> void {#-init} No description provided yet. -### clear ( ) -> void {#clear} +### 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} +### 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. diff --git a/docs/reference/lib--stores--settings.md b/docs/reference/lib--stores--settings.md index 6ae265f..66b6629 100644 --- a/docs/reference/lib--stores--settings.md +++ b/docs/reference/lib--stores--settings.md @@ -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` | +| Name | Type | Default | +| ---------------------------------------- | ----------------------------------------------------------------------- | ----------- | +| [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,38 +23,38 @@ -## Constants +## Constants + ### StoreClass = `` {#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 -### _init ( ) -> void {#-init} +### _init ( ) -> void {#-init} No description provided yet. -### clear ( ) -> void {#clear} +### clear ( ) -> void {#clear} No description provided yet. diff --git a/docs/reference/lib--stores--store.md b/docs/reference/lib--stores--store.md index d1e5d1f..f2f11b1 100644 --- a/docs/reference/lib--stores--store.md +++ b/docs/reference/lib--stores--store.md @@ -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` | +| Name | Type | Default | +| ------------------------------ | ------------------------------------------------------------------------- | ------- | +| [_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,52 +27,52 @@ ### 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 = `` {#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. ## Method Descriptions -### clear ( ) -> void {#clear} +### clear ( ) -> void {#clear} + +Resets the data to its default state. + +### create_dict ( ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#create-dict} No description provided yet. -### create_dict ( ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#create-dict} +### is_loaded ( ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#is-loaded} + +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} No description provided yet. -### is_loaded ( ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#is-loaded} +### 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. -### 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} +### use_dict (dict: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) ) -> void {#use-dict} No description provided yet. diff --git a/docs/reference/lib--utils--font_tools.md b/docs/reference/lib--utils--font_tools.md index b757fd5..3ac21c8 100644 --- a/docs/reference/lib--utils--font_tools.md +++ b/docs/reference/lib--utils--font_tools.md @@ -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 diff --git a/docs/reference/lib--utils--pointer--initiator.md b/docs/reference/lib--utils--pointer--initiator.md index ee3e487..940af3f 100644 --- a/docs/reference/lib--utils--pointer--initiator.md +++ b/docs/reference/lib--utils--pointer--initiator.md @@ -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) | | +| Name | Type | Default | +| ------------------ | ----------------------------------------------------------------------- | ------- | +| [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,56 +28,50 @@ 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. ## Method Descriptions -### is_right ( ) -> [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#is-right} +### is_right ( ) -> [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#is-right} No description provided yet. diff --git a/docs/reference/lib--utils--pointer--pointer.md b/docs/reference/lib--utils--pointer--pointer.md index 90888ce..d6abca2 100644 --- a/docs/reference/lib--utils--pointer--pointer.md +++ b/docs/reference/lib--utils--pointer--pointer.md @@ -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` | +| Name | Type | Default | +| -------------------------------------- | ----------------------------------------------------------------------------- | ------------------ | +| [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,82 +34,82 @@ -## Constants +## Constants + ### Initiator = `` {#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. ## 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} +### _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} +### _handle_enter_leave ( ) -> void {#-handle-enter-leave} No description provided yet. -### _handle_move ( ) -> void {#-handle-move} +### _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} +### _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} +### _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} +### _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} +### _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} +### _ready ( ) -> void {#-ready} No description provided yet. diff --git a/docs/reference/lib--utils--sample_hold.md b/docs/reference/lib--utils--sample_hold.md index 7ad6b5e..fdfcd4e 100644 --- a/docs/reference/lib--utils--sample_hold.md +++ b/docs/reference/lib--utils--sample_hold.md @@ -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 diff --git a/docs/reference/lib--utils--touch--collide.md b/docs/reference/lib--utils--touch--collide.md index b81fc10..8dda078 100644 --- a/docs/reference/lib--utils--touch--collide.md +++ b/docs/reference/lib--utils--touch--collide.md @@ -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) | | +| Name | Type | Default | +| -------------------------------------- | ------------------------------------------------------------------------------- | ------- | +| [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,50 +26,50 @@ -## Constants +## Constants + ### Finger = `` {#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> + +### finger_areas: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) {#prop-finger-areas} + +Record + +### 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. ## 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} +### _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} +### _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} +### _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} +### _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} +### _ready ( ) -> void {#-ready} No description provided yet. diff --git a/docs/reference/lib--utils--touch--finger.md b/docs/reference/lib--utils--touch--finger.md index 9cd04cf..5621be5 100644 --- a/docs/reference/lib--utils--touch--finger.md +++ b/docs/reference/lib--utils--touch--finger.md @@ -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) | | +| Name | Type | Default | +| ------------------ | ----------------------------------------------------------------------- | ------- | +| [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. diff --git a/docs/reference/lib--utils--touch--touch.md b/docs/reference/lib--utils--touch--touch.md index 1a565d7..278f58e 100644 --- a/docs/reference/lib--utils--touch--touch.md +++ b/docs/reference/lib--utils--touch--touch.md @@ -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) | | +| Name | Type | Default | +| ------------------------------------ | ------------------------------------------------------------------------------- | ------- | +| [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,46 +25,46 @@ -## Constants +## Constants + ### Finger = `` {#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 ## 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} +### _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} +### _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} +### _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} +### _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} +### _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} +### _ready ( ) -> void {#-ready} No description provided yet. diff --git a/docs/reference/lib--utils--variant_serializer.md b/docs/reference/lib--utils--variant_serializer.md index c577c6d..6f3387c 100644 --- a/docs/reference/lib--utils--variant_serializer.md +++ b/docs/reference/lib--utils--variant_serializer.md @@ -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.