NEWS
COMMUNITY
STORE
LABS
ROKOJORI
NEWSLETTER
SIGN UPLOGIN
LOGOUTNEWS
COMMUNITY
STORE
LABS
CanvasItem-derived nodes that are direct or indirect children of a CanvasLayer will be drawn in that layer. The layer is a numeric index that defines the draw order. The default 2D scene renders with index 0, so a CanvasLayer with index -1 will be drawn below, and a CanvasLayer with index 1 will be drawn above. This order will hold regardless of the CanvasItem.z_index of the nodes within each layer.
CanvasLayers can be hidden and they can also optionally follow the viewport. This makes them useful for HUDs like health bar overlays (on layers 1 and higher) or backgrounds (on layers -1 and lower).
Emitted when visibility of the layer is changed. See visible.
The custom Viewport node assigned to the CanvasLayer. If null, uses the default viewport instead.
If enabled, the CanvasLayer will use the viewport's transform, so it will move when camera moves instead of being anchored in a fixed position on the screen.
Together with follow_viewport_scale it can be used for a pseudo 3D effect.
Scales the layer when using follow_viewport_enabled. Layers moving into the foreground should have increasing scales, while layers moving into the background should have decreasing scales.
Layer index for draw order. Lower values are drawn behind higher values.
Note: If multiple CanvasLayers have the same layer index, CanvasItem children of one CanvasLayer are drawn behind the CanvasItem children of the other CanvasLayer. Which CanvasLayer is drawn in front is non-deterministic.
The layer's base offset.
The layer's rotation in radians.
The layer's scale.
The layer's transform.
If false, any CanvasItem under this CanvasLayer will be hidden.
Unlike CanvasItem.visible, visibility of a CanvasLayer isn't propagated to underlying layers.
Returns the RID of the canvas used by this layer.
Returns the transform from the CanvasLayers coordinate system to the Viewports coordinate system.
Hides any CanvasItem under this CanvasLayer. This is equivalent to setting visible to false.
Shows any CanvasItem under this CanvasLayer. This is equivalent to setting visible to true.
