Rename BlockScriptData to BlockScriptSerialization

And move it to the serialization/ folder

Also: remove abandoned function scene_has_bsd_nodes() from block canvas.

Author: manuq

addons/block_code/block_code_node/block_code.gd

@@ -3,7 +3,7 @@
 class_name BlockCode
 extends Node
 
-@export var block_script: BlockScriptData = null
+@export var block_script: BlockScriptSerialization = null
 
 
 func _ready():
@@ -25,10 +25,10 @@ func _enter_tree():
 
 	# Create script
 	if block_script == null:
-		var new_bsd: BlockScriptData = load("res://addons/block_code/ui/bsd_templates/default_bsd.tres").duplicate(true)
-		new_bsd.script_inherits = _get_custom_or_native_class(get_parent())
-		new_bsd.generated_script = new_bsd.generated_script.replace("INHERIT_DEFAULT", new_bsd.script_inherits)
-		block_script = new_bsd
+		var new_block_script: BlockScriptSerialization = load("res://addons/block_code/ui/bsd_templates/default_bsd.tres").duplicate(true)
+		new_block_script.script_inherits = _get_custom_or_native_class(get_parent())
+		new_block_script.generated_script = new_block_script.generated_script.replace("INHERIT_DEFAULT", new_block_script.script_inherits)
+		block_script = new_block_script
 
 
 func _update_parent_script():

addons/block_code/block_code_plugin.gd

@@ -18,14 +18,14 @@ var _selected_block_code: BlockCode
 var old_feature_profile: String = ""
 
 const DISABLED_CLASSES := [
-	"BlockScriptData",
 	"Block",
 	"ControlBlock",
 	"ParameterBlock",
 	"StatementBlock",
 	"SnapPoint",
 	"BlockSerialization",
 	"BlockSerializedProperties",
+	"BlockScriptSerialization",
 	"CategoryFactory",
 ]
 

addons/block_code/examples/pong_game/pong_game.tscn

@@ -7,7 +7,7 @@
 [ext_resource type="Texture2D" uid="uid://tplpgtnfeda0" path="res://addons/block_code/examples/pong_game/assets/paddle.png" id="4_ra7bh"]
 [ext_resource type="Script" path="res://addons/block_code/serialization/block_serialized_properties.gd" id="5_wr38c"]
 [ext_resource type="Script" path="res://addons/block_code/ui/block_canvas/option_data.gd" id="7_3q6bj"]
-[ext_resource type="Script" path="res://addons/block_code/block_script_data/block_script_data.gd" id="7_uuuue"]
+[ext_resource type="Script" path="res://addons/block_code/serialization/block_script_serialization.gd" id="7_uuuue"]
 [ext_resource type="PackedScene" uid="uid://c7l70grmkauij" path="res://addons/block_code/examples/pong_game/ball.tscn" id="9_xrqll"]
 [ext_resource type="PackedScene" uid="uid://fhoapg3anjsu" path="res://addons/block_code/examples/pong_game/goal_area.tscn" id="12_nqmxu"]
 [ext_resource type="Script" path="res://addons/block_code/simple_nodes/simple_scoring/simple_scoring.gd" id="13_tg3yk"]

addons/block_code/block_script_data/block_script_data.gd renamed to addons/block_code/serialization/block_script_serialization.gd

@@ -1,4 +1,4 @@
-class_name BlockScriptData
+class_name BlockScriptSerialization
 extends Resource
 
 @export var script_inherits: String

addons/block_code/ui/block_canvas/block_canvas.gd

@@ -33,7 +33,7 @@ const ZOOM_FACTOR: float = 1.1
 @onready var _mouse_override: Control = %MouseOverride
 @onready var _zoom_label: Label = %ZoomLabel
 
-var _current_bsd: BlockScriptData
+var _current_block_script: BlockScriptSerialization
 var _block_scenes_by_class = {}
 var _panning := false
 var zoom: float:
@@ -96,12 +96,12 @@ func set_child(n: Node):
 		set_child(c)
 
 
-func bsd_selected(bsd: BlockScriptData):
+func block_script_selected(block_script: BlockScriptSerialization):
 	clear_canvas()
 
 	var edited_node = EditorInterface.get_inspector().get_edited_object() as Node
 
-	if bsd != _current_bsd:
+	if block_script != _current_block_script:
 		_window.position = Vector2(0, 0)
 		zoom = 1
 
@@ -115,18 +115,18 @@ func bsd_selected(bsd: BlockScriptData):
 	_open_scene_button.disabled = true
 	_replace_block_code_button.disabled = true
 
-	if bsd != null:
-		_load_bsd(bsd)
+	if block_script != null:
+		_load_block_script(block_script)
 		_window.visible = true
 		_zoom_label.visible = true
 
