Small suggestion for the Astar2d documentation

Godot Version

4.5

Question

Hi everyone ! Sorry if it's not the right place to create this topic, that's the first time I suggest a modification for the documentation. I read the Contributing to the class reference section of contributing.godotengine.org but I have to admit I am kinda overwhelmed.

I’m trying to implement the Astar2DGrid in my game. In the doc, I was surprised not to find a method to retrieve the grid x and y coordinates of a cell, only its id and position. After several rereadings, I realized that the cell id actually IS a vector2i with grid x and y coordinates.

I find it misleading to call this vector2i an id. To me an id is a numerical value like 9823, not (24, 35)

Suggestion

Add a sentence in description that explain that cell id actually refers to the grid coodinates of the cell

What’s your thoughs about this ?

You can open a PR to have it changed in the Documentation, check my comment here about it:

Or you can also just simply leave a comment in the Notes section at the bottom of the page.

1 Like

Thank you !