Rename EditorInterface.get_editor_main_control to get_editor_main_screen
#65449
Conversation
This file contains 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
YuriSizov
force-pushed
the
editor-main-control-screen-container-node
branch
from
3e92d87
to
8ab5ba2
Compare
aaronfranke
reviewed
Sep 6, 2022
YuriSizov
force-pushed
the
editor-main-control-screen-container-node
branch
from
8ab5ba2
to
1459507
Compare
|
Done. Now the exact type is specified both internally and in the public API. |
aaronfranke
approved these changes
Sep 7, 2022
| main_control->add_theme_constant_override("separation", 0); | ||
| scene_root_parent->add_child(main_control); | ||
| main_screen_vbox = memnew(VBoxContainer); | ||
| main_screen_vbox->set_name("MainScreen"); |
There was a problem hiding this comment.
Just wanted to say that I greatly appreciate giving editor nodes readable names 👍
akien-mga
approved these changes
Sep 7, 2022
|
Thanks! |
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.
So this rename, #44524, was a bad idea. The new name implies that this method returns some kind of main editor control, when in reality all it does is returns the control (or rather a
VBoxContainercontainer) for hosting main screen plugins and tools.The rename refers to the documentation statements, but the documentation is actually incorrect and very misleading. The rename also refers to the old rename tracker where this was brought up, but in that tracker the name
main_controlwas never suggested. The options weremain_containerandmain_screen, with the latter being the consensus.So this PR re-renames the method to
get_editor_main_screen, which is by far a better and more accurate name, with which both @Zylann and @aaronfranke agree. This name also matches the term we use in theEditorPluginAPI. It also fixes the docs. And it fixes the conversion tool rule which was set up for a completely wrong method. I've also named the node for ease of debugging the editor.PS. Tutorials in the online documentation also need updating, since the code there has been updated for 4.0 already (godotengine/godot-docs#5064).