Revamp variable system

Instead of accessing variables by VAR_DICT, use GDScript properties.

Add a new "variables" property to block script data resource.

Add a menu for creating variable of specific type.

Author: wnbaum

addons/block_code/block_code_plugin.gd

@@ -42,7 +42,9 @@ const DISABLED_CLASSES := [
 	"TitleBar",
 	"MainPanel",
 	"BlockCodePlugin",
-	"BlockCategoryButton"
+	"BlockCategoryButton",
+	"CreateVariableButton",
+	"VariableCategoryDisplay"
 ]
 
 

addons/block_code/block_script_data/block_script_data.gd

@@ -3,10 +3,12 @@ extends Resource
 
 @export var script_inherits: String
 @export var block_trees: SerializedBlockTreeNodeArray
+@export var variables: Array[VariableResource]
 @export var generated_script: String
 
 
-func _init(p_script_inherits: String = "", p_block_trees: SerializedBlockTreeNodeArray = null, p_generated_script: String = ""):
+func _init(p_script_inherits: String = "", p_block_trees: SerializedBlockTreeNodeArray = null, p_variables: Array[VariableResource] = [], p_generated_script: String = ""):
 	script_inherits = p_script_inherits
 	block_trees = p_block_trees
 	generated_script = p_generated_script
+	variables = p_variables

addons/block_code/types/types.gd

@@ -36,6 +36,7 @@ const cast_relationships = [
 	[TYPE_INT, TYPE_STRING, "str(%s)"],
 	[TYPE_FLOAT, TYPE_STRING, "str(%s)"],
 	[TYPE_COLOR, TYPE_STRING, "str(%s)"],
+	[TYPE_VECTOR2, TYPE_STRING, "str(%s)"],
 ]
 
 # Directed graph, edges are CastGraphEdge

addons/block_code/ui/block_canvas/node_block_canvas/node_block_canvas.gd

@@ -3,7 +3,7 @@ class_name NodeBlockCanvas
 extends BlockCanvas
 
 
-func generate_script_from_current_window(script_inherits: String = ""):
+func generate_script_from_current_window(bsd: BlockScriptData):
 	# TODO: implement multiple windows
 	var current_window := _window
 
@@ -21,9 +21,12 @@ func generate_script_from_current_window(script_inherits: String = ""):
 
 	var script: String = ""
 
-	script += "extends %s\n\n" % script_inherits
+	script += "extends %s\n\n" % bsd.script_inherits
 
-	script += "var VAR_DICT := {}\n\n"
+	for variable in bsd.variables:
+		script += "var %s\n\n" % variable.var_name.to_snake_case()
+
+	script += "\n"
 
 	var init_func = InstructionTree.TreeNode.new("func _init():")
 

addons/block_code/ui/block_canvas/variable_resource.gd

@@ -0,0 +1,10 @@
+class_name VariableResource
+extends Resource
+
+@export var var_name: String
+@export var var_type: Variant.Type
+
+
+func _init(p_var_name: String = "", p_var_type: Variant.Type = TYPE_NIL):
+	var_name = p_var_name
+	var_type = p_var_type

addons/block_code/ui/main_panel.gd

@@ -26,6 +26,7 @@ var undo_redo: EditorUndoRedoManager
 
 func _ready():
 	_picker.block_picked.connect(_drag_manager.copy_picked_block_and_drag)
+	_picker.variable_created.connect(_create_variable)
 	_block_canvas.reconnect_block.connect(_drag_manager.connect_block_canvas_signals)
 	_drag_manager.block_dropped.connect(save_script)
 	_drag_manager.block_modified.connect(save_script)
@@ -79,7 +80,7 @@ func save_script():
 	undo_redo.add_undo_property(_current_block_code_node.block_script, "generated_script", _current_block_code_node.block_script.generated_script)
 
 	var block_trees := _block_canvas.get_canvas_block_trees()
-	var generated_script = _block_canvas.generate_script_from_current_window(block_script.script_inherits)
+	var generated_script = _block_canvas.generate_script_from_current_window(block_script)
 	block_script.block_trees = block_trees
 	block_script.generated_script = generated_script
 
