Merge pull request #192 from endlessm/T35591-read-blocks-from-files

T35591 Read block definition from resource files

Author: manuq

addons/block_code/blocks/lifecycle/physics_process.tres

@@ -5,11 +5,12 @@
 [resource]
 script = ExtResource("1_s0hq0")
 name = &"physics_process"
+description = "Attached blocks will be executed during the \"physics\" processing step of the main loop"
+category = "Lifecycle"
 type = 1
 variant_type = 0
 display_template = "On Physics Process"
 code_template = "func _physics_process(delta):"
-description = "The following will be executed during the \"physics\" processing step of the main loop"
-category = "Lifecycle"
 defaults = {}
 signal_name = ""
+scope = ""

addons/block_code/blocks/lifecycle/process.tres

@@ -5,11 +5,12 @@
 [resource]
 script = ExtResource("1_pmina")
 name = &"process"
+description = "Attached blocks will be executed during the processing step of the main loop"
+category = "Lifecycle"
 type = 1
 variant_type = 0
 display_template = "On Process"
 code_template = "func _process(delta):"
-description = "The following will be executed during the processing step of the main loop"
-category = "Lifecycle"
 defaults = {}
 signal_name = ""
+scope = ""

addons/block_code/blocks/lifecycle/ready.tres

@@ -5,11 +5,12 @@
 [resource]
 script = ExtResource("1_vk0xk")
 name = &"ready"
+description = "Attached blocks will be executed once when the node is \"ready\""
+category = "Lifecycle"
 type = 1
 variant_type = 0
 display_template = "On Ready"
 code_template = "func _ready():"
-description = "The following will be executed when the node is \"ready\""
-category = "Lifecycle"
 defaults = {}
 signal_name = ""
+scope = ""

addons/block_code/blocks/log/print.tres

@@ -11,6 +11,8 @@ type = 2
 variant_type = 0
 display_template = "Print {text: STRING}"
 code_template = "print({text})"
-defaults = {}
+defaults = {
+"text": "Hello"
+}
 signal_name = ""
 scope = ""

addons/block_code/blocks/loops/for.tres

@@ -5,11 +5,12 @@
 [resource]
 script = ExtResource("1_u01bi")
 name = &"for"
+description = "Run the connected blocks [i]number[/i] times"
+category = "Loops"
 type = 4
 variant_type = 0
-display_template = "Repeat {n: INT}"
-code_template = "for __i in {n}:"
-description = "Run the connected blocks [i]n[/i] times"
-category = "Loops"
+display_template = "Repeat {number: INT}"
+code_template = "for __i in {number}:"
 defaults = {}
 signal_name = ""
+scope = ""

addons/block_code/blocks/loops/while.tres

@@ -5,11 +5,14 @@
 [resource]
 script = ExtResource("1_fxxh0")
 name = &"while"
+description = "Run the connected blocks as long as [i]condition[/i] is true.
+
+Hint: snap a [b]Comparison[/b] block into the condition."
+category = "Loops"
 type = 4
 variant_type = 0
 display_template = "While {condition: BOOL}"
 code_template = "while {condition}:"
-description = "Run the connected blocks as long as [i]condition[/i] is true.\\nHint: snap a [b]Comparison[/b] block into the condition."
-category = "Loops"
 defaults = {}
 signal_name = ""
+scope = ""

addons/block_code/code_generation/block_definition.gd

@@ -5,14 +5,14 @@ extends Resource
 const Types = preload("res://addons/block_code/types/types.gd")
 
 @export var name: StringName
-@export var description: String
+@export_multiline var description: String
 @export var category: String
 
 @export var type: Types.BlockType
 @export var variant_type: Variant.Type
 
 @export var display_template: String
-@export var code_template: String
+@export_multiline var code_template: String
 @export var defaults: Dictionary
 
 ## Only for blocks of type Types.ENTRY. If non-empty, this block defines a

addons/block_code/code_generation/blocks_catalog.gd

@@ -2,6 +2,9 @@ extends Object
 
 const BlockDefinition = preload("res://addons/block_code/code_generation/block_definition.gd")
 const Types = preload("res://addons/block_code/types/types.gd")
