Localized properties

addons/block_code/code_generation/block_definition.gd

@@ -2,8 +2,17 @@
 extends Resource
 
 const Types = preload("res://addons/block_code/types/types.gd")
+const VariableDefinition = preload("res://addons/block_code/code_generation/variable_definition.gd")
 
 const FORMAT_STRING_PATTERN = "\\[(?<out_parameter>[^\\]]+)\\]|\\{const (?<const_parameter>[^}]+)\\}|\\{(?!const )(?<in_parameter>[^}]+)\\}|(?<label>[^\\{\\[]+)"
+const PROPERTY_SETTER_NAME_PATTERN = "(?<class_name>[^\\s]*)_set_(?<property_name>[^\\s]+)"
+const PROPERTY_SETTER_NAME_FORMAT = &"%s_set_%s"
+const PROPERTY_CHANGER_NAME_PATTERN = "(?<class_name>[^\\s]*)_change_(?<property_name>[^\\s]+)"
+const PROPERTY_CHANGER_NAME_FORMAT = &"%s_change_%s"
+const PROPERTY_GETTER_NAME_PATTERN = "(?<class_name>[^\\s]*)_get_(?<property_name>[^\\s]+)"
+const PROPERTY_GETTER_NAME_FORMAT = &"%s_get_%s"
+const VARIABLE_SETTER_NAME_FORMAT = &"set_var_%s"
+const VARIABLE_GETTER_NAME_FORMAT = &"get_var_%s"
 
 @export var name: StringName
 
@@ -32,6 +41,9 @@ const FORMAT_STRING_PATTERN = "\\[(?<out_parameter>[^\\]]+)\\]|\\{const (?<const
 ## [codeblock]
 ## say {salute: STRING} | {fancy: BOOL}
 ## [/codeblock]
+## If [member property_name] is set, this template is assumed to be a format
+## string with a `%s` placeholder; in this case, any literal `%` signs must
+## be escaped as `%%`.
 @export var display_template: String
 
 ## Template for the generated GDScript code. This must be valid GDScript. The
@@ -67,8 +79,16 @@ const FORMAT_STRING_PATTERN = "\\[(?<out_parameter>[^\\]]+)\\]|\\{const (?<const
 ## Empty except for blocks that have a defined scope.
 var scope: String
 
+## Optional property name, for localizing it. Only relevant for property setters, changers and
+## getters.
+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 = &"",
@@ -194,3 +214,81 @@ static func _parse_parameter_format(parameter_format: String) -> Dictionary:
 
 static func has_category(block_definition, category: String) -> bool:
 	return block_definition.category == category
+
+
+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(
+		PROPERTY_SETTER_NAME_FORMAT % [_class_name, property.name],
+		_class_name,
+		Engine.tr("Set the %s property") % property.name,
+		category,
+		Types.BlockType.STATEMENT,
+		TYPE_NIL,
+		Engine.tr("set %%s to {value: %s}") % type_string,
+		"%s = {value}" % property.name,
+		{"value": default_value},
+	)
+	block_definition.property_name = property.name
+	return block_definition
+
+
+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(
+		PROPERTY_CHANGER_NAME_FORMAT % [_class_name, property.name],
+		_class_name,
+		Engine.tr("Change the %s property") % property.name,
+		category,
+		Types.BlockType.STATEMENT,
+		TYPE_NIL,
+		Engine.tr("change %%s by {value: %s}") % type_string,
+		"%s += {value}" % property.name,
+		{"value": default_value},
+	)
+	block_definition.property_name = property.name
+	return block_definition
+
+
+static func new_property_getter(_class_name: String, property: Dictionary, category: String) -> Resource:
+	var block_definition: Resource = new(
+		PROPERTY_GETTER_NAME_FORMAT % [_class_name, property.name],
+		_class_name,
+		Engine.tr("The %s property") % property.name,
+		category,
+		Types.BlockType.VALUE,
+		property.type,
+		"%s",
+		"%s" % property.name,
+	)
+	block_definition.property_name = property.name
+	return block_definition
+
+
+static func new_variable_setter(variable: VariableDefinition) -> Resource:
+	var _type_string: String = Types.VARIANT_TYPE_TO_STRING[variable.var_type]
+	var block_definition: Resource = new(
+		VARIABLE_SETTER_NAME_FORMAT % variable.var_name,
+		"",
+		Engine.tr("Set the %s variable") % variable.var_name,
+		"Variables",
+		Types.BlockType.STATEMENT,
+		TYPE_NIL,
+		Engine.tr("set %s to {value: %s}") % [variable.var_name, _type_string],
+		"%s = {value}" % variable.var_name,
+	)
+	return block_definition
+
+
+static func new_variable_getter(variable: VariableDefinition) -> Resource:
+	var block_definition: Resource = new(
+		VARIABLE_GETTER_NAME_FORMAT % variable.var_name,
+		"",
+		Engine.tr("The %s variable") % variable.var_name,
+		"Variables",
+		Types.BlockType.VALUE,
+		variable.var_type,
+		"%s" % variable.var_name,
+		"%s",
+	)
+	return block_definition

