Remove class_name from all other internal scripts

manuq · dbnicholson · commit f3cbacb3b4f8 · 2024-07-23T14:57:36.000-06:00
Except for:
- The resources: they must be classes
- Block and subclasses: they are accessed by class using the ClassDB
- SnapPoint: there is an "is SnapPoint" check
- the CategoryFactory (bug in Godot 4.2.1)

With this, the class is not registered by name in ClassDB and it can't
be referenced directly in other scripts, it must be preloaded. Also, if
the script extends Node or a subclass of Node, it won't appear in the UI
to the end user when adding a node.

Another advantage: it won't collide with classes defined by the end user
in the project. Our current Types class has a good chance to conflict
given the generic name.

Also: delete PackedSceneTreeNode and PackedScene abandoned
resources.
diff --git a/addons/block_code/block_code_plugin.gd b/addons/block_code/block_code_plugin.gd
@@ -1,8 +1,9 @@
 @tool
-class_name BlockCodePlugin
 extends EditorPlugin
+const MainPanelScene := preload("res://addons/block_code/ui/main_panel.tscn")
+const MainPanel = preload("res://addons/block_code/ui/main_panel.gd")
+const Types = preload("res://addons/block_code/types/types.gd")
 
-const MainPanel := preload("res://addons/block_code/ui/main_panel.tscn")
 static var main_panel: MainPanel
 static var block_code_button: Button
 
