Add note to CanvasItem.clip_children about nesting
#98948
Merged
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
AThousandShips
added
enhancement
documentation
cherrypick:4.2
AThousandShips
previously approved these changes
Nov 8, 2024
|
Should I expand this note to also indicate that the node cannot have an ancestor CanvasGroup if it is clipping? |
|
I think that would be good |
|
I would recommend to squash your commits, too. See the Pull Request Workflow. |
Meorge
force-pushed
the
docs-clip-children
branch
from
f052312 to
f96c2a4
Compare
Add CanvasGroup information to clipping note
Meorge
force-pushed
the
docs-clip-children
branch
from
f96c2a4 to
ae9f2bd
Compare
mhilbrunner
approved these changes
Nov 11, 2024
|
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.
I ran into an issue over the last few days that I eventually figured out was due to CanvasItems that clipped their children not being able to be nested. This doesn't appear to be noted in the documentation; the closest thing I could find was the page for CanvasGroup implying it.
This PR adds a note to the documentation for
CanvasItem.clip_childrenexplaining that clipping can't be nested, and that children of a clipping node must haveCLIP_CHILDREN_DISABLEDas their clip mode. It appears on the tooltip for the "Clip Children" in the Inspector: