godot icon indicating copy to clipboard operation
godot copied to clipboard
verified publisher icon godotengine

Docs: Clarify `CanvasItem` visibility properties and signals

Open AdriaandeJongh opened this issue 1 year ago • 1 comments

  • Reworded the description of the visible property to emphasize that a CanvasItem is only actually drawn when it and all of its ancestors are visible.
  • Appended this important nuance to the visibility_changed and hidden signals, whose descriptions previously did not mention this precise behavior.

AdriaandeJongh avatar Sep 20 '24 08:09 AdriaandeJongh

Makes sense to clarify this, but I think the ancestor formulation should be changed in some way that excludes Node3D and Ancestors that have a non CanvasItem Node in between. Can't really think of a concise way to say that though. Maybe "CanvasItem ancestors" is sufficient for now 🤷

I believe struggled with this actually in https://github.com/godotengine/godot/pull/93735 . I think the descriptions in this PR are on the right track and far better than currently.

Mickeon avatar Sep 20 '24 15:09 Mickeon

Thanks!

I merged this locally before seeing the last review comments by @kleonc - those should be addressed in a follow-up.

akien-mga avatar Sep 23 '24 14:09 akien-mga

I merged this locally before seeing the last review comments by @kleonc - those should be addressed in a follow-up.

I'll make a new PR, no problem.

AdriaandeJongh avatar Sep 23 '24 14:09 AdriaandeJongh