Add documentation to most scripts and update naming of certain symbols (#326)

* Add documentation to `GaeaData`

* Add documentation to `GaeaGrid`.

* Add documentation to materials

* Change mentions of `Gridmap` to `GridMap`.

* Add documentation to GaeaRenderer and make its methods private

* Add documentation to `TileMapGaeaRenderer`.

* Add documentation to `GridMapRenderer`.

* Add documentation to `GaeaNodeResource`.

* Make `_get_data` private.

* Make cache methods private

* Make input methods private

* Make `_get_arg` private.

* Make logging methods private

* Make more methods private

* Hide some methods from documentation and warn in GaeaData

* Add documentation to `GaeaValue`.

* Add some documentation to `GaeaGraphNode`

* Rename `GaeaGraphNodeParameter` to `GaeaGraphNodeParameterEditor`

* Finish documentation of `GaeaGraphNode`

* Make the connection_idx methods public again

* Update some naming and reconnect disconnected signals

* Add documentation to `GaeaGraphNodeParameterEditor`

* Add documentation to `GaeaGraphNodeOutput`

* Change description of `notify_connections_updated`

* Add documentation to `GaeaGenerator`.

* Add `class_name` to all ParameterEditors

* Change icon of ParameterEditors to hide it more in Godot's add node tree

* Add `class_name` to all graph nodes

* Add script classes

* Change naming of signal-emitting methods in generator

* Add proper spacing to `node_resource.gd`

* Update some comments

* Update naming of idx

* Update gaea_value.gd

* Update node_resource.gd

* Add documentation to `GaeaNode`s (part 1)

* I fucked up (fixed typo)

* Add icon to `GaeaNodeResource`

* Add documentation to `GaeaNode`s (part 2)

* Add virtual version of `get_scene`

* Finish `GaeaNodeResource`s documentation

Author: BenjaTK

addons/gaea/assets/gaea_node_resource.svg

@@ -0,0 +1,38 @@
+[remap]
+
+importer="texture"
+type="CompressedTexture2D"
+uid="uid://d01oerqx1xuok"
+path="res://.godot/imported/gaea_node_resource.svg-22fbdf1f633d28c47aacd2eb3d0636e4.ctex"
+metadata={
+"has_editor_variant": true,
+"vram_texture": false
+}
+
+[deps]
+
+source_file="res://addons/gaea/assets/gaea_node_resource.svg"
+dest_files=["res://.godot/imported/gaea_node_resource.svg-22fbdf1f633d28c47aacd2eb3d0636e4.ctex"]
+
+[params]
+
+compress/mode=0
+compress/high_quality=false
+compress/lossy_quality=0.7
+compress/hdr_compression=1
+compress/normal_map=0
+compress/channel_pack=0
+mipmaps/generate=false
+mipmaps/limit=-1
+roughness/mode=0
+roughness/src_normal=""
+process/fix_alpha_border=true
+process/premult_alpha=false
+process/normal_map_invert_y=false
+process/hdr_as_srgb=false
+process/hdr_clamp_exposure=false
+process/size_limit=0
+detect_3d/compress_to=1
+svg/scale=1.0
+editor/scale_with_editor_scale=true
+editor/convert_colors_with_editor_theme=true

addons/gaea/assets/gaea_node_resource.svg.import

@@ -0,0 +1,38 @@
+[remap]
+
+importer="texture"
+type="CompressedTexture2D"
+uid="uid://dox5e4tnafwet"
+path="res://.godot/imported/parameter_editor.svg-8a5814218dcd6dff896188e64ebe9abb.ctex"
+metadata={
+"has_editor_variant": true,
+"vram_texture": false
+}
+
+[deps]
+
+source_file="res://addons/gaea/assets/parameter_editor.svg"
+dest_files=["res://.godot/imported/parameter_editor.svg-8a5814218dcd6dff896188e64ebe9abb.ctex"]
+
+[params]
+
+compress/mode=0
+compress/high_quality=false
+compress/lossy_quality=0.7
+compress/hdr_compression=1
+compress/normal_map=0
+compress/channel_pack=0
+mipmaps/generate=false
+mipmaps/limit=-1
+roughness/mode=0
+roughness/src_normal=""
+process/fix_alpha_border=true
+process/premult_alpha=false
+process/normal_map_invert_y=false
+process/hdr_as_srgb=false
+process/hdr_clamp_exposure=false
+process/size_limit=0
+detect_3d/compress_to=1
+svg/scale=1.0
+editor/scale_with_editor_scale=true
+editor/convert_colors_with_editor_theme=true

addons/gaea/assets/parameter_editor.svg

@@ -2,8 +2,8 @@
 extends GraphEdit
 
 
-signal request_connection_update
-signal request_save
+signal connection_update_requested
+signal save_requested
 
 var attached_elements: Dictionary
 
@@ -30,15 +30,15 @@ func delete_nodes(nodes: Array[StringName]) -> void:
 				continue
 			for connection in node.connections:
 				disconnect_node(connection.from_node, connection.from_port, connection.to_node, connection.to_port)
-			node.on_removed()
+			node.removed.emit()
 		elif node is GraphFrame:
 			for attached in get_attached_nodes_of_frame(node.name):
 				attached_elements.erase(attached)
 		node.queue_free()
 		await node.tree_exited
 
-	request_connection_update.emit()
-	request_save.emit()
+	connection_update_requested.emit()
+	save_requested.emit()
 
 
 func _on_connection_request(from_node: StringName, from_port: int, to_node: StringName, to_port: int) -> void:
@@ -67,21 +67,21 @@ func _on_connection_request(from_node: StringName, from_port: int, to_node: Stri
 				)
 
 	connect_node(from_node, from_port, to_node, to_port)
-	request_connection_update.emit()
+	connection_update_requested.emit()
 
 	get_node(NodePath(from_node)).notify_connections_updated.call_deferred()
 	target_node.notify_connections_updated.call_deferred()
 
-	request_save.emit()
+	save_requested.emit()
 
 func _on_disconnection_request(from_node: StringName, from_port: int, to_node: StringName, to_port: int) -> void:
 	disconnect_node(from_node, from_port, to_node, to_port)
-	request_connection_update.emit()
+	connection_update_requested.emit()
 
 	get_node(NodePath(from_node)).notify_connections_updated.call_deferred()
 	get_node(NodePath(to_node)).notify_connections_updated.call_deferred()
 
-	request_save.emit()
+	save_requested.emit()
 
 func remove_invalid_connections() -> void:
 	for connection in get_connection_list():
@@ -100,7 +100,7 @@ func remove_invalid_connections() -> void:
 			disconnect_node(connection.from_node, connection.from_port, connection.to_node, connection.to_port)
 			continue
 
-	request_save.emit()
+	save_requested.emit()
 
 func is_nodes_connected_relatively(from_node: StringName, to_node: StringName) -> bool:
 	var nodes_to_check: Array[StringName] = [from_node]
@@ -132,12 +132,12 @@ func _on_graph_elements_linked_to_frame_request(elements: Array, frame: StringNa
 	for element in elements:
 		attach_graph_element_to_frame(element, frame)
 		_on_element_attached_to_frame(element, frame)
-	request_save.emit.call_deferred()
+	save_requested.emit.call_deferred()
 
 
 func _on_element_attached_to_frame(element: StringName, frame: StringName) -> void:
 	attached_elements.set(element, frame)
-	request_save.emit()
+	save_requested.emit()
 
 
 func _is_node_hover_valid(from_node: StringName, _from_port: int, to_node: StringName, _to_port: int) -> bool:

addons/gaea/assets/parameter_editor.svg.import

@@ -48,7 +48,7 @@ func populate(selected: Array) -> void:
 	if selected.front() is GaeaGraphNode and selected.size() == 1:
 		var node: GaeaGraphNode = selected.front()
 		var resource: GaeaNodeResource = node.resource
-		if resource is GaeaVariableNodeResource:
+		if resource is GaeaNodeVariable:
 			var data: GaeaData = panel.get_selected_generator().data
 			var parameter: Dictionary = data.parameters.get(node.get_arg_value("name"), {})
 			if parameter.get("value") is Resource:
@@ -125,7 +125,7 @@ func _on_id_pressed(id: int) -> void:
 		Action.OPEN_IN_INSPECTOR:
 			var node: GaeaGraphNode = graph_edit.get_selected().front()
 			var resource: GaeaNodeResource = node.resource
-			if resource is GaeaVariableNodeResource:
+			if resource is GaeaNodeVariable:
 				var data: GaeaData = panel.get_selected_generator().data
 				var parameter: Dictionary = data.parameters.get(node.get_arg_value("name"), {})
 				var value: Variant = parameter.get("value")

addons/gaea/editor/graph_edit.gd

@@ -319,11 +319,10 @@ func _add_node_from_resource(resource: GaeaNodeResource, p_is_loading: bool = fa
 	node.resource = resource
 	node.generator = get_selected_generator()
 	_graph_edit.add_child(node)
-	node.on_added()
 	node.save_requested.connect(_save_data)
 	node.name = node.name.replace("@", "_")
 	if not p_is_loading:
-		node.finished_loading = true
+		node.set_finished_loading(true)
 	return node
 
 
@@ -458,7 +457,7 @@ func _on_reload_parameters_list_button_pressed() -> void:
 		if node is not GaeaGraphNode:
 			continue
 
-		if node.resource is GaeaVariableNodeResource:
+		if node.resource is GaeaNodeVariable:
 			existing_parameters.append(node.get_arg_value("name"))
 
 

addons/gaea/editor/node_popup.gd

@@ -393,14 +393,14 @@ exclusive = true
 [connection signal="pressed" from="Editor/VBoxContainer/HBoxContainer/WindowPopoutButton" to="." method="_on_window_popout_button_pressed"]
 [connection signal="connection_request" from="Editor/VBoxContainer/GraphEdit" to="Editor/VBoxContainer/GraphEdit" method="_on_connection_request"]
 [connection signal="connection_to_empty" from="Editor/VBoxContainer/GraphEdit" to="." method="_on_graph_edit_connection_to_empty"]
+[connection signal="connection_update_requested" from="Editor/VBoxContainer/GraphEdit" to="." method="update_connections"]
 [connection signal="delete_nodes_request" from="Editor/VBoxContainer/GraphEdit" to="Editor/VBoxContainer/GraphEdit" method="_on_delete_nodes_request"]
 [connection signal="disconnection_request" from="Editor/VBoxContainer/GraphEdit" to="Editor/VBoxContainer/GraphEdit" method="_on_disconnection_request"]
 [connection signal="end_node_move" from="Editor/VBoxContainer/GraphEdit" to="." method="_save_data"]
 [connection signal="graph_elements_linked_to_frame_request" from="Editor/VBoxContainer/GraphEdit" to="Editor/VBoxContainer/GraphEdit" method="_on_graph_elements_linked_to_frame_request"]
 [connection signal="gui_input" from="Editor/VBoxContainer/GraphEdit" to="." method="_on_graph_edit_gui_input"]
 [connection signal="node_selected" from="Editor/VBoxContainer/GraphEdit" to="Editor/VBoxContainer/GraphEdit" method="_on_node_selected"]
-[connection signal="request_connection_update" from="Editor/VBoxContainer/GraphEdit" to="." method="update_connections"]
-[connection signal="request_save" from="Editor/VBoxContainer/GraphEdit" to="." method="_save_data"]
+[connection signal="save_requested" from="Editor/VBoxContainer/GraphEdit" to="." method="_save_data"]
 [connection signal="scroll_offset_changed" from="Editor/VBoxContainer/GraphEdit" to="." method="_on_graph_edit_scroll_offset_changed"]
 [connection signal="text_changed" from="Editor/CreateNodePopup/MainContentContainer/VBox/SearchContainer/SearchBar" to="Editor/CreateNodePopup/MainContentContainer/VBox/CreateNodeTree" method="_on_search_bar_text_changed"]
 [connection signal="text_submitted" from="Editor/CreateNodePopup/MainContentContainer/VBox/SearchContainer/SearchBar" to="Editor/CreateNodePopup/MainContentContainer/VBox/CreateNodeTree" method="_on_search_bar_text_submitted"]

addons/gaea/editor/panel.gd

@@ -1,22 +1,25 @@
 @tool
 class_name GaeaGraphNodeOutput
 extends MarginContainer
+## An output slot inside a [GaeaGraphNode].
 
 
+## The resource holding the information for this slot such as [member GaeaNodeSlotOutput.name].
 var resource: GaeaNodeSlotOutput
 ## Reference to the [GaeaGraphNode] instance
 var graph_node: GaeaGraphNode
-## ID of the slot in the [GaeaGraphNode].
+## Index of the slot in the [GaeaGraphNode].
 var idx: int
 
 
 @onready var _label: RichTextLabel = %RightLabel
-@onready var toggle_preview_button: TextureButton = %TogglePreviewButton
+@onready var _toggle_preview_button: TextureButton = %TogglePreviewButton : get = get_toggle_preview_button
 
 
-func initialize(_graph_node: GaeaGraphNode, _idx: int) -> void:
-	graph_node = _graph_node
-	idx = _idx
+## Sets the corresponding variables.
+func initialize(for_graph_node: GaeaGraphNode, for_idx: int) -> void:
+	graph_node = for_graph_node
+	idx = for_idx
 
 
 func _ready() -> void:
@@ -27,11 +30,16 @@ func _ready() -> void:
 		await graph_node.ready
 
 	_label.text = resource.name.capitalize()
-	toggle_preview_button.texture_normal = get_theme_icon(&"GuiVisibilityHidden", &"EditorIcons")
-	toggle_preview_button.texture_pressed = get_theme_icon(&"GuiVisibilityVisible", &"EditorIcons")
-	toggle_preview_button.toggle_mode = true
-	
+	_toggle_preview_button.texture_normal = get_theme_icon(&"GuiVisibilityHidden", &"EditorIcons")
+	_toggle_preview_button.texture_pressed = get_theme_icon(&"GuiVisibilityVisible", &"EditorIcons")
+	_toggle_preview_button.toggle_mode = true
+
 	graph_node.set_slot_enabled_right(idx, true)
 	graph_node.set_slot_type_right(idx, resource.type)
 	graph_node.set_slot_color_right(idx, GaeaValue.get_color(resource.type))
 	graph_node.set_slot_custom_icon_right(idx, GaeaValue.get_slot_icon(resource.type))
+
+
+## Returns the button used to toggle the preview for this output slot.
+func get_toggle_preview_button() -> TextureButton:
+	return _toggle_preview_button

addons/gaea/editor/panel.tscn

@@ -4,7 +4,6 @@
 
 [node name="BaseParameter" type="HBoxContainer"]
 script = ExtResource("1_rylg1")
-add_input_slot = false
 
 [node name="Label" type="Label" parent="."]
 layout_mode = 2