+const Util = preload("res://addons/block_code/code_generation/util.gd")
+
+const _BLOCKS_PATH = "res://addons/block_code/blocks/"
 
 static var _catalog: Dictionary
 
@@ -11,24 +14,11 @@ static func setup():
 		return
 
 	_catalog = {}
-	var block_definition: BlockDefinition = BlockDefinition.new()
-	block_definition.name = &"ready_block"
-	block_definition.type = Types.BlockType.ENTRY
-	block_definition.display_template = "On Ready"
-	block_definition.code_template = "func _ready():"
-	block_definition.description = 'Attached blocks will be executed once when the node is "ready"'
-	block_definition.category = "Lifecycle"
-	_catalog[&"ready_block"] = block_definition
-
-	block_definition = BlockDefinition.new()
-	block_definition.name = &"print"
-	block_definition.type = Types.BlockType.STATEMENT
-	block_definition.display_template = "print {text: STRING}"
-	block_definition.code_template = "print({text})"
-	block_definition.defaults = {"text": "Hello"}
-	block_definition.description = "Print the text to output"
-	block_definition.category = "Log"
-	_catalog[&"print"] = block_definition
+
+	var definition_files = Util.get_files_in_dir_recursive(_BLOCKS_PATH, "*.tres")
+	for file in definition_files:
+		var block_definition = load(file)
+		_catalog[block_definition.name] = block_definition
 
 
 static func get_block(block_name: StringName):

addons/block_code/code_generation/util.gd

@@ -0,0 +1,24 @@
+extends Object
+
+
+static func get_files_in_dir_recursive(path: String, pattern: String) -> Array:
+	var files = []
+	var dir := DirAccess.open(path)
+
+	if not dir:
+		return files
+
+	dir.list_dir_begin()
+
+	var file_name = dir.get_next()
+
+	while file_name != "":
+		var file_path = path + "/" + file_name
+		if dir.current_is_dir():
+			files.append_array(get_files_in_dir_recursive(file_path, pattern))
+		elif file_name.matchn(pattern):
+			files.append(file_path)
+
+		file_name = dir.get_next()
+
+	return files

addons/block_code/examples/pong_game/pong_game.tscn

@@ -35,7 +35,7 @@ serialized_props = [["color", Color(0.92549, 0.231373, 0.34902, 1)], ["scope", "
 
 [sub_resource type="Resource" id="Resource_yiq7s"]
 script = ExtResource("4_qtggh")
-name = &"ready_block"
+name = &"ready"
 position = Vector2(75, 175)
 path_child_pairs = [[NodePath("VBoxContainer/SnapPoint"), SubResource("Resource_q65fe")]]
 block_serialized_properties = SubResource("Resource_q1vhx")
@@ -130,7 +130,7 @@ serialized_props = [["color", Color(0.92549, 0.231373, 0.34902, 1)], ["scope", "
 
 [sub_resource type="Resource" id="Resource_hrubs"]
 script = ExtResource("4_qtggh")
-name = &"ready_block"
+name = &"ready"
 position = Vector2(50, 175)
 path_child_pairs = [[NodePath("VBoxContainer/SnapPoint"), SubResource("Resource_ttkrd")]]
 block_serialized_properties = SubResource("Resource_06s7w")
@@ -269,7 +269,7 @@ serialized_props = [["color", Color(0.92549, 0.231373, 0.34902, 1)], ["scope", "
 
 [sub_resource type="Resource" id="Resource_1h6wi"]
 script = ExtResource("4_qtggh")
-name = &"ready_block"
+name = &"ready"
 position = Vector2(54, 47)
 path_child_pairs = [[NodePath("VBoxContainer/SnapPoint"), SubResource("Resource_gywyt")]]
 block_serialized_properties = SubResource("Resource_b0aen")
@@ -862,7 +862,7 @@ serialized_props = [["color", Color(0.92549, 0.231373, 0.34902, 1)], ["scope", "
 
 [sub_resource type="Resource" id="Resource_njwj4"]
 script = ExtResource("4_qtggh")
-name = &"ready_block"
+name = &"ready"
 position = Vector2(54, 47)
 path_child_pairs = [[NodePath("VBoxContainer/SnapPoint"), SubResource("Resource_8xxm3")]]
 block_serialized_properties = SubResource("Resource_g3mty")