Godot: Grid Container description should say it only works with Control based nodes, not with Node2D based nodes.

Created on 31 Aug 2020  路  3Comments  路  Source: godotengine/godot

Your Godot version: 3.2.2, latest , stable

Issue description:
"Grid container used to arrange elements in a grid like layout."
"Grid container will arrange its children in a grid like structure,"
"GridContainer reorders its children to accommodate the new layout."

"children" or "elements" is not true, it won't work with any Node2D nodes like Sprites, KinematicBody2Ds or regular Node2Ds.

URL to the documentation page:
https://docs.godotengine.org/en/stable/classes/class_gridcontainer.html

documentation junior job

Most helpful comment

It's about the class reference so transferring to this repo, where the class reference is.

I think it's fair to specify Control children or child Control nodes. It wouldn't bloat the reference to have it here and there, and it makes the docs more explicit.

All 3 comments

This doesn't seem necessary. It's a Control node, I wouldn't expect it to work with Node2D nodes.

This sounds more of a beginner's issue and hence should be pointed out rather in a paragraph in the introductionary pages about nodes to not bloat the class reference with obvious facts.

It's about the class reference so transferring to this repo, where the class reference is.

I think it's fair to specify Control children or child Control nodes. It wouldn't bloat the reference to have it here and there, and it makes the docs more explicit.

Was this page helpful?
0 / 5 - 0 ratings