-
-
Notifications
You must be signed in to change notification settings - Fork 3.5k
Clarify that EditorScript can only run using the internal script editor #8623
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.
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
Conversation
|
I honestly didn't even know you could open C# scripts into the internal script editor. I tried but now I realize I had the editor setting 'Use External Editor' checked so I essentially never saw the internal editor, and there was no entry point for me to run the EditorScript. I guess the larger issue here is that there is no entry point to run an EditorScript for people using an eternal script editor. And regardless of that UX overlook (good for an issue on the engine itself I guess) this fact is not in the documentation whatsoever. Will think about how to put that in the docs now. |
|
This is a problem for GDScript-based EditorScripts as well. I want us to have a way to trigger any of the scripts from anywhere in the editor. This would also automatically resolve your issue, since you wouldn't need to open the script to run it. Although with C# you need to make sure to build the solution first, of course. |
4fb2c37 to
0f6e4e0
Compare
|
This is still a bit of an awkward PR, because the underlying feature is awkward. Should I close this? |
The awkwardness of the underlying feature may be improved by godotengine/godot#99318. In the meantime, I don't mind this PR, though it does now need a rebase. |
0f6e4e0 to
3d87a07
Compare
|
@tetrapod00 rebase done! |
tetrapod00
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems good to document this limitation, IMO. This will need a second opinion from another maintainer, since as you noted this is a bit of an awkward PR.
I left an optional suggestion to (subjectively) clarify the note a bit.
Co-authored-by: tetrapod <[email protected]>
|
Applied tetrapod's suggestion |
|
Thanks! |

Unless there's some hidden functionality somewhere, the docs state incorrectly that you can run an C# EditorScript even though there is no File > Run for C# scripts.
Edit: found that both C# and GDScript scripts can run, but only using the internal editor. This PR adds a note about that to the docs.