maxmustermann/godot
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge pull request #22413 from lupoDharkael/array-mesh-docs

Browse source 
Add code example to ArrayMesh class docs
This commit is contained in:
Rémi Verschelde 2018-09-28 10:36:36 +02:00 committed by GitHub
parent c7e646c30a 9b85866c07
commit f87fb2c795
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
doc/classes/ArrayMesh.xml
View file

@ -3,6 +3,23 @@
<brief_description>
</brief_description>
<description>
The [code]ArrayMesh[/code] is used to construct a [Mesh] by specifying the attributes as arrays. The most basic example is the creation of a single triangle
[codeblock]
var vertices = PoolVector3Array()
vertices.push_back(Vector3(0,1,0))
vertices.push_back(Vector3(1,0,0))
vertices.push_back(Vector3(0,0,1))
# Initialize the ArrayMesh.
var arr_mesh = ArrayMesh.new()
var arrays = []
arrays.resize(ArrayMesh.ARRAY_MAX)
arrays[ArrayMesh.ARRAY_VERTEX] = vertices
# Create the Mesh.
arr_mesh.add_surface_from_arrays(Mesh.PRIMITIVE_TRIANGLES, arrays)
var m = MeshInstance.new()
m.mesh = arr_mesh
[/codeblock]
The [code]MeshInstance[/code] is ready to be added to the SceneTree to be shown.
</description>
<tutorials>
</tutorials>