Translate properties

manuq · manuq · commit 7ecd7cb5dfb6 · 2025-06-09T15:26:03.000-03:00
Display localized properties whenever possible. Just like the Inspector
does when "Localized" is set from the dropdown menu.

For this the property name must be stored in the block definition. Once
translated, it is added to the display template.
diff --git a/addons/block_code/code_generation/block_definition.gd b/addons/block_code/code_generation/block_definition.gd
@@ -32,6 +32,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,6 +70,10 @@ 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)
 
 
@@ -198,42 +205,48 @@ 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]
-	return new(
+	var block_definition: Resource = new(
 		&"%s_set_%s" % [_class_name, property.name],
 		_class_name,
 		"Set the %s property" % property.name,
 		category,
 		Types.BlockType.STATEMENT,
 		TYPE_NIL,
-		"set %s to {value: %s}" % [property.name.capitalize().to_lower(), type_string],
+		"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]
-	return new(
+	var block_definition: Resource = new(
 		&"%s_change_%s" % [_class_name, property.name],
 		_class_name,
 		"Change the %s property" % property.name,
 		category,
 		Types.BlockType.STATEMENT,
 		TYPE_NIL,
-		"change %s by {value: %s}" % [property.name.capitalize().to_lower(), type_string],
+		"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:
-	return new(
+	var block_definition: Resource = new(
 		&"%s_get_%s" % [_class_name, property.name],
 		_class_name,
 		"The %s property" % property.name,
 		category,
 		Types.BlockType.VALUE,
 		property.type,
-		"%s" % property.name.capitalize().to_lower(),
+		"%s",
 		"%s" % property.name,
 	)
+	block_definition.property_name = property.name
+	return block_definition
diff --git a/addons/block_code/ui/blocks/block/block.gd b/addons/block_code/ui/blocks/block/block.gd
@@ -129,6 +129,13 @@ func _get_format_string() -> String:
 	if not definition:
 		return ""
 
+	if definition.property_name:
+		var domain: TranslationDomain = TranslationServer.get_or_add_domain("godot.properties")
+		var translated_property: String = domain.translate(definition.property_name.capitalize())
+		# TODO: Ideally we should be also passing the context. See:
+		# https://github.com/godotengine/godot/blob/978b38797ba8e8757592f21101e32e364d60662d/editor/editor_property_name_processor.cpp#L90
+		return tr(definition.display_template) % translated_property.to_lower()
+
 	return tr(definition.display_template)
 
 
