godotengine / godotengine/godot-docs
Clarify the format of the arrays passed into SurfaceTool.create_from_arrays()
- Dominant language
- reStructuredText
- Stars
- 5.7k
- Forks
- 3.8k
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 25
Description
**Your Godot version:** 4.3
**Issue description:** The format of the arrays passed to [`SurfaceTool.create_from_arrays()`](https://docs.godotengine.org/en/stable/classes/class_surfacetool.html#class-surfacetool-method-create-from-arrays) is unclear on this page and many other pages on related functions. Barely any of the functions linked in this function's documentation explain the format either and just link to other functions and going in loops of links isn't ideal. As far as I can tell, the only documentation for this array format is under [`ImporterMesh.add_surface()`](https://docs.godotengine.org/en/stable/classes/class_importermesh.html#class-importermesh-method-add-surface) and it is also pretty hard to understand as it is not dedicated solely to the arrays format. Perhaps there should be a section or a page dedicated to explaining this format with examples (such as those in [the "Using the ArrayMesh" tutorial](https://docs.godotengine.org/en/stable/tutorials/3d/procedural_geometry/arraymesh.html#setting-up-the-arraymesh)) as well that all these functions can reference?
**URL to the documentation page (if already existing):** https://docs.godotengine.org/en/stable/classes/class_surfacetool.html#class-surfacetool-method-create-from-arrays
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.