diff options
| author | Malcolm Anderson <malcolminyo@gmail.com> | 2024-11-07 20:15:41 -0800 |
|---|---|---|
| committer | Malcolm Anderson <malcolminyo@gmail.com> | 2024-11-10 09:51:57 -0800 |
| commit | ae9f2bd9dfdf42ae3b7677922c8e83c18481dd34 (patch) | |
| tree | f2e88506d3207d83fc99ef320ce4ae6b0e85a4b9 | |
| parent | 36e6207bb48fafd43b98a458d0c461ad982b4e68 (diff) | |
| download | redot-engine-ae9f2bd9dfdf42ae3b7677922c8e83c18481dd34.tar.gz | |
Add note to `CanvasItem.clip_children` about nesting
Add CanvasGroup information to clipping note
| -rw-r--r-- | doc/classes/CanvasItem.xml | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index 78e9c392db..95cbc55049 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -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. |