Skip to content
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

Improve Scene Tree editor performance #99700

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions doc/classes/Node.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1068,6 +1068,11 @@
Emitted when the node's editor description field changed.
</description>
</signal>
<signal name="editor_state_changed">
<description>
Emitted when field relevant to the editor changed. Only emitted in the editor, to update the scene tree.
Copy link
Contributor

@Mickeon Mickeon Dec 2, 2024

Choose a reason for hiding this comment

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

Once this is finalized, and if this signal would still exist... this is not good. We need to be more specific. For now:

Suggested change
Emitted when field relevant to the editor changed. Only emitted in the editor, to update the scene tree.
Emitted when an attribute of the node that is relevant to the editor is changed. Only emitted in the editor.

Copy link
Member Author

Choose a reason for hiding this comment

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

I re-used the wording from : tree_process_mode_changed() Emitted when the Node.process_mode of any node inside the tree is changed. Only emitted in the editor, to update the visibility of disabled nodes.

Should we change that one too then?

Copy link
Contributor

Choose a reason for hiding this comment

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

I don't see why the class reference would have to tell the reader this. Nowhere is "to update the visibility of disabled nodes" something they can reach through scripting, hence it's none of their business. So yeah?

Copy link
Member Author

Choose a reason for hiding this comment

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

Alright, I won't update that in this PR, but either you and me and do a PR to fix up that little bit of doc then!

</description>
</signal>
<signal name="ready">
<description>
Emitted when the node is considered ready, after [method _ready] is called.
Expand Down
6 changes: 6 additions & 0 deletions doc/classes/TreeItem.xml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,12 @@
Calls the [param method] on the actual TreeItem and its children recursively. Pass parameters as a comma separated list.
</description>
</method>
<method name="clear_buttons">
<return type="void" />
<description>
Removes all buttons from all columns of this item.
</description>
</method>
<method name="clear_custom_bg_color">
<return type="void" />
<param index="0" name="column" type="int" />
Expand Down
Loading