Unify property getters and setters done through drag and drop

So they use the localized property name.

And also, reuse the setter or getter if it's already in the catalog.

This change is breaking compatibility, because it changes the names of
the getter, setter and changer blocks in order to unify them.

Author: manuq

addons/block_code/code_generation/block_definition.gd

@@ -4,6 +4,12 @@ extends Resource
 const Types = preload("res://addons/block_code/types/types.gd")
 
 const FORMAT_STRING_PATTERN = "\\[(?<out_parameter>[^\\]]+)\\]|\\{const (?<const_parameter>[^}]+)\\}|\\{(?!const )(?<in_parameter>[^}]+)\\}|(?<label>[^\\{\\[]+)"
+const PROPERTY_SETTER_NAME_PATTERN = "(?<class_name>[^\\s]*)_property_set_(?<property_name>[^\\s]+)"
+const PROPERTY_SETTER_NAME_FORMAT = &"%s_property_set_%s"
+const PROPERTY_CHANGER_NAME_PATTERN = "(?<class_name>[^\\s]*)_property_change_(?<property_name>[^\\s]+)"
+const PROPERTY_CHANGER_NAME_FORMAT = &"%s_property_change_%s"
+const PROPERTY_GETTER_NAME_PATTERN = "(?<class_name>[^\\s]*)_property_get_(?<property_name>[^\\s]+)"
+const PROPERTY_GETTER_NAME_FORMAT = &"%s_property_get_%s"
 
 @export var name: StringName
 
@@ -73,6 +79,10 @@ var property_name: String
 
 static var _display_template_regex := RegEx.create_from_string(FORMAT_STRING_PATTERN)
 