-		if bsd != _current_bsd:
+		if block_script != _current_block_script:
 			reset_window_position()
 	elif edited_node == null:
 		_empty_box.visible = true
 	elif BlockCodePlugin.node_has_block_code(edited_node):
 		# If the selected node has a block code node, but BlockCodePlugin didn't
-		# provide it to bsd_selected, we assume the block code itself is not
+		# provide it to block_script_selected, we assume the block code itself is not
 		# editable. In that case, provide options to either edit the node's
 		# scene file, or override the BlockCode node. This is mostly to avoid
 		# creating a situation where a node has multiple BlockCode nodes.
@@ -139,21 +139,14 @@ func bsd_selected(bsd: BlockScriptData):
 		_selected_node_label.text = _selected_node_label_format.format({"node": edited_node.name})
 		_add_block_code_button.disabled = false
 
-	_current_bsd = bsd
+	_current_block_script = block_script
 
 
-func _load_bsd(bsd: BlockScriptData):
-	for tree in bsd.block_trees:
+func _load_block_script(block_script: BlockScriptSerialization):
+	for tree in block_script.block_trees:
 		load_tree(_window, tree)
 
 
-func scene_has_bsd_nodes() -> bool:
-	var scene_root = EditorInterface.get_edited_scene_root()
-	if not scene_root:
-		return false
-	return scene_root.find_children("*", "BlockCode").size() > 0
-
-
 func clear_canvas():
 	for child in _window.get_children():
 		_window.remove_child(child)
@@ -185,8 +178,8 @@ func rebuild_block_trees(undo_redo):
 	var block_trees: Array[BlockSerialization]
 	for c in _window.get_children():
 		block_trees.append(build_tree(c, undo_redo))
-	undo_redo.add_undo_property(_current_bsd, "block_trees", _current_bsd.block_trees)
-	undo_redo.add_do_property(_current_bsd, "block_trees", block_trees)
+	undo_redo.add_undo_property(_current_block_script, "block_trees", _current_block_script.block_trees)
+	undo_redo.add_do_property(_current_block_script, "block_trees", block_trees)
 
 
 func build_tree(block: Block, undo_redo: EditorUndoRedoManager) -> BlockSerialization:
@@ -326,6 +319,6 @@ func set_mouse_override(override: bool):
 		_mouse_override.mouse_default_cursor_shape = Control.CURSOR_ARROW
 
 
-func generate_script_from_current_window(bsd: BlockScriptData) -> String:
+func generate_script_from_current_window(block_script: BlockScriptSerialization) -> String:
 	# TODO: implement multiple windows
-	return BlockTreeUtil.generate_script_from_nodes(_window.get_children(), bsd)
+	return BlockTreeUtil.generate_script_from_nodes(_window.get_children(), block_script)

addons/block_code/ui/block_tree_util.gd

@@ -3,7 +3,7 @@ extends Object
 const InstructionTree = preload("res://addons/block_code/instruction_tree/instruction_tree.gd")
 
 
-static func generate_script_from_nodes(nodes: Array[Node], bsd: BlockScriptData) -> String:
+static func generate_script_from_nodes(nodes: Array[Node], block_script: BlockScriptSerialization) -> String:
 	var entry_blocks_by_entry_statement: Dictionary = {}
 
 	for block in nodes:
@@ -18,9 +18,9 @@ static func generate_script_from_nodes(nodes: Array[Node], bsd: BlockScriptData)
 
 	var script: String = ""
 
-	script += "extends %s\n\n" % bsd.script_inherits
+	script += "extends %s\n\n" % block_script.script_inherits
 
-	for variable in bsd.variables:
+	for variable in block_script.variables:
 		script += "var %s: %s\n\n" % [variable.var_name, type_string(variable.var_type)]
 
 	script += "\n"

addons/block_code/ui/bsd_templates/default_bsd.tres

@@ -1,8 +1,8 @@
-[gd_resource type="Resource" script_class="BlockScriptData" load_steps=6 format=3 uid="uid://dit7fykhl3h48"]
+[gd_resource type="Resource" script_class="BlockScriptSerialization" load_steps=6 format=3 uid="uid://dit7fykhl3h48"]
 
 [ext_resource type="Script" path="res://addons/block_code/serialization/block_serialization.gd" id="1_barc5"]
 [ext_resource type="Script" path="res://addons/block_code/serialization/block_serialized_properties.gd" id="2_cgfpx"]
-[ext_resource type="Script" path="res://addons/block_code/block_script_data/block_script_data.gd" id="4_cqq7x"]
+[ext_resource type="Script" path="res://addons/block_code/serialization/block_script_serialization.gd" id="4_cqq7x"]
 
 [sub_resource type="Resource" id="Resource_b0aen"]
 script = ExtResource("2_cgfpx")

addons/block_code/ui/main_panel.gd

