2

Description

"Have you ever created a new exported variable, like that:\r\n```\r\n@export var audio_player: AudioStreamPlayer\r\n```\r\nThen wrote a function that gets called very late into the game, like that:\r\n```\r\nfunc _on_player_won() -> void:\r\n\taudio_player.play()\r\n```\r\nJust to see an error message, like that:\r\n> Cannot call method 'play' on a null value.\r\n\r\nBecause you forgot to assign the reference to your exported variable?\r\n\r\nFear not, because this snippet saves you from all of that hassle. Just put this into the ready() function of your Node\r\n```\r\nfunc _ready() -> void:\r\n\tDebugger.assert_all_exported_properties(self)\r\n```\r\nAnd if you forgot to assign the reference to any of your exported variables on that Node, it will trigger an error right when the `_ready()` is called, not when the faulty variable is called. It will point to the missing property and location of the source Node in the SceneTree.\r\n> Assertion failed: -\"audio_player\"- property on node: -\"\/root\/GameManager\"- is missing assignment\r\n\r\nIt uses [@GlobalScope PropertyUsageFlags](https:\/\/docs.godotengine.org\/en\/stable\/classes\/class_@globalscope.html#enum-globalscope-propertyusageflags) to evaluate which properties to assert.\r\nCombination of `PROPERTY_USAGE_SCRIPT_VARIABLE | PROPERTY_USAGE_EDITOR | PROPERTY_USAGE_STORAGE` flags is an exported variable.\r\n\r\nHere's some more example usage:\r\n```\r\n## some_class.gd\r\nclass_name SomeClass\r\n\r\n@export var exported_property_node: Node\r\n@export var exported_property_packed_scene: PackedScene\r\n@export var exported_property_bool: bool\r\nvar not_exported_property_node: Node\r\nvar not_exported_property_packed_scene: PackedScene\r\nvar not_exported_property_bool: bool\r\n\r\nfunc _ready() -> void:\r\n\tDebugger.assert_all_exported_properties(self)\r\n```\r\n\r\nThis call will check the 3 exported properties of type: `Node`, `PackedScene` and `bool`.\r\nIf the `Node` or `PackedScene` properties have not been assigned in the editor, it will run into an error and pause the editor. `bool` is always assigned either `true` or `false`, so it won't raise an error.\r\n\r\nIt's not perfect, but is very easy and should be plug-and-play for most projects.\r\nIt has saved me already so many hours during testing, I hope it will serve you just as well!"

Main code

## debugger.gd
class_name Debugger

## This function checks all exported properties of a Node to see if there are any unassigned in the editor.
## If there are unassigned properties, it will run into an error and pause the editor.
static func assert_all_exported_properties(node: Node) -> void:
	var script: Script = node.get_script()
	var property_list: Array[Dictionary] = script.get_script_property_list()
	for property: Dictionary in property_list:
		if property.usage == PROPERTY_USAGE_SCRIPT_VARIABLE | PROPERTY_USAGE_EDITOR | PROPERTY_USAGE_STORAGE:
			var error_message: String = "-\"%s\"- property on node: -\"%s\"- is missing assignment"
			var property_name: String = property.name
			var property_value: Variant = node.get(property_name)
			assert(property_value != null, error_message % [property.name, str(node.get_path())])

Comments