godotengine / godotengine/godot-docs

CanvasItem's visible property documentation is misleading/confusing

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

Description

Godot 4.2

The current description, if read without the context of `is_visible_in_tree()`'s documentation, implies that this is only true if `is_visible_in_tree()` also returns `true`, when it is actually the opposite. The first sentence confuses this with `is_visible_in_tree()`, as the node is not actually drawn unless `is_visible_in_tree()` also returns true. The use of "visible" in the second sentence then implies that `is_visible_in_tree()` is a pre-requesite for this property. I propose changing it to be something more like this:

If `true` this **CanvasItem** could be drawn. It will only actually be drawn if all of it's ancestors are visible as well (in other words, [is_visible_in_tree](https://docs.godotengine.org/en/stable/classes/class_canvasitem.html#class-canvasitem-method-is-visible-in-tree) also returns true)

With the note at the end kept, of course.

[CanvasItem.visible](https://docs.godotengine.org/en/stable/classes/class_canvasitem.html#class-canvasitem-property-visible)

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.