CanvasGroup
Fades, dims or shields a whole subtree at once: one alpha multiplies every colour under it, one flag makes it inert without hiding it, and another swallows clicks meant for whatever is behind it. Goes under a Canvas.
On this page
Add it
+ Add node → Fade Group creates a node with it already on. Already have a node for it? Add component → CanvasGroupComponent.
From a script
A script on the same node writes these fields by name. CanvasGroupComponent is the name to pass.
rgs
set_number("CanvasGroupComponent", "alpha", 1.0);
set_flag("CanvasGroupComponent", "interactable", true);
set_flag("CanvasGroupComponent", "blocks_input", false);
set_flag("CanvasGroupComponent", "ignore_parent_groups", false);Fields
| Field | Script name | Kind | Default | What it does |
|---|---|---|---|---|
| Alpha | alpha | number, 0 to 1, step 0.01 | 1 | Multiplied into every colour the subtree draws. |
| Interactable | interactable | checkbox | on | Whether widgets in the subtree answer pointers and the focus ring. |
| Blocks Input | blocks_input | checkbox | off | Whether this group's box stops pointers reaching what is behind it. |
| Ignore Parent Groups | ignore_parent_groups | checkbox | off | Whether groups above this one are ignored entirely — alpha, dimming and all. |