From 06f325cb0c7c03c3acf826109d931d10cd9600e9 Mon Sep 17 00:00:00 2001
From: Will Thompson <wjt@endlessos.org>
Date: Mon, 14 Oct 2024 11:03:22 +0200
Subject: [PATCH 1/5] SimpleSpawner: Add unit suffixes to exported properties

I learned about this annotation in a workshop hosted by Nathan from GDQuest.
---
 addons/block_code/simple_spawner/simple_spawner.gd | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/addons/block_code/simple_spawner/simple_spawner.gd b/addons/block_code/simple_spawner/simple_spawner.gd
index fac71698..16b20fb7 100644
--- a/addons/block_code/simple_spawner/simple_spawner.gd
+++ b/addons/block_code/simple_spawner/simple_spawner.gd
@@ -23,11 +23,11 @@ enum LimitBehavior { REPLACE, NO_SPAWN }
 
 ## The period of time in seconds to spawn another component. If zero, they won't spawn
 ## automatically. Use the "Spawn" block.
-@export_range(0.0, 10.0, 0.1, "or_greater") var spawn_frequency: float = 0.0:
+@export_range(0.0, 10.0, 0.1, "or_greater", "suffix:s") var spawn_frequency: float = 0.0:
 	set = _set_spawn_fraquency
 
 ## How many spawned scenes are allowed. If zero, there is no limit.
-@export_range(0, 50, 0.1, "or_greater") var spawn_limit: int = 50
+@export_range(0, 50, 0.1, "or_greater", "suffix:scenes") var spawn_limit: int = 50
 
 ## What happens when the limit is reached and a new spawn is attempted:
 ## - Replace: Remove the oldest spawned scene and spawn a new one.

From 5e3a10c5990c122968954b283daf464abdd78826 Mon Sep 17 00:00:00 2001
From: Will Thompson <wjt@endlessos.org>
Date: Wed, 23 Oct 2024 10:21:19 +0100
Subject: [PATCH 2/5] Support aliases for block definitions

This will allow us to add backwards-compatibility aliases to preserve existing
programs when we rename a block for some reason.
---
 .../code_generation/block_definition.gd       |  1 +
 .../code_generation/blocks_catalog.gd         | 21 +++++++++++++------
 .../block_script_serialization.gd             |  2 +-
 3 files changed, 17 insertions(+), 7 deletions(-)

diff --git a/addons/block_code/code_generation/block_definition.gd b/addons/block_code/code_generation/block_definition.gd
index 26ac9e70..3418493a 100644
--- a/addons/block_code/code_generation/block_definition.gd
+++ b/addons/block_code/code_generation/block_definition.gd
@@ -6,6 +6,7 @@ const Types = preload("res://addons/block_code/types/types.gd")
 const FORMAT_STRING_PATTERN = "\\[(?<out_parameter>[^\\]]+)\\]|\\{(?<in_parameter>[^}]+)\\}|(?<label>[^\\{\\[]+)"
 
 @export var name: StringName
+@export var aliases: Array[StringName]
 
 ## The target node. Leaving this empty the block is considered a general block
 ## (for any node).
diff --git a/addons/block_code/code_generation/blocks_catalog.gd b/addons/block_code/code_generation/blocks_catalog.gd
index 227b568f..4bec2edc 100644
--- a/addons/block_code/code_generation/blocks_catalog.gd
+++ b/addons/block_code/code_generation/blocks_catalog.gd
@@ -87,13 +87,19 @@ const _SETTINGS_FOR_CLASS_PROPERTY = {
 }
 
 static var _catalog: Dictionary
+static var _aliases: Dictionary
 
 
+static func _add_to_catalog(block_definition: BlockDefinition):
+	_catalog[block_definition.name] = block_definition
+	for alias in block_definition.aliases:
+		_aliases[alias] = block_definition
+
 static func _setup_definitions_from_files():
 	var definition_files = Util.get_files_in_dir_recursive(_BLOCKS_PATH, "*.tres")
 	for file in definition_files:
 		var block_definition: BlockDefinition = load(file)
-		_catalog[block_definition.name] = block_definition
+		_add_to_catalog(block_definition)
 		var target = block_definition.target_node_class
 		if not target:
 			continue
