Clarify rules around which scripts require @tool in Running code in the editor
#10888
+28
−6
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
Calinou
commented
Apr 22, 2025
Calinou
commented
- Mention that static methods work, but not static variables.
- Emphasize the use of version control due to the lack of undo/redo.
- See tutorials/plugins/running_code_in_the_editor godot-docs-user-notes#400 (comment).
Calinou
added
enhancement
area:manual
… the editor - Mention that static methods work, but not static variables. - Emphasize the use of version control due to the lack of undo/redo.
Calinou
force-pushed
the
running-code-in-the-editor-static-context
branch
from
3ad2eaa to
ab7c43c
Compare
mhilbrunner
reviewed
Apr 22, 2025
| files without ``@tool``, which means you cannot call methods or reference member | ||
| variables from them otherwise. However, since static methods, constants and | ||
| enums can be used without creating an instance, it is possible to call them or | ||
| reference them from a ``@tool`` script onto other non-tool scripts. One exception to |
There was a problem hiding this comment.
Is onto instead of on here what is commonly used in the docs?
mhilbrunner
approved these changes
Apr 22, 2025
dalexeev
approved these changes
Apr 28, 2025
| this are :ref:`static variables <doc_gdscript_basics_static_variables>`. | ||
| If you try to read a static variable's value in a script that does not have | ||
| ``@tool``, it will always return ``null`` but won't print a warning or error | ||
| when doing so. This restriction does not apply to static methods, which can be |
There was a problem hiding this comment.
Note that static functions can access static variables. Although this is stated above, this exception can be a bit confusing. Is there any way we can clarify this without making the documentation even more complicated? Maybe like this:
Suggested change
| when doing so. This restriction does not apply to static methods, which can be | |
| when doing so. This restriction does not apply to pure static methods, which can be |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.