Skip to content

Commit

Permalink
Add note to CanvasItem.clip_children about nesting
Browse files Browse the repository at this point in the history
Add CanvasGroup information to clipping note
  • Loading branch information
Meorge committed Nov 10, 2024
1 parent 36e6207 commit ae9f2bd
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions doc/classes/CanvasItem.xml
Original file line number Diff line number Diff line change
Expand Up @@ -594,6 +594,7 @@
<members>
<member name="clip_children" type="int" setter="set_clip_children_mode" getter="get_clip_children_mode" enum="CanvasItem.ClipChildrenMode" default="0">
Allows the current node to clip child nodes, essentially acting as a mask.
[b]Note:[/b] Clipping nodes cannot be nested or placed within [CanvasGroup]s. If an ancestor of this node clips its children or is a [CanvasGroup], then this node's clip mode should be set to [constant CLIP_CHILDREN_DISABLED] to avoid unexpected behavior.
</member>
<member name="light_mask" type="int" setter="set_light_mask" getter="get_light_mask" default="1">
The rendering layers in which this [CanvasItem] responds to [Light2D] nodes.
Expand Down

0 comments on commit ae9f2bd

Please sign in to comment.