addons/block_code/code_generation/blocks_catalog.gd

@@ -132,54 +132,18 @@ static func _add_property_definitions(_class_name: String, property_list: Array[
 		# Setter
 		var block_definition: BlockDefinition
 		if block_settings.get("has_setter", true):
-			block_definition = (
-				BlockDefinition
-				. new(
-					&"%s_set_%s" % [_class_name, property.name],
-					_class_name,
-					"Set the %s property" % property.name,
-					block_settings.category,
-					Types.BlockType.STATEMENT,
-					TYPE_NIL,
-					"set %s to {value: %s}" % [property.name.capitalize().to_lower(), type_string],
-					"%s = {value}" % property.name,
-					{"value": block_settings.get("default_set", _FALLBACK_SET_FOR_TYPE[property.type])},
-				)
-			)
+			var default_value: Variant = block_settings.get("default_set", _FALLBACK_SET_FOR_TYPE[property.type])
+			block_definition = BlockDefinition.new_property_setter(_class_name, property, block_settings.category, default_value)
 			_catalog[block_definition.name] = block_definition
 
 		# Changer
 		if block_settings.get("has_change", true):
-			block_definition = (
-				BlockDefinition
-				. new(
-					&"%s_change_%s" % [_class_name, property.name],
-					_class_name,
-					"Change the %s property" % property.name,
-					block_settings.category,
-					Types.BlockType.STATEMENT,
-					TYPE_NIL,
-					"change %s by {value: %s}" % [property.name.capitalize().to_lower(), type_string],
-					"%s += {value}" % property.name,
-					{"value": block_settings.get("default_change", _FALLBACK_CHANGE_FOR_TYPE[property.type])},
-				)
-			)
+			var default_value: Variant = block_settings.get("default_change", _FALLBACK_CHANGE_FOR_TYPE[property.type])
+			block_definition = BlockDefinition.new_property_changer(_class_name, property, block_settings.category, default_value)
 			_catalog[block_definition.name] = block_definition
 
 		# Getter
-		block_definition = (
-			BlockDefinition
-			. new(
-				&"%s_get_%s" % [_class_name, property.name],
-				_class_name,
-				"The %s property" % property.name,
-				block_settings.category,
-				Types.BlockType.VALUE,
-				property.type,
-				"%s" % property.name.capitalize().to_lower(),
-				"%s" % property.name,
-			)
-		)
+		block_definition = BlockDefinition.new_property_getter(_class_name, property, block_settings.category)
 		_catalog[block_definition.name] = block_definition
 
 
@@ -238,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] = []
@@ -253,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
@@ -276,55 +240,29 @@ static func add_custom_blocks(
 static func get_variable_block_definitions(variables: Array[VariableDefinition]) -> Array[BlockDefinition]:
 	var block_definitions: Array[BlockDefinition] = []
 	for variable: VariableDefinition in variables:
-		var block_def: BlockDefinition
-
-		# Getter
-		block_def = get_variable_getter_block_definition(variable)
-		block_definitions.append(block_def)
-
-		# Setter
-		block_def = get_variable_setter_block_definition(variable)
-		block_definitions.append(block_def)
+		block_definitions.append(BlockDefinition.new_variable_getter(variable))
+		block_definitions.append(BlockDefinition.new_variable_setter(variable))
 
 	return block_definitions
 
 
-static func get_variable_getter_block_definition(variable: VariableDefinition) -> BlockDefinition:
-	var block_def := BlockDefinition.new()
+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
 
-	block_def.name = "get_var_%s" % variable.var_name
-	block_def.category = "Variables"
-	block_def.type = Types.BlockType.VALUE
-	block_def.variant_type = variable.var_type
-	block_def.display_template = variable.var_name
-	block_def.code_template = variable.var_name
-
-	return block_def
 
-
-static func get_variable_setter_block_definition(variable: VariableDefinition) -> BlockDefinition:
-	var _type_string: String = Types.VARIANT_TYPE_TO_STRING[variable.var_type]
-	var block_def := BlockDefinition.new()
-
-	block_def.name = "set_var_%s" % variable.var_name
-	block_def.category = "Variables"
-	block_def.type = Types.BlockType.STATEMENT
-	block_def.display_template = "Set %s to {value: %s}" % [variable.var_name, _type_string]
-	block_def.code_template = "%s = {value}" % variable.var_name
-
-	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_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/examples/pong_game/player_score.tscn

@@ -1,11 +1,11 @@
 [gd_scene load_steps=11 format=3 uid="uid://djmtbm15n2wqq"]
 
-[ext_resource type="Script" path="res://addons/block_code/simple_nodes/simple_scoring/simple_scoring.gd" id="1_eafo0"]
-[ext_resource type="Script" path="res://addons/block_code/block_code_node/block_code.gd" id="2_4mu48"]
-[ext_resource type="Script" path="res://addons/block_code/serialization/block_serialization_tree.gd" id="3_kpcgt"]
-[ext_resource type="Script" path="res://addons/block_code/serialization/block_serialization.gd" id="4_ph8ne"]
-[ext_resource type="Script" path="res://addons/block_code/serialization/block_script_serialization.gd" id="6_k7up7"]
-[ext_resource type="Script" path="res://addons/block_code/code_generation/variable_definition.gd" id="7_x0rr3"]
+[ext_resource type="Script" uid="uid://chi1008f4c7el" path="res://addons/block_code/simple_nodes/simple_scoring/simple_scoring.gd" id="1_eafo0"]
+[ext_resource type="Script" uid="uid://cumxsbxj56dmk" path="res://addons/block_code/block_code_node/block_code.gd" id="2_4mu48"]
+[ext_resource type="Script" uid="uid://brx1cabdmgu38" path="res://addons/block_code/serialization/block_serialization_tree.gd" id="3_kpcgt"]
+[ext_resource type="Script" uid="uid://u035wsjd5tpj" path="res://addons/block_code/serialization/block_serialization.gd" id="4_ph8ne"]
+[ext_resource type="Script" uid="uid://tlsvrkc3fubl" path="res://addons/block_code/serialization/block_script_serialization.gd" id="6_k7up7"]
+[ext_resource type="Script" uid="uid://bwkinr8omutpw" path="res://addons/block_code/code_generation/variable_definition.gd" id="7_x0rr3"]
 
 [sub_resource type="Resource" id="Resource_paaek"]
 script = ExtResource("4_ph8ne")
@@ -44,7 +44,6 @@ version = 0
 
 [node name="PlayerScore" type="Node2D" groups=["hud"]]
 script = ExtResource("1_eafo0")
-score = null
 
 [node name="BlockCode" type="Node" parent="."]
 script = ExtResource("2_4mu48")

addons/block_code/examples/pong_game/pong_game.tscn

@@ -612,11 +612,9 @@ follow_viewport_enabled = true
 
 [node name="PlayerScoreLeft" parent="CanvasLayer" instance=ExtResource("13_jvkp7")]
 position = Vector2(240, 0)
-score = 0
 
 [node name="PlayerScoreRight" parent="CanvasLayer" instance=ExtResource("13_jvkp7")]
 position = Vector2(1200, 0)
-score = 0
 
 [node name="Camera2D" type="Camera2D" parent="."]
 position = Vector2(960, 540)

addons/block_code/examples/spawner/spawner.tscn

@@ -1,14 +1,14 @@
 [gd_scene load_steps=37 format=3 uid="uid://cbgxxdewi6gld"]
 
-[ext_resource type="Script" path="res://addons/block_code/simple_spawner/simple_spawner.gd" id="1_g2l2s"]
+[ext_resource type="Script" uid="uid://7kttlqmve4yi" path="res://addons/block_code/simple_spawner/simple_spawner.gd" id="1_g2l2s"]
 [ext_resource type="PackedScene" uid="uid://dhfvkunrlqads" path="res://addons/block_code/examples/spawner/ball.tscn" id="2_d0h86"]
 [ext_resource type="PackedScene" uid="uid://c8hrliwojohal" path="res://addons/block_code/examples/spawner/volatile_ball.tscn" id="3_tt12o"]
-[ext_resource type="Script" path="res://addons/block_code/block_code_node/block_code.gd" id="4_e0fbh"]
-[ext_resource type="Script" path="res://addons/block_code/serialization/block_serialization_tree.gd" id="5_g4h7g"]
-[ext_resource type="Script" path="res://addons/block_code/serialization/block_serialization.gd" id="6_dv2kl"]
-[ext_resource type="Script" path="res://addons/block_code/serialization/value_block_serialization.gd" id="7_cykhe"]
-[ext_resource type="Script" path="res://addons/block_code/serialization/block_script_serialization.gd" id="8_tovvd"]
-[ext_resource type="Script" path="res://addons/block_code/code_generation/variable_definition.gd" id="9_m8g1j"]
+[ext_resource type="Script" uid="uid://cumxsbxj56dmk" path="res://addons/block_code/block_code_node/block_code.gd" id="4_e0fbh"]
+[ext_resource type="Script" uid="uid://brx1cabdmgu38" path="res://addons/block_code/serialization/block_serialization_tree.gd" id="5_g4h7g"]
+[ext_resource type="Script" uid="uid://u035wsjd5tpj" path="res://addons/block_code/serialization/block_serialization.gd" id="6_dv2kl"]
+[ext_resource type="Script" uid="uid://duvgxorhfitb7" path="res://addons/block_code/serialization/value_block_serialization.gd" id="7_cykhe"]
+[ext_resource type="Script" uid="uid://tlsvrkc3fubl" path="res://addons/block_code/serialization/block_script_serialization.gd" id="8_tovvd"]
+[ext_resource type="Script" uid="uid://bwkinr8omutpw" path="res://addons/block_code/code_generation/variable_definition.gd" id="9_m8g1j"]
 
 [sub_resource type="Resource" id="Resource_1x252"]
 script = ExtResource("6_dv2kl")
@@ -211,6 +211,7 @@ version = 0
 [sub_resource type="WorldBoundaryShape2D" id="WorldBoundaryShape2D_c5n1h"]
 
 [node name="Node2D" type="Node2D"]
+auto_translate_mode = 2
 
 [node name="SimpleSpawner" type="Node2D" parent="."]
 position = Vector2(103, 128)