How to set breakpoints in tool scripts when running editor with command line debugger?

system · September 16, 2019, 9:01pm


	Attention	Topic was automatically imported from the old Question2Answer platform.
	Asked By	goshot

Per this discussion between reduz and Zylann:

github.com/godotengine/godot

Improve tool script debugging

opened 12:53AM - 31 Jul 16 UTC

Zylann

enhancement topic:editor usability

I am currently developping a GDScript editor plugin, and just like developping a… game, I make mistakes and am getting countless errors, yay! But the problem here is that I only get the error and the line where it occurred. I am currently spending a lot of time trying to figure out a bug happening everytime I use Ctrl+S that makes the editor hang for 30 seconds (it was 5 minutes when it first occurred!). Because I edit the tool in the editor, it is becoming a PITA to debug. Godot even froze at some point but not a clue what happened. It would be a great improvement if we could get the call stack of tool script errors, because mine just tells `invalid index in get_value(x,y)`, which can happen in a lot of different ways, so I'm screwed to the point I have to print everywhere (making the test even longer!), erase stuff and wait for a while everytime just to find the culprit code path. FYI: the bug was caused by https://github.com/godotengine/godot/issues/5984

It should be possible to debug tool scripts running in the editor.

This provides an example of debugging a scene running outside the editor with the -d flag:

However, it doesn’t stop to allow the addition of breakpoints before the scene starts executing.

We can start the editor editing the scene like this:

godot -d -e my.tscn

However, that also loads the editor immediately without stopping to allow breakpoint entry and does not recognize any breakpoints set on scripts in the editor visually, which are lost when the editor closes.

I’m curious myself how to even do this. I guess it exists buried in the source code but having it documented would be nice.

Zylann | 2019-09-16 21:36

I have found that if you put an assert(false) in the code, the command line debugger will stop there and you can continue from there. However, it seems buggy as the debugger than starts stopping at breakpoints that you have not created either with the command line debugger or in the editor itself.

goshot | 2019-09-18 17:54