From 3c0a12d005f22ef39693a63144f510f9115e956a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lera=20Elvo=C3=A9?= <yagich@poto.cafe>
Date: Thu, 14 Dec 2023 21:15:42 +0300
Subject: [PATCH] add/edit descriptions of most nodes

---
 classes/deck/nodes/bool_constant.gd                 | 1 +
 classes/deck/nodes/button.gd                        | 2 +-
 classes/deck/nodes/delay.gd                         | 2 +-
 classes/deck/nodes/dictionary_get_key.gd            | 2 +-
 classes/deck/nodes/expression_node.gd               | 2 +-
 classes/deck/nodes/get_deck_var.gd                  | 2 +-
 classes/deck/nodes/obs_decompose_transform.gd       | 2 +-
 classes/deck/nodes/obs_search_source.gd             | 2 +-
 classes/deck/nodes/obs_set_source_transform.gd      | 2 +-
 classes/deck/nodes/obs_switch_scene.gd              | 2 +-
 classes/deck/nodes/obs_vector_to_position.gd        | 2 +-
 classes/deck/nodes/obs_websocket_generic_request.gd | 2 +-
 classes/deck/nodes/print.gd                         | 2 +-
 classes/deck/nodes/process_node.gd                  | 2 +-
 classes/deck/nodes/set_deck_var.gd                  | 2 +-
 classes/deck/nodes/string_constant.gd               | 1 +
 classes/deck/nodes/twitch_chat_received.gd          | 2 +-
 classes/deck/nodes/twitch_send_chat.gd              | 2 +-
 classes/deck/nodes/vector_add.gd                    | 2 +-
 classes/deck/nodes/vector_compose.gd                | 2 +-
 classes/deck/nodes/vector_decompose.gd              | 2 +-
 classes/deck/nodes/vector_dot.gd                    | 2 +-
 classes/deck/nodes/vector_multiply.gd               | 2 +-
 classes/deck/nodes/vector_normalize.gd              | 2 +-
 classes/deck/nodes/vector_subtract.gd               | 2 +-
 25 files changed, 25 insertions(+), 23 deletions(-)

diff --git a/classes/deck/nodes/bool_constant.gd b/classes/deck/nodes/bool_constant.gd
index cc61cbd..87a4479 100644
--- a/classes/deck/nodes/bool_constant.gd
+++ b/classes/deck/nodes/bool_constant.gd
@@ -5,6 +5,7 @@ func _init() -> void:
 	name = "Bool Constant"
 	node_type = name.to_snake_case()
 	category = "general"
