tutorials/plugins/running_code_in_the_editor

[giscus[bot]]

tutorials/plugins/running_code_in_the_editor

What is@tool?:@tool is a powerful line of code that, when added at the top of your script, makes it execute in the editor. You can also decide which parts of the script execute in the editor, which...

https://docs.godotengine.org/en/stable/tutorials/plugins/running_code_in_the_editor.html

[jstraceski]

It would be super helpful if there were some lines explaining why or why not breakpoints in @tool scripts are generally supported/ unsupported. If they are supported (i would assume by an external editor) then some steps on how to turn them on would be greatly appreciated.

[Calinou]

Pull request opened:

• Mention the lack of debugger support in Running code in the editor godot-docs#10889

[lamdevhs]

Here's another use case where you need @tool that I just found out about: if your editor plugin tries to read a static variable from a static class, you'll get unless the static class is marked with @tool.

I think it should be documented, because static methods can be called without issues from editor plugins, but as soon as you try to read a static variable it all goes to hell without any warning.

[Calinou]

Pull request opened:

• Clarify rules around which scripts require @tool in Running code in the editor godot-docs#10888

[FrankFloydus]

In the "Editing variables" section I think there's a small typo in the code example. In the script we declare
private float _speed = 1; but in the _Process what is used is Rotation += Mathf.Pi * (float)delta * speed; (speed instead of _speed).

[Calinou]

Pull request opened:

• Fix typo in C# example in Running code in the editor godot-docs#10887

[sisko91]

Got caught on _Process() not getting run until reloading the scene. godotengine/godot#25275 explains "set_process() is called internally inside ready, so there is no way to enable it without reloading the scene" as _Ready() wont be rerun automatically

Some additional context around "You may need to restart the editor. This is a known bug found in all Godot 4 versions: GH-66381." may be useful - the linked issue seems to apply to a specific problem, but it seems there are other problems the warning covers as well

[JeeeJeee]

I really do feel that there should be a prominent link here to the several C# gotchas when using Tool scripts.
The issue by ershen over here godotengine/godot#102455 is currently more vital documentation than most things on this page I feel.

[JeeeJeee]

I can't edit my previous post but the linked issue was wrong. I meant this one godotengine/godot-proposals#9001

[stupiddude1234568909]

I don't know how to make a pull request but it would be cool if there was a section dedicated to making better ui in the editor with tool scripts, like making a "limited" bool that adds a integer field to the editor so you can define the limit of something.

[Calinou]

Please open an issue on https://github.com/godotengine/godot-docs/issues to suggest improvements to the documentation.

[harrison-munitz]

This EditorScript note makes no sense:

EditorScripts can only be run from the Godot script editor. If you are using an external editor, open the script inside the Godot script editor to run it.

When you are using an external editor, it is impossible to open a script in the Godot script editor. Attempting to do so just opens the script in your external editor.

Only recently was the ability to run EditorScripts from the file-system or command palette added, and it's fully impossible to run EditorScripts in earlier versions of Godot with an external editor enabled.

[Calinou]

Pull request opened:

• Mention other ways to run an EditorScript in Running code in the editor godot-docs#11513