godotengine / godotengine/godot-docs

CanvasModulate documentation does not describe what happens if there are multiple instances but only 1 has visible set to true

Open
#8,651 1 comment 0 reactions 0 assignees View on GitHub
area:class reference discussion enhancement
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

**Your Godot version:**
v4.2.1.stable.official [b09f793f5]

**Issue description:**
The CanvasModulate docs state: "Only one can be used to tint a canvas, but CanvasLayers can be used to render things independently." This limitation is reflected in the engine; if you add more than one in the same CanvasLayer, you get a warning. The warning says which one is active is undefined if there's more than 1. However, if you make all but 1 CanvasModulate node invisible, the warning goes away, and the behaviour is predictable (i.e., the expected colour is applied).

Therefore, the warning and the docs are incomplete. They need to be updated to describe what happens when there are multiple nodes, specifically, what happens when all but 1 are visible=false.

**URL to the documentation page (if already existing):**
https://docs.godotengine.org/en/stable/classes/class_canvasmodulate.html

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.