@@ -110,7 +111,7 @@ func _print_generated_script():
 	if _current_block_code_node == null:
 		return
 	var block_script: BlockScriptData = _current_block_code_node.block_script
-	var script: String = _block_canvas.generate_script_from_current_window(block_script.script_inherits)
+	var script: String = _block_canvas.generate_script_from_current_window(block_script)
 	print(script)
 	print("Debug script! (not saved)")
 
@@ -125,3 +126,22 @@ func toggle_collapse():
 
 func _on_collapse_button_pressed():
 	toggle_collapse()
+
+
+func _create_variable(variable: VariableResource):
+	if _current_block_code_node == null:
+		print("No script loaded to add variable to.")
+		return
+
+	var block_script: BlockScriptData = _current_block_code_node.block_script
+
+	undo_redo.create_action("Create variable %s in %s's block code script" % [variable.var_name, _current_block_code_node.get_parent().name])
+	undo_redo.add_undo_property(_current_block_code_node.block_script, "variables", _current_block_code_node.block_script.variables)
+
+	var new_variables = block_script.variables.duplicate()
+	new_variables.append(variable)
+
+	undo_redo.add_do_property(_current_block_code_node.block_script, "variables", new_variables)
+	undo_redo.commit_action()
+
+	_picker.reload_variables(new_variables)

addons/block_code/ui/picker/categories/category_factory.gd

@@ -321,32 +321,6 @@ static func get_general_blocks() -> Array[Block]:
 
 #endregion
 #region Variables
-
-	b = BLOCKS["statement_block"].instantiate()
-	b.block_format = "Set String {var: STRING} {value: STRING}"
-	b.statement = "VAR_DICT[{var}] = {value}"
-	b.category = "Variables"
-	block_list.append(b)
-
-	b = BLOCKS["parameter_block"].instantiate()
-	b.block_format = "Get String {var: STRING}"
-	b.statement = "VAR_DICT[{var}]"
-	b.category = "Variables"
-	block_list.append(b)
-
-	b = BLOCKS["statement_block"].instantiate()
-	b.block_format = "Set Int {var: STRING} {value: INT}"
-	b.statement = "VAR_DICT[{var}] = {value}"
-	b.category = "Variables"
-	block_list.append(b)
-
-	b = BLOCKS["parameter_block"].instantiate()
-	b.variant_type = TYPE_INT
-	b.block_format = "Get Int {var: STRING}"
-	b.statement = "VAR_DICT[{var}]"
-	b.category = "Variables"
-	block_list.append(b)
-
 	b = BLOCKS["parameter_block"].instantiate()
 	b.block_format = "To String {int: INT}"
 	b.statement = "str({int})"
@@ -506,10 +480,10 @@ static func get_general_blocks() -> Array[Block]:
 static func property_to_blocklist(property: Dictionary) -> Array[Block]:
 	var block_list: Array[Block] = []
 
-	var block_type = property.type
+	var variant_type = property.type
 
-	if block_type:
-		var type_string: String = Types.VARIANT_TYPE_TO_STRING[block_type]
+	if variant_type:
+		var type_string: String = Types.VARIANT_TYPE_TO_STRING[variant_type]
 
 		var b = BLOCKS["statement_block"].instantiate()
 		b.block_format = "Set %s to {value: %s}" % [property.name.capitalize(), type_string]
@@ -524,7 +498,7 @@ static func property_to_blocklist(property: Dictionary) -> Array[Block]:
 		block_list.append(b)
 
 		b = BLOCKS["parameter_block"].instantiate()
-		b.block_type = block_type
+		b.variant_type = variant_type
 		b.block_format = "%s" % property.name.capitalize()
 		b.statement = "%s" % property.name
 		b.category = property.category
@@ -718,3 +692,29 @@ static func _get_input_blocks() -> Array[Block]:
 				InputMap.action_add_event(action, event)
 
 	return block_list
