BlockDefinition: Support extension scripts

dylanmccall · dylanmccall · commit dc99328d28b9 · 2024-09-19T11:26:31.000-07:00
An extension script can implement functions which refine a block's presentation depending on the current context, such as the node it is attached to. https://phabricator.endlessm.com/T35564
diff --git a/addons/block_code/code_generation/block_definition.gd b/addons/block_code/code_generation/block_definition.gd
@@ -27,6 +27,14 @@ const Types = preload("res://addons/block_code/types/types.gd")
 ## Empty except for blocks that have a defined scope
 @export var scope: String
 
+@export var extension_script: GDScript
+
+var _extension: BlockExtension:
+	get:
+		if _extension == null and extension_script and extension_script.can_instantiate():
+			_extension = extension_script.new()
+		return _extension as BlockExtension
+
 
 func _init(
 	p_name: StringName = &"",
@@ -40,6 +48,7 @@ func _init(
 	p_defaults = {},
 	p_signal_name: String = "",
 	p_scope: String = "",
+	p_extension_script: GDScript = null,
 ):
 	name = p_name
 	target_node_class = p_target_node_class
@@ -52,6 +61,7 @@ func _init(
 	defaults = p_defaults
 	signal_name = p_signal_name
 	scope = p_scope
+	extension_script = p_extension_script
 
 
 func _to_string():
diff --git a/addons/block_code/code_generation/block_extension.gd b/addons/block_code/code_generation/block_extension.gd
@@ -0,0 +1,3 @@
+@tool
+class_name BlockExtension
+extends Object

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+@tool`
	`2`	`+class_name BlockExtension`
	`3`	`+extends Object`