@@ -18,8 +19,6 @@ var old_feature_profile: String = ""
 
 const DISABLED_CLASSES := [
 	"BlockScriptData",
-	"InstructionTree",
-	"Types",
 	"Block",
 	"ControlBlock",
 	"ParameterBlock",
@@ -28,19 +27,7 @@ const DISABLED_CLASSES := [
 	"SerializedBlockTreeNodeArray",
 	"SerializedBlockTreeNode",
 	"SerializedBlock",
-	"PackedSceneTreeNodeArray",
-	"PackedSceneTreeNode",
-	"BlockCanvas",
 	"CategoryFactory",
-	"BlockCategoryDisplay",
-	"BlockCategory",
-	"Picker",
-	"TitleBar",
-	"MainPanel",
-	"BlockCodePlugin",
-	"BlockCategoryButton",
-	"CreateVariableButton",
-	"VariableCategoryDisplay"
 ]
 
 
@@ -50,7 +37,7 @@ func _enter_tree():
 	editor_inspector = EditorInterface.get_inspector()
 	editor_selection = EditorInterface.get_selection()
 
-	main_panel = MainPanel.instantiate()
+	main_panel = MainPanelScene.instantiate()
 	main_panel.undo_redo = get_undo_redo()
 	block_code_button = add_control_to_bottom_panel(main_panel, _get_plugin_name())
 	block_inspector_plugin = BlockInspectorPlugin.new()
diff --git a/addons/block_code/drag_manager/drag.gd b/addons/block_code/drag_manager/drag.gd
@@ -1,8 +1,10 @@
 @tool
 extends Control
 
+const BlockCanvas = preload("res://addons/block_code/ui/block_canvas/block_canvas.gd")
 const Constants = preload("res://addons/block_code/ui/constants.gd")
 const DragManager = preload("res://addons/block_code/drag_manager/drag_manager.gd")
+const Types = preload("res://addons/block_code/types/types.gd")
 
 enum DragAction { NONE, PLACE, REMOVE }
 
diff --git a/addons/block_code/drag_manager/drag_manager.gd b/addons/block_code/drag_manager/drag_manager.gd
@@ -4,7 +4,9 @@ extends Control
 signal block_dropped
 signal block_modified
 
+const BlockCanvas = preload("res://addons/block_code/ui/block_canvas/block_canvas.gd")
 const Drag = preload("res://addons/block_code/drag_manager/drag.gd")
+const Picker = preload("res://addons/block_code/ui/picker/picker.gd")
 
 @export var picker_path: NodePath
 @export var block_canvas_path: NodePath
diff --git a/addons/block_code/inspector_plugin/block_script_inspector.gd b/addons/block_code/inspector_plugin/block_script_inspector.gd
@@ -1,5 +1,7 @@
 extends EditorInspectorPlugin
 
+const BlockCodePlugin = preload("res://addons/block_code/block_code_plugin.gd")
+
 
 func _can_handle(object):
 	return object is BlockCode
diff --git a/addons/block_code/instruction_tree/instruction_tree.gd b/addons/block_code/instruction_tree/instruction_tree.gd
@@ -1,4 +1,3 @@
-class_name InstructionTree
 extends Object
 
 
@@ -99,7 +98,7 @@ static func _generate_script_from_entry_blocks(entry_statement: String, entry_bl
 	var signal_node: TreeNode
 	var is_empty = true
 
-	InstructionTree.IDHandler.reset()
+	IDHandler.reset()
 
 	for entry_block in entry_blocks:
 		var next_block := entry_block.bottom_snap.get_snapped_block()
diff --git a/addons/block_code/simple_nodes/simple_character/simple_character.gd b/addons/block_code/simple_nodes/simple_character/simple_character.gd
@@ -2,6 +2,9 @@
 class_name SimpleCharacter
 extends CharacterBody2D
 
+const CategoryFactory = preload("res://addons/block_code/ui/picker/categories/category_factory.gd")
+const Types = preload("res://addons/block_code/types/types.gd")
+
 @export var texture: Texture2D:
 	set = _set_texture
 
diff --git a/addons/block_code/simple_nodes/simple_scoring/simple_scoring.gd b/addons/block_code/simple_nodes/simple_scoring/simple_scoring.gd
@@ -2,6 +2,9 @@
 class_name SimpleScoring
 extends CanvasLayer
 
+const CategoryFactory = preload("res://addons/block_code/ui/picker/categories/category_factory.gd")
+const Types = preload("res://addons/block_code/types/types.gd")
+
 @export var score_left: int:
 	set = _set_score_left
 
diff --git a/addons/block_code/types/types.gd b/addons/block_code/types/types.gd
@@ -1,4 +1,3 @@
-class_name Types
 extends Node
 
 enum BlockType {
diff --git a/addons/block_code/ui/block_canvas/block_canvas.gd b/addons/block_code/ui/block_canvas/block_canvas.gd
@@ -1,8 +1,9 @@
 @tool
-class_name BlockCanvas
 extends MarginContainer
 
+const BlockCodePlugin = preload("res://addons/block_code/block_code_plugin.gd")
 const DragManager = preload("res://addons/block_code/drag_manager/drag_manager.gd")
+const InstructionTree = preload("res://addons/block_code/instruction_tree/instruction_tree.gd")
 const Util = preload("res://addons/block_code/ui/util.gd")
 
 const EXTEND_MARGIN: float = 800
diff --git a/addons/block_code/ui/block_canvas/packed_scene_tree_node.gd b/addons/block_code/ui/block_canvas/packed_scene_tree_node.gd
diff --git a/addons/block_code/ui/block_canvas/packed_scene_tree_node_array.gd b/addons/block_code/ui/block_canvas/packed_scene_tree_node_array.gd
diff --git a/addons/block_code/ui/blocks/block/block.gd b/addons/block_code/ui/blocks/block/block.gd
@@ -2,6 +2,9 @@
 class_name Block
 extends MarginContainer
 
+const InstructionTree = preload("res://addons/block_code/instruction_tree/instruction_tree.gd")
+const Types = preload("res://addons/block_code/types/types.gd")
+
 signal drag_started(block: Block)
 signal modified
 
diff --git a/addons/block_code/ui/blocks/statement_block/statement_block.gd b/addons/block_code/ui/blocks/statement_block/statement_block.gd
@@ -2,6 +2,9 @@
 class_name StatementBlock
 extends Block
 
+const ParameterInput = preload("res://addons/block_code/ui/blocks/utilities/parameter_input/parameter_input.gd")
+const ParameterInputScene = preload("res://addons/block_code/ui/blocks/utilities/parameter_input/parameter_input.tscn")
+
 @export var block_format: String = ""
 @export var statement: String = ""
 @export var defaults: Dictionary = {}
@@ -130,7 +133,7 @@ static func format_string(parent_block: Block, attach_to: Node, string: String,
 			parameter_output.block = parent_block
 			attach_to.add_child(parameter_output)
 		else:
-			var parameter_input: ParameterInput = preload("res://addons/block_code/ui/blocks/utilities/parameter_input/parameter_input.tscn").instantiate()
+			var parameter_input: ParameterInput = ParameterInputScene.instantiate()
 			parameter_input.name = "ParameterInput%d" % start  # Unique path
 			parameter_input.placeholder = param_name
 			if param_type != null:
diff --git a/addons/block_code/ui/blocks/utilities/parameter_input/parameter_input.gd b/addons/block_code/ui/blocks/utilities/parameter_input/parameter_input.gd
@@ -1,7 +1,8 @@
 @tool
-class_name ParameterInput
 extends MarginContainer
 
+const Types = preload("res://addons/block_code/types/types.gd")
+
 signal modified
 
 @export var placeholder: String = "Parameter":
diff --git a/addons/block_code/ui/blocks/utilities/parameter_output/parameter_output.gd b/addons/block_code/ui/blocks/utilities/parameter_output/parameter_output.gd
@@ -2,6 +2,8 @@
 class_name ParameterOutput
 extends MarginContainer
 
+const Types = preload("res://addons/block_code/types/types.gd")
+
 var block: Block
 var output_block: Block
 
diff --git a/addons/block_code/ui/blocks/utilities/snap_point/snap_point.gd b/addons/block_code/ui/blocks/utilities/snap_point/snap_point.gd
@@ -2,6 +2,8 @@
 class_name SnapPoint
 extends MarginContainer
 
+const Types = preload("res://addons/block_code/types/types.gd")
+
 @export var block_type: Types.BlockType = Types.BlockType.EXECUTE
 
 @export var snapped_block: Block:
diff --git a/addons/block_code/ui/main_panel.gd b/addons/block_code/ui/main_panel.gd
@@ -1,8 +1,11 @@
 @tool
-class_name MainPanel
 extends Control
 
+const BlockCanvas = preload("res://addons/block_code/ui/block_canvas/block_canvas.gd")
+const BlockCodePlugin = preload("res://addons/block_code/block_code_plugin.gd")
 const DragManager = preload("res://addons/block_code/drag_manager/drag_manager.gd")
+const Picker = preload("res://addons/block_code/ui/picker/picker.gd")
+const TitleBar = preload("res://addons/block_code/ui/title_bar/title_bar.gd")
 
 @onready var _picker: Picker = %Picker
 @onready var _block_canvas: BlockCanvas = %BlockCanvas
diff --git a/addons/block_code/ui/picker/categories/block_category.gd b/addons/block_code/ui/picker/categories/block_category.gd
@@ -1,4 +1,3 @@
-class_name BlockCategory
 extends RefCounted
 
 var name: String
diff --git a/addons/block_code/ui/picker/categories/block_category_button.gd b/addons/block_code/ui/picker/categories/block_category_button.gd
@@ -1,7 +1,7 @@
 @tool
-class_name BlockCategoryButton
 extends MarginContainer
 
+const BlockCategory = preload("res://addons/block_code/ui/picker/categories/block_category.gd")
 const Util = preload("res://addons/block_code/ui/util.gd")
 
 signal selected
diff --git a/addons/block_code/ui/picker/categories/block_category_display.gd b/addons/block_code/ui/picker/categories/block_category_display.gd
@@ -1,7 +1,8 @@
 @tool
-class_name BlockCategoryDisplay
 extends MarginContainer
 
+const BlockCategory = preload("res://addons/block_code/ui/picker/categories/block_category.gd")
+
 var category: BlockCategory
 
 @onready var _label := %Label
diff --git a/addons/block_code/ui/picker/categories/category_factory.gd b/addons/block_code/ui/picker/categories/category_factory.gd
@@ -1,6 +1,9 @@
 class_name CategoryFactory
 extends Object
 
+const BlockCategory = preload("res://addons/block_code/ui/picker/categories/block_category.gd")
+const Types = preload("res://addons/block_code/types/types.gd")
+
 const BLOCKS: Dictionary = {
 	"control_block": preload("res://addons/block_code/ui/blocks/control_block/control_block.tscn"),
 	"parameter_block": preload("res://addons/block_code/ui/blocks/parameter_block/parameter_block.tscn"),
diff --git a/addons/block_code/ui/picker/categories/variable_category/create_variable_button.gd b/addons/block_code/ui/picker/categories/variable_category/create_variable_button.gd
@@ -1,5 +1,4 @@
 @tool
-class_name CreateVariableButton
 extends MarginContainer
 
 signal create_variable(var_name: String, var_type: String)
diff --git a/addons/block_code/ui/picker/categories/variable_category/create_variable_dialog.gd b/addons/block_code/ui/picker/categories/variable_category/create_variable_dialog.gd
@@ -1,6 +1,8 @@
 @tool
 extends ConfirmationDialog
 
+const BlockCodePlugin = preload("res://addons/block_code/block_code_plugin.gd")
+
 signal create_variable(var_name: String, var_type: String)
 
 @onready var _variable_input := %VariableInput
diff --git a/addons/block_code/ui/picker/categories/variable_category/variable_category_display.gd b/addons/block_code/ui/picker/categories/variable_category/variable_category_display.gd
@@ -1,6 +1,7 @@
 @tool
-class_name VariableCategoryDisplay
-extends BlockCategoryDisplay
+extends "res://addons/block_code/ui/picker/categories/block_category_display.gd"
+
+const Types = preload("res://addons/block_code/types/types.gd")
 
 signal variable_created(variable: VariableResource)
 
diff --git a/addons/block_code/ui/picker/picker.gd b/addons/block_code/ui/picker/picker.gd
@@ -1,7 +1,13 @@
 @tool
-class_name Picker
 extends MarginContainer
 
+const BlockCategory = preload("res://addons/block_code/ui/picker/categories/block_category.gd")
+const BlockCategoryButtonScene = preload("res://addons/block_code/ui/picker/categories/block_category_button.tscn")
+const BlockCategoryButton = preload("res://addons/block_code/ui/picker/categories/block_category_button.gd")
+const BlockCategoryDisplay = preload("res://addons/block_code/ui/picker/categories/block_category_display.gd")
+const CategoryFactory = preload("res://addons/block_code/ui/picker/categories/category_factory.gd")
+const VariableCategoryDisplay = preload("res://addons/block_code/ui/picker/categories/variable_category/variable_category_display.gd")
+
 signal block_picked(block: Block)
 signal variable_created(variable: VariableResource)
 
@@ -57,7 +63,7 @@ func init_picker(extra_blocks: Array[Block] = [], extra_categories: Array[BlockC
 	for _category in block_categories:
 		var category: BlockCategory = _category as BlockCategory
 
-		var block_category_button: BlockCategoryButton = preload("res://addons/block_code/ui/picker/categories/block_category_button.tscn").instantiate()
+		var block_category_button: BlockCategoryButton = BlockCategoryButtonScene.instantiate()
 		block_category_button.category = category
 		block_category_button.selected.connect(_category_selected)
 
diff --git a/addons/block_code/ui/title_bar/title_bar.gd b/addons/block_code/ui/title_bar/title_bar.gd
@@ -1,7 +1,8 @@
 @tool
-class_name TitleBar
 extends MarginContainer
 
+const BlockCodePlugin = preload("res://addons/block_code/block_code_plugin.gd")
+
 signal node_name_changed(node_name: String)
 
 @onready var _block_code_icon = load("res://addons/block_code/block_code_node/block_code_node.svg") as Texture2D
diff --git a/tests/test_category_factory.gd b/tests/test_category_factory.gd
@@ -1,6 +1,8 @@
 extends GutTest
 ## Tests for CategoryFactory
 
+const BlockCategory = preload("res://addons/block_code/ui/picker/categories/block_category.gd")
+
 
 func free_block_list(blocks: Array[Block]):
 	var block: Block = blocks.pop_back()
diff --git a/tests/test_instruction_tree.gd b/tests/test_instruction_tree.gd
@@ -1,6 +1,9 @@
 extends GutTest
 ## Tests for InstructionTree
 
+const CategoryFactory = preload("res://addons/block_code/ui/picker/categories/category_factory.gd")
+const InstructionTree = preload("res://addons/block_code/instruction_tree/instruction_tree.gd")
+
 var general_blocks: Dictionary
 
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-class_name Types`
`2`	`1`	`extends Node`
`3`	`2`
`4`	`3`	`enum BlockType {`