Cannot customize DebugToggleKey2D/3D due to incorrect setting access (missing "Key", doesn't support modifier)

[hsandt]

I'm using F11 and F12 for something else in my game so I needed to change the customizable shortcuts mentioned in #11

• addons/RuntimeDebugTools/DebugToggleKey3D
• addons/RuntimeDebugTools/DebugToggleKey3D

so I rebound them to Shift+F7 and Shift+F8

However, they were not recognized. I found two mistakes in the code of res://addons/runtime_debug_tools/scripts/debugger_runtime.gd causing this:

1. The code tries to access project setting "DebugToggle2D" instead of "DebugToggleKey2D" (as set in plugin.gd with add_project_keybinding("DebugToggleKey3D", "F12"), etc.)
2. The code only checks keycode instead of get_keycode_with_modifiers(). For 3D check more below, it repeats the same mistake.

My fix diff looks like this:

var key_2d = ProjectSettings.get_setting("addons/RuntimeDebugTools/DebugToggle2D")
=>
var key_2d = ProjectSettings.get_setting("addons/RuntimeDebugTools/DebugToggleKey2D")

var key_3d = ProjectSettings.get_setting("addons/RuntimeDebugTools/DebugToggle3D")
=>
var key_3d = ProjectSettings.get_setting("addons/RuntimeDebugTools/DebugToggleKey3D")

if key_event.keycode == _debug_key_3d or key_event.keycode == _debug_key_2d:
=>
if key_event.get_keycode_with_modifiers() == _debug_key_3d or key_event.get_keycode_with_modifiers() == _debug_key_2d:

var is_3d := key_event.keycode == _debug_key_3d
=>
var is_3d := key_event.get_keycode_with_modifiers() == _debug_key_3d

Although I would personally store the keycode with modifiers to avoid getting it several times.

[hsandt]

Note: ultimately we'll want native editor settings input mapping / shortcut, see https://docs.godotengine.org/en/stable/classes/class_editorsettings.html#class-editorsettings-method-add-shortcut

to benefit from the Input Map interface (listen to input or select it in list instead of typing the modifier + keycode as a string which is error-prone).

Note: It was added in Godot 4.6 so it could be done but dropping support for Godot 4.5.

[bbbscarter]

A query.

This package was originally written for Godot 4.2/4.3. Given Godot 4.4+ has native runtime debugging tools, I'm curious what your use-case is?

[hsandt]

This package was originally written for Godot 4.2/4.3. Given Godot 4.4+ has native runtime debugging tools, I'm curious what your use-case is?

An interesting question, I wrote this in my notes:

Advantage of Runtime Debug Tools for Godot over native Embedded Game View 2D/3D node selector view

Most of the time, it will actually select the visible item under the cursor. It won't select irrelevant control nodes that cover the whole screen like the native debugger, see this discussion: godotengine/godot-proposals#12225

It will still select some invisible nodes (but it's as annoying as Controls covering big areas of the screen).

Disadvantages compared to native debugging

It is still a bit unstable and will only highlight said object briefly in Remote Tree instead of selecting it permanently to display it in the Inspector, so you have to click on it yourself again.

So I was mostly experimenting with it for quick, pragmatic debugging. If you say it's not officially supported for Godot 4.4+, I will eventually revert to native debugging using the Alt+Click trick to select any node below the cursor, but if the thing works and can save me some time I'll keep using it in cases where it's advantageous.

[bbbscarter]

Oh, if it's useful, feel free to use it - I'm just not using it myself at the moment. And agreed, the built-in picking stuff is imperfect, so it's nice to have an alternative.

Happy to take PRs if you have them!