@@ -123,7 +129,7 @@ static func _add_property_definitions(_class_name: String, property_list: Array[
 					{"value": block_settings.get("default_set", _FALLBACK_SET_FOR_TYPE[property.type])},
 				)
 			)
-			_catalog[block_definition.name] = block_definition
+			_add_to_catalog(block_definition)
 
 		# Changer
 		if block_settings.get("has_change", true):
@@ -141,7 +147,7 @@ static func _add_property_definitions(_class_name: String, property_list: Array[
 					{"value": block_settings.get("default_change", _FALLBACK_CHANGE_FOR_TYPE[property.type])},
 				)
 			)
-			_catalog[block_definition.name] = block_definition
+			_add_to_catalog(block_definition)
 
 		# Getter
 		block_definition = (
@@ -157,7 +163,7 @@ static func _add_property_definitions(_class_name: String, property_list: Array[
 				"%s" % property.name,
 			)
 		)
-		_catalog[block_definition.name] = block_definition
+		_add_to_catalog(block_definition)
 
 
 static func _setup_properties_for_class():
@@ -172,16 +178,17 @@ static func setup():
 		return
 
 	_catalog = {}
+	_aliases = {}
 	_setup_definitions_from_files()
 	_setup_properties_for_class()
 
 
 static func get_block(block_name: StringName):
-	return _catalog.get(block_name)
+	return _catalog.get(block_name) or _aliases.get(block_name)
 
 
 static func has_block(block_name: StringName):
-	return block_name in _catalog
+	return block_name in _catalog or block_name in _aliases
 
 
 static func _get_blocks_by_class(_class_name: String) -> Array[BlockDefinition]:
@@ -246,6 +253,8 @@ static func add_custom_blocks(
 
 	for block_definition in block_definitions:
 		_catalog[block_definition.name] = block_definition
+		for alias in block_definition.aliases:
+			_catalog[alias] = block_definition
 
 	_add_property_definitions(_class_name, property_list, property_settings)
 
diff --git a/addons/block_code/serialization/block_script_serialization.gd b/addons/block_code/serialization/block_script_serialization.gd
index 5f3051e3..11dd9c75 100644
--- a/addons/block_code/serialization/block_script_serialization.gd
+++ b/addons/block_code/serialization/block_script_serialization.gd
@@ -101,7 +101,7 @@ func get_block_definition(block_name: String) -> BlockDefinition:
 
 func _get_base_block_definition(block_name: String) -> BlockDefinition:
 	for block_definition in _available_blocks:
-		if block_definition.name == block_name:
+		if block_definition.name == block_name or block_name in block_definition.aliases:
 			return block_definition
 	return null
 

From 573bdd3feed58cc6a92521b903bb6816a9766a5e Mon Sep 17 00:00:00 2001
From: Will Thompson <wjt@endlessos.org>
Date: Wed, 23 Oct 2024 10:41:56 +0100
Subject: [PATCH 3/5] Add empty aliases array to existing block definitions

---
 addons/block_code/blocks/communication/add_node_to_group.tres    | 1 +
 addons/block_code/blocks/communication/add_to_group.tres         | 1 +
 addons/block_code/blocks/communication/call_method_group.tres    | 1 +
 addons/block_code/blocks/communication/get_node.tres             | 1 +
 addons/block_code/blocks/communication/is_in_group.tres          | 1 +
 addons/block_code/blocks/communication/is_node_in_group.tres     | 1 +
 addons/block_code/blocks/communication/remove_from_group.tres    | 1 +
 .../block_code/blocks/communication/remove_node_from_group.tres  | 1 +
 addons/block_code/blocks/graphics/animationplayer_play.tres      | 1 +
 addons/block_code/blocks/input/is_input_actioned.tres            | 1 +
 addons/block_code/blocks/logic/compare.tres                      | 1 +
 addons/block_code/blocks/sounds/pause_continue_sound.tres        | 1 +
 12 files changed, 12 insertions(+)

diff --git a/addons/block_code/blocks/communication/add_node_to_group.tres b/addons/block_code/blocks/communication/add_node_to_group.tres
index 2e386d22..d95f67a1 100644
--- a/addons/block_code/blocks/communication/add_node_to_group.tres
+++ b/addons/block_code/blocks/communication/add_node_to_group.tres
@@ -12,6 +12,7 @@ items = []
 [resource]
 script = ExtResource("1_5qal7")
 name = &"add_node_to_group"
+aliases = Array[StringName]([])
 target_node_class = ""
 description = "Add the node into the group"
 category = "Communication | Groups"
diff --git a/addons/block_code/blocks/communication/add_to_group.tres b/addons/block_code/blocks/communication/add_to_group.tres
index 04e14a6f..677be4bd 100644
--- a/addons/block_code/blocks/communication/add_to_group.tres
+++ b/addons/block_code/blocks/communication/add_to_group.tres
@@ -12,6 +12,7 @@ items = []
 [resource]
 script = ExtResource("1_bcm71")
 name = &"add_to_group"
+aliases = Array[StringName]([])
 target_node_class = ""
 description = "Add this node into the group"
 category = "Communication | Groups"
diff --git a/addons/block_code/blocks/communication/call_method_group.tres b/addons/block_code/blocks/communication/call_method_group.tres
index 06515f55..26798ea2 100644
--- a/addons/block_code/blocks/communication/call_method_group.tres
+++ b/addons/block_code/blocks/communication/call_method_group.tres
@@ -12,6 +12,7 @@ items = []
 [resource]
 script = ExtResource("1_mlm68")
 name = &"call_method_group"
+aliases = Array[StringName]([])
 target_node_class = ""
 description = "Calls the method/function on each member of the given group"
 category = "Communication | Methods"
diff --git a/addons/block_code/blocks/communication/get_node.tres b/addons/block_code/blocks/communication/get_node.tres
index 22f7f5ff..5895db6c 100644
--- a/addons/block_code/blocks/communication/get_node.tres
+++ b/addons/block_code/blocks/communication/get_node.tres
@@ -12,6 +12,7 @@ items = []
 [resource]
 script = ExtResource("1_d60g7")
 name = &"get_node"
+aliases = Array[StringName]([])
 target_node_class = ""
 description = "Get the node at the given path"
 category = "Communication | Nodes"
diff --git a/addons/block_code/blocks/communication/is_in_group.tres b/addons/block_code/blocks/communication/is_in_group.tres
index afd089d8..26576afa 100644
--- a/addons/block_code/blocks/communication/is_in_group.tres
+++ b/addons/block_code/blocks/communication/is_in_group.tres
@@ -12,6 +12,7 @@ items = []
 [resource]
 script = ExtResource("1_tjyq5")
 name = &"is_in_group"
+aliases = Array[StringName]([])
 target_node_class = ""
 description = "Is this node in the group"
 category = "Communication | Groups"
diff --git a/addons/block_code/blocks/communication/is_node_in_group.tres b/addons/block_code/blocks/communication/is_node_in_group.tres
index d56b3f7e..1f09b963 100644
--- a/addons/block_code/blocks/communication/is_node_in_group.tres
+++ b/addons/block_code/blocks/communication/is_node_in_group.tres
@@ -12,6 +12,7 @@ items = []
 [resource]
 script = ExtResource("1_5krrs")
 name = &"is_node_in_group"
+aliases = Array[StringName]([])
 target_node_class = ""
 description = "Is the node in the group"
 category = "Communication | Groups"
diff --git a/addons/block_code/blocks/communication/remove_from_group.tres b/addons/block_code/blocks/communication/remove_from_group.tres
index b25fe8ad..41fd2cd0 100644
--- a/addons/block_code/blocks/communication/remove_from_group.tres
+++ b/addons/block_code/blocks/communication/remove_from_group.tres
@@ -12,6 +12,7 @@ items = []
 [resource]
 script = ExtResource("1_cdwef")
 name = &"remove_from_group"
+aliases = Array[StringName]([])
 target_node_class = ""
 description = "Remove this node from the group"
 category = "Communication | Groups"
diff --git a/addons/block_code/blocks/communication/remove_node_from_group.tres b/addons/block_code/blocks/communication/remove_node_from_group.tres
index defa9251..4e7a4bc3 100644
--- a/addons/block_code/blocks/communication/remove_node_from_group.tres
+++ b/addons/block_code/blocks/communication/remove_node_from_group.tres
@@ -12,6 +12,7 @@ items = []
 [resource]
 script = ExtResource("1_pec24")
 name = &"remove_node_from_group"
+aliases = Array[StringName]([])
 target_node_class = ""
 description = "Remove the node from the group"
 category = "Communication | Groups"
diff --git a/addons/block_code/blocks/graphics/animationplayer_play.tres b/addons/block_code/blocks/graphics/animationplayer_play.tres
index 3a593f83..57d40d4a 100644
--- a/addons/block_code/blocks/graphics/animationplayer_play.tres
+++ b/addons/block_code/blocks/graphics/animationplayer_play.tres
@@ -22,6 +22,7 @@ items = ["until done", "in the background"]
 [resource]
 script = ExtResource("1_emeuv")
 name = &"animationplayer_play"
+aliases = Array[StringName]([])
 target_node_class = "AnimationPlayer"
 description = "Play the animation."
 category = "Graphics | Animation"
diff --git a/addons/block_code/blocks/input/is_input_actioned.tres b/addons/block_code/blocks/input/is_input_actioned.tres
index 5f7545f3..cac77d22 100644
--- a/addons/block_code/blocks/input/is_input_actioned.tres
+++ b/addons/block_code/blocks/input/is_input_actioned.tres
@@ -12,6 +12,7 @@ items = ["pressed", "just_pressed", "just_released"]
 [resource]
 script = ExtResource("1_rprh7")
 name = &"is_input_actioned"
+aliases = Array[StringName]([])
 target_node_class = ""
 description = "True if the specified input action has been pressed or released."
 category = "Input"
diff --git a/addons/block_code/blocks/logic/compare.tres b/addons/block_code/blocks/logic/compare.tres
index d4b4dc4f..419dd036 100644
--- a/addons/block_code/blocks/logic/compare.tres
+++ b/addons/block_code/blocks/logic/compare.tres
@@ -11,6 +11,7 @@ items = ["==", ">", "<", ">=", "<=", "!="]
 [resource]
 script = ExtResource("1_wp40r")
 name = &"compare"
+aliases = Array[StringName]([])
 target_node_class = ""
 description = ""
 category = "Logic | Comparison"
diff --git a/addons/block_code/blocks/sounds/pause_continue_sound.tres b/addons/block_code/blocks/sounds/pause_continue_sound.tres
index 17487bbc..ef2d80c2 100644
--- a/addons/block_code/blocks/sounds/pause_continue_sound.tres
+++ b/addons/block_code/blocks/sounds/pause_continue_sound.tres
@@ -11,6 +11,7 @@ items = ["pause", "continue"]
 [resource]
 script = ExtResource("1_q04gm")
 name = &"pause_continue_sound"
+aliases = Array[StringName]([])
 target_node_class = ""
 description = "Pause/Continue the audio stream"
 category = "Sounds"

From e414d164f5b6c0be59ab41a8dcf970e8afab60d6 Mon Sep 17 00:00:00 2001
From: Will Thompson <wjt@endlessos.org>
Date: Wed, 23 Oct 2024 10:42:49 +0100
Subject: [PATCH 4/5] SimpleSpawner: Rename frequency blocks to period

---
 addons/block_code/simple_spawner/simple_spawner.gd | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)

diff --git a/addons/block_code/simple_spawner/simple_spawner.gd b/addons/block_code/simple_spawner/simple_spawner.gd
index 16b20fb7..fb98a2de 100644
--- a/addons/block_code/simple_spawner/simple_spawner.gd
+++ b/addons/block_code/simple_spawner/simple_spawner.gd
@@ -153,21 +153,23 @@ static func setup_custom_blocks():
 	block_list.append(block_definition)
 
 	block_definition = BlockDefinition.new()
-	block_definition.name = &"simplespawner_set_spawn_frequency"
+	block_definition.name = &"simplespawner_set_spawn_period"
+	block_definition.aliases = [&"simplespawner_set_spawn_frequency"]
 	block_definition.target_node_class = _class_name
 	block_definition.category = "Lifecycle | Spawn"
 	block_definition.type = Types.BlockType.STATEMENT
-	block_definition.display_template = "set spawn frequency to {new_frequency: FLOAT}"
-	block_definition.code_template = "do_set_spawn_frequency({new_frequency})"
+	block_definition.display_template = "set spawn period to {new_period: FLOAT} seconds"
+	block_definition.code_template = "spawn_frequency = {new_period})"
 	block_list.append(block_definition)
 
 	block_definition = BlockDefinition.new()
-	block_definition.name = &"simplespawner_get_spawn_frequency"
+	block_definition.name = &"simplespawner_get_spawn_period"
+	block_definition.aliases = [&"simplespawner_get_spawn_frequency"]
 	block_definition.target_node_class = _class_name
 	block_definition.category = "Lifecycle | Spawn"
 	block_definition.type = Types.BlockType.VALUE
 	block_definition.variant_type = TYPE_FLOAT
-	block_definition.display_template = "spawn frequency"
+	block_definition.display_template = "spawn period"
 	block_definition.code_template = "spawn_frequency"
 	block_list.append(block_definition)
 

From 29c14525524fc33d43db35c0112857f6aa6de028 Mon Sep 17 00:00:00 2001
From: Will Thompson <wjt@endlessos.org>
Date: Wed, 23 Oct 2024 10:45:42 +0100
Subject: [PATCH 5/5] SimpleSpawner: Rename spawn_frequency to spawn_period

---
 .../simple_spawner/simple_spawner.gd          | 22 +++++++++----------
 1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/addons/block_code/simple_spawner/simple_spawner.gd b/addons/block_code/simple_spawner/simple_spawner.gd
index fb98a2de..786ea17c 100644
--- a/addons/block_code/simple_spawner/simple_spawner.gd
+++ b/addons/block_code/simple_spawner/simple_spawner.gd
@@ -23,8 +23,8 @@ enum LimitBehavior { REPLACE, NO_SPAWN }
 
 ## The period of time in seconds to spawn another component. If zero, they won't spawn
 ## automatically. Use the "Spawn" block.
-@export_range(0.0, 10.0, 0.1, "or_greater", "suffix:s") var spawn_frequency: float = 0.0:
-	set = _set_spawn_fraquency
+@export_range(0.0, 10.0, 0.1, "or_greater", "suffix:s") var spawn_period: float = 0.0:
+	set = _set_spawn_period
 
 ## How many spawned scenes are allowed. If zero, there is no limit.
 @export_range(0, 50, 0.1, "or_greater", "suffix:scenes") var spawn_limit: int = 50
@@ -53,20 +53,20 @@ func _remove_oldest_spawned():
 		spawned.get_parent().remove_child(spawned)
 
 
-func _set_spawn_fraquency(new_frequency: float):
-	spawn_frequency = new_frequency
+func _set_spawn_period(new_period: float):
+	spawn_period = new_period
 	if not _timer or not is_instance_valid(_timer):
 		return
-	_timer.wait_time = spawn_frequency
+	_timer.wait_time = spawn_period
 
 
 func spawn_start():
-	if spawn_frequency == 0.0:
+	if spawn_period == 0.0:
 		return
 	if not _timer or not is_instance_valid(_timer):
 		_timer = Timer.new()
 		add_child(_timer)
-		_timer.wait_time = spawn_frequency
+		_timer.wait_time = spawn_period
 		_timer.timeout.connect(spawn_once)
 	_timer.start()
 	spawn_once.call_deferred()
@@ -106,9 +106,9 @@ func spawn_once():
 			get_tree().current_scene.add_child(spawned)
 			spawned.position = global_position
 
-
+## @deprecated: Use [member spawn_period] property
 func do_set_spawn_frequency(new_frequency: float):
-	_set_spawn_fraquency(new_frequency)
+	spawn_period = new_frequency
 
 
 static func setup_custom_blocks():
@@ -159,7 +159,7 @@ static func setup_custom_blocks():
 	block_definition.category = "Lifecycle | Spawn"
 	block_definition.type = Types.BlockType.STATEMENT
 	block_definition.display_template = "set spawn period to {new_period: FLOAT} seconds"
-	block_definition.code_template = "spawn_frequency = {new_period})"
+	block_definition.code_template = "spawn_period = {new_period})"
 	block_list.append(block_definition)
 
 	block_definition = BlockDefinition.new()
@@ -170,7 +170,7 @@ static func setup_custom_blocks():
 	block_definition.type = Types.BlockType.VALUE
 	block_definition.variant_type = TYPE_FLOAT
 	block_definition.display_template = "spawn period"
-	block_definition.code_template = "spawn_frequency"
+	block_definition.code_template = "spawn_period"
 	block_list.append(block_definition)
 
 	BlocksCatalog.add_custom_blocks(_class_name, block_list, [], {})