+static var property_setter_regex := RegEx.create_from_string(PROPERTY_SETTER_NAME_PATTERN)
+static var property_changer_regex := RegEx.create_from_string(PROPERTY_CHANGER_NAME_PATTERN)
+static var property_getter_regex := RegEx.create_from_string(PROPERTY_GETTER_NAME_PATTERN)
+
 
 func _init(
 	p_name: StringName = &"",
@@ -203,7 +213,7 @@ static func has_category(block_definition, category: String) -> bool:
 static func new_property_setter(_class_name: String, property: Dictionary, category: String, default_value: Variant) -> Resource:
 	var type_string: String = Types.VARIANT_TYPE_TO_STRING[property.type]
 	var block_definition: Resource = new(
-		&"%s_set_%s" % [_class_name, property.name],
+		PROPERTY_SETTER_NAME_FORMAT % [_class_name, property.name],
 		_class_name,
 		"Set the %s property" % property.name,
 		category,
@@ -220,7 +230,7 @@ static func new_property_setter(_class_name: String, property: Dictionary, categ
 static func new_property_changer(_class_name: String, property: Dictionary, category: String, default_value: Variant) -> Resource:
 	var type_string: String = Types.VARIANT_TYPE_TO_STRING[property.type]
 	var block_definition: Resource = new(
-		&"%s_change_%s" % [_class_name, property.name],
+		PROPERTY_CHANGER_NAME_FORMAT % [_class_name, property.name],
 		_class_name,
 		"Change the %s property" % property.name,
 		category,
@@ -236,7 +246,7 @@ static func new_property_changer(_class_name: String, property: Dictionary, cate
 
 static func new_property_getter(_class_name: String, property: Dictionary, category: String) -> Resource:
 	var block_definition: Resource = new(
-		&"%s_get_%s" % [_class_name, property.name],
+		PROPERTY_GETTER_NAME_FORMAT % [_class_name, property.name],
 		_class_name,
 		"The %s property" % property.name,
 		category,

addons/block_code/code_generation/blocks_catalog.gd

@@ -202,7 +202,7 @@ static func _get_custom_parent_class_name(_custom_class_name: String) -> String:
 	return "Node"
 
 
-static func _get_parents(_class_name: String) -> Array[String]:
+static func get_parents(_class_name: String) -> Array[String]:
 	if ClassDB.class_exists(_class_name):
 		return _get_builtin_parents(_class_name)
 	var parents: Array[String] = []
@@ -217,7 +217,7 @@ static func get_inherited_blocks(_class_name: String) -> Array[BlockDefinition]:
 	setup()
 
 	var definitions: Array[BlockDefinition] = []
-	for _parent_class_name in _get_parents(_class_name):
+	for _parent_class_name in get_parents(_class_name):
 		definitions.append_array(_get_blocks_by_class(_parent_class_name))
 	definitions.append_array(_get_blocks_by_class(""))
 	return definitions
@@ -279,16 +279,23 @@ static func get_variable_setter_block_definition(variable: VariableDefinition) -
 	return block_def
 
 
-static func get_property_getter_block_definition(variable: VariableDefinition) -> BlockDefinition:
-	var block_def := get_variable_getter_block_definition(variable)
-	block_def.description = "The %s property" % variable.var_name
-	return block_def
+static func get_property_getter_block_definition(_class_name: String, property: Dictionary) -> BlockDefinition:
+	var name = BlockDefinition.PROPERTY_GETTER_NAME_FORMAT % [_class_name, property.name]
+	if name in _catalog:
+		return _catalog[name]
+	var block_definition := BlockDefinition.new_property_getter(_class_name, property, "Variables")
+	_catalog[block_definition.name] = block_definition
+	return block_definition
 
 
-static func get_property_setter_block_definition(variable: VariableDefinition) -> BlockDefinition:
-	var block_def := get_variable_setter_block_definition(variable)
-	block_def.description = "Set the %s property" % variable.var_name
-	return block_def
+static func get_property_setter_block_definition(_class_name: String, property: Dictionary) -> BlockDefinition:
+	var name = BlockDefinition.PROPERTY_SETTER_NAME_FORMAT % [_class_name, property.name]
+	if name in _catalog:
+		return _catalog[name]
+	var default_value: Variant = _FALLBACK_SET_FOR_TYPE[property.type]
+	var block_definition := BlockDefinition.new_property_setter(_class_name, property, "Variables", default_value)
+	_catalog[block_definition.name] = block_definition
+	return block_definition
 
 
 static func get_resource_block_definition(file_path: String) -> BlockDefinition:

addons/block_code/serialization/block_script_serialization.gd

@@ -149,30 +149,32 @@ func _get_parameter_block_definition(block_name: String, parameter_name: String)
 func _get_obj_property_block_definition(block_name: String) -> BlockDefinition:
 	var block_definition: BlockDefinition
 	var variable: VariableDefinition
+	var _class_name: String
 	var property_name: String
 	var is_getter = true
 
-	if block_name.begins_with("get_var_"):
-		property_name = block_name.get_slice("get_var_", 1)
-	elif block_name.begins_with("set_var_"):
-		property_name = block_name.get_slice("set_var_", 1)
-		is_getter = false
+	var setter_match: RegExMatch = BlockDefinition.property_setter_regex.search(block_name)
+	var getter_match: RegExMatch = BlockDefinition.property_getter_regex.search(block_name)
+	if setter_match:
+		_class_name = setter_match.get_string("class_name")
+		property_name = setter_match.get_string("property_name")
+	elif getter_match:
+		_class_name = getter_match.get_string("class_name")
+		property_name = getter_match.get_string("property_name")
 	else:
 		return null
 
 	# Getter block needs the property's variant type information by visiting the
 	# block_code_node's parent node because the type is not saved as a key of
 	# the resource in the scene file
 	var property_info := _get_parent_node_property_info(property_name)
-	if not property_info.has("type"):
+	if property_info.is_empty():
 		return null
 
 	if is_getter:
-		variable = VariableDefinition.new(property_name, property_info["type"])
-		block_definition = BlocksCatalog.get_property_getter_block_definition(variable)
+		block_definition = BlocksCatalog.get_property_getter_block_definition(_class_name, property_info)
 	else:
-		variable = VariableDefinition.new(property_name, property_info["type"])
-		block_definition = BlocksCatalog.get_property_setter_block_definition(variable)
+		block_definition = BlocksCatalog.get_property_setter_block_definition(_class_name, property_info)
 
 	return block_definition
 

addons/block_code/ui/block_canvas/block_canvas.gd

@@ -133,21 +133,35 @@ func _drop_node(at_position: Vector2, data: Variant) -> void:
 	reconnect_block.emit(block)
 
 
+## Return the parent class name where the property is defined.
+## For example, if the first argument is "Sprite2D" and the second is:
+## - "visible": return "CanvasItem".
+## - "position": return "Node2D".
+## - "flip_h": return "Sprite2D".
+static func _get_classname_for_property(_class_name: StringName, property_name: StringName) -> StringName:
+	var return_classname := &""
+	for parent_class_name in BlocksCatalog.get_parents(_class_name):
+		var property_list := ClassDB.class_get_property_list(parent_class_name, false)
+		var has_property = property_list.any(func(dict): return dict.name == property_name)
+		if has_property:
+			return_classname = parent_class_name
+			continue
+		else:
+			break
+	return return_classname
+
+
 func _drop_obj_property(at_position: Vector2, data: Variant) -> void:
-	var property_name = data["property"]
-	var property_value = data["value"]
-	var is_getter = !_modifier_ctrl
+	var _class_name = _get_classname_for_property(data.object.get_class(), data["property"])
+	var property := {"name": data["property"], "type": typeof(data["value"])}
+	var is_getter = not _modifier_ctrl
 
-	# Prepare a Variable block to set / get the property's value according to
-	# the modifier KEY_CTRL pressing.
-	var variable := VariableDefinition.new(property_name, typeof(property_value))
 	var block_definition: BlockDefinition
 
 	if is_getter:
-		block_definition = BlocksCatalog.get_property_getter_block_definition(variable)
+		block_definition = BlocksCatalog.get_property_getter_block_definition(_class_name, property)
 	else:
-		block_definition = BlocksCatalog.get_property_setter_block_definition(variable)
-		block_definition.defaults = {"value": property_value}
+		block_definition = BlocksCatalog.get_property_setter_block_definition(_class_name, property)
 
 	var block = _context.block_script.instantiate_block(block_definition)
 	add_block(block, at_position)