+	description = "A checkbox."
 
 	add_output_port(
 		DeckType.Types.BOOL,
diff --git a/classes/deck/nodes/button.gd b/classes/deck/nodes/button.gd
index e87fa0d..e0ea223 100644
--- a/classes/deck/nodes/button.gd
+++ b/classes/deck/nodes/button.gd
@@ -4,7 +4,7 @@ extends DeckNode
 func _init() -> void:
 	name = "Button"
 	node_type = "button"
-	description = "a button"
+	description = "A button to trigger certain nodes that have a trigger input."
 	category = "general"
 
 	add_output_port(
diff --git a/classes/deck/nodes/delay.gd b/classes/deck/nodes/delay.gd
index 13258ae..2bf0b64 100644
--- a/classes/deck/nodes/delay.gd
+++ b/classes/deck/nodes/delay.gd
@@ -5,7 +5,7 @@ var thread : Thread
 func _init():
 	name = "Delay"
 	node_type = name.to_snake_case()
-	description = "A Node that passes through the input after the set time."
+	description = "A node that passes through its' input after the set time."
 	category = "general"
 
 	add_output_port(DeckType.Types.ANY, "Value")
diff --git a/classes/deck/nodes/dictionary_get_key.gd b/classes/deck/nodes/dictionary_get_key.gd
index bebcc8e..f42ca73 100644
--- a/classes/deck/nodes/dictionary_get_key.gd
+++ b/classes/deck/nodes/dictionary_get_key.gd
@@ -4,7 +4,7 @@ extends DeckNode
 func _init() -> void:
 	name = "Get Dictionary Key"
 	node_type = "dictionary_get_key"
-	description = ""
+	description = "Returns the value of a key from a dictionary input, if it exists, or null otherwise."
 	category = "general"
 
 	add_input_port(
diff --git a/classes/deck/nodes/expression_node.gd b/classes/deck/nodes/expression_node.gd
index c908183..e37fab2 100644
--- a/classes/deck/nodes/expression_node.gd
+++ b/classes/deck/nodes/expression_node.gd
@@ -5,7 +5,7 @@ var expr = Expression.new()
 func _init():
 	name = "Expression"
 	node_type = name.to_snake_case()
-	description = "A Node holding a block of executable GDScript code."
+	description = "A node returning the result of a mathematical expression."
 	category = "general"
 
 	props_to_serialize = []
diff --git a/classes/deck/nodes/get_deck_var.gd b/classes/deck/nodes/get_deck_var.gd
index aa98fb0..56b9038 100644
--- a/classes/deck/nodes/get_deck_var.gd
+++ b/classes/deck/nodes/get_deck_var.gd
@@ -4,7 +4,7 @@ extends DeckNode
 func _init() -> void:
 	name = "Get Deck Var"
 	node_type = name.to_snake_case()
-	description = "retrieve a deck variable"
+	description = "Retrieve a deck variable."
 	category = "general"
 
 	add_output_port(
diff --git a/classes/deck/nodes/obs_decompose_transform.gd b/classes/deck/nodes/obs_decompose_transform.gd
index 4645925..c6508de 100644
--- a/classes/deck/nodes/obs_decompose_transform.gd
+++ b/classes/deck/nodes/obs_decompose_transform.gd
@@ -4,7 +4,7 @@ extends DeckNode
 func _init() -> void:
 	name = "Decompose OBS Transform"
 	node_type = "obs_decompose_transform"
-	description = ""
+	description = "Splits an OBS transform from one object into multiple outputs."
 	category = "obs"
 
 	add_input_port(
diff --git a/classes/deck/nodes/obs_search_source.gd b/classes/deck/nodes/obs_search_source.gd
index eab53a2..cbab62a 100644
--- a/classes/deck/nodes/obs_search_source.gd
+++ b/classes/deck/nodes/obs_search_source.gd
@@ -10,7 +10,7 @@ var cached_id # TODO: evaluate if this caching is actually needed
 func _init() -> void:
 	name = "Get Source ID"
 	node_type = "obs_search_source"
-	description = ""
+	description = "Searches for an OBS source in a scene and returns its output."
 	category = "obs"
 
 	add_input_port(
diff --git a/classes/deck/nodes/obs_set_source_transform.gd b/classes/deck/nodes/obs_set_source_transform.gd
index b9f6882..f458d2a 100644
--- a/classes/deck/nodes/obs_set_source_transform.gd
+++ b/classes/deck/nodes/obs_set_source_transform.gd
@@ -15,7 +15,7 @@ enum InputPorts{
 func _init() -> void:
 	name = "Set Source Transform"
 	node_type = "obs_set_source_transform"
-	description = ""
+	description = "Sets an OBS source's transform, which includes position and rotation, among other things."
 	category = "obs"
 
 	props_to_serialize = []
diff --git a/classes/deck/nodes/obs_switch_scene.gd b/classes/deck/nodes/obs_switch_scene.gd
index caf0742..61a345a 100644
--- a/classes/deck/nodes/obs_switch_scene.gd
+++ b/classes/deck/nodes/obs_switch_scene.gd
@@ -5,7 +5,7 @@ var noobs: NoOBSWS
 func _init() -> void:
 	name = "Set Scene"
 	node_type = "obs_set_scene"
-	description = ""
+	description = "Sets the current scene in OBS."
 	category = "obs"
 
 	props_to_serialize = []
diff --git a/classes/deck/nodes/obs_vector_to_position.gd b/classes/deck/nodes/obs_vector_to_position.gd
index 2e5a67d..6eb7073 100644
--- a/classes/deck/nodes/obs_vector_to_position.gd
+++ b/classes/deck/nodes/obs_vector_to_position.gd
@@ -4,7 +4,7 @@ extends DeckNode
 func _init() -> void:
 	name = "Vector to OBS Position"
 	node_type = "obs_vector_to_position"
-	description = ""
+	description = "Transforms a Vector into a position vector accepted by OBS transform inputs."
 	category = "obs"
 
 	add_input_port(
diff --git a/classes/deck/nodes/obs_websocket_generic_request.gd b/classes/deck/nodes/obs_websocket_generic_request.gd
index ca06daf..8a7d06d 100644
--- a/classes/deck/nodes/obs_websocket_generic_request.gd
+++ b/classes/deck/nodes/obs_websocket_generic_request.gd
@@ -6,7 +6,7 @@ var noobs: NoOBSWS
 func _init() -> void:
 	name = "OBS WS Generic Request"
 	node_type = "obs_generic_request"
-	description = ""
+	description = "Makes an OBS request and sends its result through. Use if if you really know what you're doing."
 	category = "obs"
 
 	props_to_serialize = []
diff --git a/classes/deck/nodes/print.gd b/classes/deck/nodes/print.gd
index 9f07832..922ac7f 100644
--- a/classes/deck/nodes/print.gd
+++ b/classes/deck/nodes/print.gd
@@ -6,7 +6,7 @@ var times_activated := 0
 func _init() -> void:
 	name = "Print"
 	node_type = name.to_snake_case()
-	description = "print a value"
+	description = "Print a value to the console."
 
 	props_to_serialize = [&"times_activated"]
 	category = "general"
diff --git a/classes/deck/nodes/process_node.gd b/classes/deck/nodes/process_node.gd
index 65dcf7c..2617ffc 100644
--- a/classes/deck/nodes/process_node.gd
+++ b/classes/deck/nodes/process_node.gd
@@ -6,7 +6,7 @@ var delta: float
 func _init() -> void:
 	name = "Process Loop"
 	node_type = name.to_snake_case()
-	description = ""
+	description = "Sends a trigger output every frame, and returns the delta value (time since last frame in seconds)."
 	category = "general"
 
 	add_input_port(
diff --git a/classes/deck/nodes/set_deck_var.gd b/classes/deck/nodes/set_deck_var.gd
index f7a46d6..e685838 100644
--- a/classes/deck/nodes/set_deck_var.gd
+++ b/classes/deck/nodes/set_deck_var.gd
@@ -4,7 +4,7 @@ extends DeckNode
 func _init() -> void:
 	name = "Set Deck Var"
 	node_type = name.to_snake_case()
-	description = "set deck variable"
+	description = "Set a deck variable on trigger."
 	category = "general"
 
 	add_input_port(
diff --git a/classes/deck/nodes/string_constant.gd b/classes/deck/nodes/string_constant.gd
index 1abb9f0..1598455 100644
--- a/classes/deck/nodes/string_constant.gd
+++ b/classes/deck/nodes/string_constant.gd
@@ -5,6 +5,7 @@ func _init() -> void:
 	node_type = "string_constant"
 	name = "String Constant"
 	category = "general"
+	description = "A String field."
 
 	add_output_port(
 		DeckType.Types.STRING,
diff --git a/classes/deck/nodes/twitch_chat_received.gd b/classes/deck/nodes/twitch_chat_received.gd
index aded4f8..18aee3f 100644
--- a/classes/deck/nodes/twitch_chat_received.gd
+++ b/classes/deck/nodes/twitch_chat_received.gd
@@ -9,7 +9,7 @@ var tags := {}
 func _init():
 	name = "Twitch Chat Received"
 	node_type = "twitch_chat_received"
-	description = "Receives Twitch Chat Events from a Twitch Connection"
+	description = "Receives Twitch chat events from a Twitch connection."
 	category = "twitch"
 
 	add_output_port(DeckType.Types.STRING, "Username")
diff --git a/classes/deck/nodes/twitch_send_chat.gd b/classes/deck/nodes/twitch_send_chat.gd
index f18803f..cb6a353 100644
--- a/classes/deck/nodes/twitch_send_chat.gd
+++ b/classes/deck/nodes/twitch_send_chat.gd
@@ -4,7 +4,7 @@ extends DeckNode
 func _init():
 	name = "Twitch Send Chat"
 	node_type = "twitch_send_chat"
-	description = "Sends Twitch chat Messages"
+	description = "Sends a message to a Twitch chat."
 	category = "twitch"
 	
 	add_input_port(
diff --git a/classes/deck/nodes/vector_add.gd b/classes/deck/nodes/vector_add.gd
index 573d7fb..6a57390 100644
--- a/classes/deck/nodes/vector_add.gd
+++ b/classes/deck/nodes/vector_add.gd
@@ -4,7 +4,7 @@ extends DeckNode
 func _init() -> void:
 	name = "Add Vectors"
 	node_type = "vector_add"
-	description = ""
+	description = "Adds two 2D vectors."
 	category = "math"
 
 	add_input_port(
diff --git a/classes/deck/nodes/vector_compose.gd b/classes/deck/nodes/vector_compose.gd
index 466d89f..8701eb8 100644
--- a/classes/deck/nodes/vector_compose.gd
+++ b/classes/deck/nodes/vector_compose.gd
@@ -4,7 +4,7 @@ extends DeckNode
 func _init() -> void:
 	name = "Compose Vector"
 	node_type = "vector_compose"
-	description = ""
+	description = "Returns a vector from two numeric inputs."
 	category = "math"
 
 	add_input_port(
diff --git a/classes/deck/nodes/vector_decompose.gd b/classes/deck/nodes/vector_decompose.gd
index 87f351a..0263880 100644
--- a/classes/deck/nodes/vector_decompose.gd
+++ b/classes/deck/nodes/vector_decompose.gd
@@ -4,7 +4,7 @@ extends DeckNode
 func _init() -> void:
 	name = "Decompose Vector"
 	node_type = "vector_decompose"
-	description = ""
+	description = "Returns the X and Y components of a vector."
 	category = "math"
 
 	add_input_port(
diff --git a/classes/deck/nodes/vector_dot.gd b/classes/deck/nodes/vector_dot.gd
index feaf4f9..b1b7e38 100644
--- a/classes/deck/nodes/vector_dot.gd
+++ b/classes/deck/nodes/vector_dot.gd
@@ -4,7 +4,7 @@ extends DeckNode
 func _init() -> void:
 	name = "Vector Dot Product"
 	node_type = "vector_dot"
-	description = ""
+	description = "Returns the dot product of two vectors."
 	category = "math"
 
 	add_input_port(
diff --git a/classes/deck/nodes/vector_multiply.gd b/classes/deck/nodes/vector_multiply.gd
index 6783eb1..9fb9597 100644
--- a/classes/deck/nodes/vector_multiply.gd
+++ b/classes/deck/nodes/vector_multiply.gd
@@ -4,7 +4,7 @@ extends DeckNode
 func _init() -> void:
 	name = "Multiply Vector by Scalar"
 	node_type = "vector_multiply"
-	description = ""
+	description = "Multiplies a vector by a numeric value."
 	category = "math"
 
 	add_input_port(
diff --git a/classes/deck/nodes/vector_normalize.gd b/classes/deck/nodes/vector_normalize.gd
index 976ef89..c624aaa 100644
--- a/classes/deck/nodes/vector_normalize.gd
+++ b/classes/deck/nodes/vector_normalize.gd
@@ -4,7 +4,7 @@ extends DeckNode
 func _init() -> void:
 	name = "Normalize Vector"
 	node_type = "vector_normalize"
-	description = ""
+	description = "Normalizes a vector so its' length (magnitude) is exactly 1."
 	category = "math"
 
 	add_input_port(
diff --git a/classes/deck/nodes/vector_subtract.gd b/classes/deck/nodes/vector_subtract.gd
index f8f5adc..fe206e6 100644
--- a/classes/deck/nodes/vector_subtract.gd
+++ b/classes/deck/nodes/vector_subtract.gd
@@ -4,7 +4,7 @@ extends DeckNode
 func _init() -> void:
 	name = "Subtract Vectors"
 	node_type = "vector_subtract"
-	description = ""
+	description = "Subtracts each component of the given vectors."
 	category = "math"
 
 	add_input_port(