@@ -52,10 +52,10 @@ func _on_undo_redo_version_changed():
 	if _current_block_code_node == null:
 		return
 
-	var block_script: BlockScriptData = _current_block_code_node.block_script
-	_picker.bsd_selected(block_script)
-	_title_bar.bsd_selected(block_script)
-	_block_canvas.bsd_selected(block_script)
+	var block_script: BlockScriptSerialization = _current_block_code_node.block_script
+	_picker.block_script_selected(block_script)
+	_title_bar.block_script_selected(block_script)
+	_block_canvas.block_script_selected(block_script)
 
 
 func _on_print_script_button_pressed():
@@ -107,14 +107,14 @@ func switch_scene(scene_root: Node):
 
 
 func switch_block_code_node(block_code_node: BlockCode):
-	var block_script: BlockScriptData = block_code_node.block_script if block_code_node else null
+	var block_script: BlockScriptSerialization = block_code_node.block_script if block_code_node else null
 	_current_block_code_node = block_code_node
 	_delete_node_button.disabled = _current_block_code_node == null
 	if _current_block_code_node != null:
 		_try_migration()
-	_picker.bsd_selected(block_script)
-	_title_bar.bsd_selected(block_script)
-	_block_canvas.bsd_selected(block_script)
+	_picker.block_script_selected(block_script)
+	_title_bar.block_script_selected(block_script)
+	_block_canvas.block_script_selected(block_script)
 
 
 func save_script():
@@ -128,7 +128,7 @@ func save_script():
 		print("Block code for {node} is not editable.".format({"node": _current_block_code_node}))
 		return
 
-	var block_script: BlockScriptData = _current_block_code_node.block_script
+	var block_script: BlockScriptSerialization = _current_block_code_node.block_script
 
 	var resource_path_split = block_script.resource_path.split("::", true, 1)
 	var resource_scene = resource_path_split[0]
@@ -175,7 +175,7 @@ func _input(event):
 func _print_generated_script():
 	if _current_block_code_node == null:
 		return
-	var block_script: BlockScriptData = _current_block_code_node.block_script
+	var block_script: BlockScriptSerialization = _current_block_code_node.block_script
 	var script: String = _block_canvas.generate_script_from_current_window(block_script)
 	print(script)
 	print("Debug script! (not saved)")
@@ -261,7 +261,7 @@ func _create_variable(variable: VariableResource):
 		print("No script loaded to add variable to.")
 		return
 
-	var block_script: BlockScriptData = _current_block_code_node.block_script
+	var block_script: BlockScriptSerialization = _current_block_code_node.block_script
 
 	undo_redo.create_action("Create variable %s in %s's block code script" % [variable.var_name, _current_block_code_node.get_parent().name])
 	undo_redo.add_undo_property(_current_block_code_node.block_script, "variables", _current_block_code_node.block_script.variables)

addons/block_code/ui/picker/categories/variable_category/create_variable_dialog.gd

@@ -58,9 +58,9 @@ func check_errors(new_var_name: String) -> bool:
 	var duplicate_variable_name := false
 	var current_block_code = BlockCodePlugin.main_panel._current_block_code_node
 	if current_block_code:
-		var current_bsd = current_block_code.block_script
-		if current_bsd:
-			for variable in current_bsd.variables:
+		var current_block_script = current_block_code.block_script
+		if current_block_script:
+			for variable in current_block_script.variables:
 				if variable.var_name == new_var_name:
 					duplicate_variable_name = true
 					break

addons/block_code/ui/picker/picker.gd

@@ -20,18 +20,18 @@ var scroll_tween: Tween
 var _variable_category_display: VariableCategoryDisplay = null
 
 
-func bsd_selected(bsd: BlockScriptData):
-	if not bsd:
+func block_script_selected(block_script: BlockScriptSerialization):
+	if not block_script:
 		reset_picker()
 		return
 
 	var blocks_to_add: Array[Block] = []
 	var categories_to_add: Array[BlockCategory] = []
 
 	# By default, assume the class is built-in.
-	var parent_class: String = bsd.script_inherits
+	var parent_class: String = block_script.script_inherits
 	for class_dict in ProjectSettings.get_global_class_list():
-		if class_dict.class == bsd.script_inherits:
+		if class_dict.class == block_script.script_inherits:
 			var script = load(class_dict.path)
 			if script.has_method("get_custom_categories"):
 				categories_to_add = script.get_custom_categories()
@@ -43,7 +43,7 @@ func bsd_selected(bsd: BlockScriptData):
 	blocks_to_add.append_array(CategoryFactory.get_inherited_blocks(parent_class))
 
 	init_picker(blocks_to_add, categories_to_add)
-	reload_variables(bsd.variables)
+	reload_variables(block_script.variables)
 
 
 func reset_picker():