+
+
+static func get_variable_blocks(variables: Array[VariableResource]):
+	var block_list: Array[Block]
+
+	for variable in variables:
+		var capital_name: String = variable.var_name.capitalize()
+		var camel_name: String = variable.var_name.to_snake_case()
+		var type_string: String = Types.VARIANT_TYPE_TO_STRING[variable.var_type]
+
+		var b = BLOCKS["parameter_block"].instantiate()
+		b.variant_type = variable.var_type
+		b.block_format = capital_name
+		b.statement = camel_name
+		# HACK: Color the blocks since they are outside of the normal picker system
+		b.color = BUILTIN_PROPS["Variables"].color
+		block_list.append(b)
+
+		b = BLOCKS["statement_block"].instantiate()
+		b.block_type = Types.BlockType.EXECUTE
+		b.block_format = "Set %s to {value: %s}" % [capital_name, type_string]
+		b.statement = "%s = {value}" % [camel_name]
+		b.color = BUILTIN_PROPS["Variables"].color
+		block_list.append(b)
+
+	return block_list

addons/block_code/ui/picker/categories/variable_category/create_variable_button.gd

@@ -0,0 +1,37 @@
+@tool
+class_name CreateVariableButton
+extends MarginContainer
+
+signal create_variable(var_name: String, var_type: String)
+
+@onready var _confirmation_dialog := %ConfirmationDialog
+@onready var _variable_input := %VariableInput
+@onready var _type_option := %TypeOption
+
+const available_types = ["STRING", "BOOL", "INT", "FLOAT", "VECTOR2", "COLOR"]
+
+
+func _ready():
+	_type_option.clear()
+
+	for type in available_types:
+		_type_option.add_item(type)
+
+
+func _on_create_button_pressed():
+	_confirmation_dialog.visible = true
+
+
+func _clear():
+	_variable_input.text = ""
+	_type_option.select(0)
+
+
+func _on_confirmation_dialog_confirmed():
+	if _variable_input.text != "":
+		create_variable.emit(_variable_input.text, _type_option.get_item_text(_type_option.selected))
+	_clear()
+
+
+func _on_confirmation_dialog_canceled():
+	_clear()

addons/block_code/ui/picker/categories/variable_category/create_variable_button.tscn

@@ -0,0 +1,53 @@
+[gd_scene load_steps=2 format=3 uid="uid://t0eoc4ekvjr1"]
+
+[ext_resource type="Script" path="res://addons/block_code/ui/picker/categories/variable_category/create_variable_button.gd" id="1_cw6c3"]
+
+[node name="CreateVariableButton" type="MarginContainer"]
+size_flags_horizontal = 0
+theme_override_constants/margin_bottom = 12
+script = ExtResource("1_cw6c3")
+
+[node name="CreateButton" type="Button" parent="."]
+layout_mode = 2
+text = "Create New Variable"
+
+[node name="ConfirmationDialog" type="ConfirmationDialog" parent="."]
+unique_name_in_owner = true
+title = "Create New Variable"
+initial_position = 1
+size = Vector2i(300, 150)
+ok_button_text = "Create"
+
+[node name="GridContainer" type="GridContainer" parent="ConfirmationDialog"]
+offset_left = 8.0
+offset_top = 8.0
+offset_right = 292.0
+offset_bottom = 101.0
+columns = 2
+
+[node name="Label" type="Label" parent="ConfirmationDialog/GridContainer"]
+layout_mode = 2
+text = "Name "
+
+[node name="VariableInput" type="LineEdit" parent="ConfirmationDialog/GridContainer"]
+unique_name_in_owner = true
+layout_mode = 2
+
+[node name="Label2" type="Label" parent="ConfirmationDialog/GridContainer"]
+layout_mode = 2
+text = "Type "
+
+[node name="TypeOption" type="OptionButton" parent="ConfirmationDialog/GridContainer"]
+unique_name_in_owner = true
+layout_mode = 2
+size_flags_horizontal = 3
+item_count = 2
+selected = 0
+popup/item_0/text = "STRING"
+popup/item_0/id = 0
+popup/item_1/text = "INT"
+popup/item_1/id = 1
+
+[connection signal="pressed" from="CreateButton" to="." method="_on_create_button_pressed"]
+[connection signal="canceled" from="ConfirmationDialog" to="." method="_on_confirmation_dialog_canceled"]
+[connection signal="confirmed" from="ConfirmationDialog" to="." method="_on_confirmation_dialog_confirmed"]

addons/block_code/ui/picker/categories/variable_category/variable_category_display.gd

