Skip to content

Mention other ways to run an EditorScript in Running code in the editor #11513

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Calinou wants to merge 1 commit into
base: master
Choose a base branch
from
+12 −5
Open

Mention other ways to run an EditorScript in Running code in the editor #11513

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions tutorials/plugins/running_code_in_the_editor.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -530,14 +530,21 @@ EditorScripts, with a ``_run()`` method already inserted:
This ``_run()`` method is executed when you use **File > Run** or the keyboard
shortcut :kbd:`Ctrl + Shift + X` while the EditorScript is the currently open
script in the script editor. This keyboard shortcut is only effective when
currently focused on the script editor.
currently focused on the script editor. If using an external script editor, then
you must use one of the approaches described below to run the EditorScript.

Scripts that extend EditorScript must be ``@tool`` scripts to function.
There are two other ways to run an EditorScript:

.. note::
- If the script has a ``class_name`` set at the top, it will appear in the command palette.
Press :kbd:`Ctrl + Shift + P` (:kbd:`Cmd + Shift + P` on macOS) to bring up
the command palette, then enter the class name. The script will appear under
the Editor Scripts category. The class name is automatically capitalized,
Copy link
Member

@AThousandShips AThousandShips Dec 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The automatic capitalization is a bit confusing as the capitalization of the example doesn't change, a space is inserted though, I think this can be clarified further (and make it clear what happens for a class like add_foliage

which means a class such as ``AddFoliage`` will appear
as :menu:`Add Foliage`.
- Right-click the script in the FileSystem dock and choose the :menu:`Run` option.
This option only appears on scripts that inherit from EditorScript.

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.
Scripts that extend EditorScript must be ``@tool`` scripts to function.

.. danger::

Expand Down