@@ -0,0 +1,15 @@
+@tool
+class_name VariableCategoryDisplay
+extends BlockCategoryDisplay
+
+signal variable_created(variable: VariableResource)
+
+@onready var variable_blocks := %VariableBlocks
+
+
+func _ready():
+	super()
+
+
+func _on_create_variable(var_name, var_type):
+	variable_created.emit(VariableResource.new(var_name, Types.STRING_TO_VARIANT_TYPE[var_type]))

addons/block_code/ui/picker/categories/variable_category/variable_category_display.tscn

@@ -0,0 +1,22 @@
+[gd_scene load_steps=4 format=3 uid="uid://byne4g2yvdf3"]
+
+[ext_resource type="PackedScene" uid="uid://duhpwtfo3k0sk" path="res://addons/block_code/ui/picker/categories/block_category_display.tscn" id="1_vermd"]
+[ext_resource type="Script" path="res://addons/block_code/ui/picker/categories/variable_category/variable_category_display.gd" id="2_ggvi7"]
+[ext_resource type="PackedScene" uid="uid://t0eoc4ekvjr1" path="res://addons/block_code/ui/picker/categories/variable_category/create_variable_button.tscn" id="3_gjvnq"]
+
+[node name="VariableCategoryDisplay" instance=ExtResource("1_vermd")]
+script = ExtResource("2_ggvi7")
+
+[node name="CreateVariableButton" parent="VBoxContainer" index="1" instance=ExtResource("3_gjvnq")]
+layout_mode = 2
+
+[node name="VariableBlocks" type="VBoxContainer" parent="VBoxContainer" index="2"]
+unique_name_in_owner = true
+layout_mode = 2
+theme_override_constants/separation = 14
+
+[node name="Spacer" type="Control" parent="VBoxContainer" index="3"]
+custom_minimum_size = Vector2(0, 30)
+layout_mode = 2
+
+[connection signal="create_variable" from="VBoxContainer/CreateVariableButton" to="." method="_on_create_variable"]

addons/block_code/ui/picker/picker.gd

@@ -3,12 +3,15 @@ class_name Picker
 extends MarginContainer
 
 signal block_picked(block: Block)
+signal variable_created(variable: VariableResource)
 
 @onready var _block_list := %BlockList
 @onready var _block_scroll := %BlockScroll
 @onready var _category_list := %CategoryList
 @onready var _widget_container := %WidgetContainer
 
+var _variable_category_display: VariableCategoryDisplay = null
+
 
 func bsd_selected(bsd: BlockScriptData):
 	if not bsd:
@@ -33,6 +36,7 @@ func bsd_selected(bsd: BlockScriptData):
 	blocks_to_add.append_array(CategoryFactory.get_inherited_blocks(parent_class))
 
 	init_picker(blocks_to_add, categories_to_add)
+	reload_variables(bsd.variables)
 
 
 func reset_picker():
@@ -58,7 +62,14 @@ func init_picker(extra_blocks: Array[Block] = [], extra_categories: Array[BlockC
 
 		_category_list.add_child(block_category_button)
 
-		var block_category_display := preload("res://addons/block_code/ui/picker/categories/block_category_display.tscn").instantiate()
+		var block_category_display: BlockCategoryDisplay
+		if category.name != "Variables":
+			block_category_display = preload("res://addons/block_code/ui/picker/categories/block_category_display.tscn").instantiate()
+		else:
+			block_category_display = preload("res://addons/block_code/ui/picker/categories/variable_category/variable_category_display.tscn").instantiate()
+			block_category_display.variable_created.connect(func(variable): variable_created.emit(variable))
+			_variable_category_display = block_category_display
+
 		block_category_display.category = category
 
 		_block_list.add_child(block_category_display)
@@ -83,3 +94,13 @@ func _category_selected(category: BlockCategory):
 
 func set_collapsed(collapsed: bool):
 	_widget_container.visible = not collapsed
+
+
+func reload_variables(variables: Array[VariableResource]):
+	if _variable_category_display:
+		for c in _variable_category_display.variable_blocks.get_children():
+			c.queue_free()
+
+		for block in CategoryFactory.get_variable_blocks(variables):
+			_variable_category_display.variable_blocks.add_child(block)
+			block.drag_started.connect(_block_picked)