summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorMartin Norling <norlingjr@gmail.com>2021-11-15 21:33:08 +0100
committerRĂ©mi Verschelde <rverschelde@gmail.com>2022-08-01 09:46:58 +0200
commitcab107d063e2803ca954a8b3c52acbf00b7fb8cc (patch)
treee15dfece36709dd8ca3b667d16a8261f80f78ebe /doc/classes
parentbeb8fd5e8be048e608014e663dd182a73ad54000 (diff)
docs: Caveats of NavigationMesh.create_from_mesh
Adds a note explaining the requirements of the given [Mesh] when converting a [Mesh] to a [NavigationMesh] using `NavigationMesh.create_from_mesh`.
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/NavigationMesh.xml1
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/classes/NavigationMesh.xml b/doc/classes/NavigationMesh.xml
index 966f964b12..33d2535ca2 100644
--- a/doc/classes/NavigationMesh.xml
+++ b/doc/classes/NavigationMesh.xml
@@ -28,6 +28,7 @@
<argument index="0" name="mesh" type="Mesh" />
<description>
Initializes the navigation mesh by setting the vertices and indices according to a [Mesh].
+ [b]Note:[/b] The given [code]mesh[/code] must be of type [constant Mesh.PRIMITIVE_TRIANGLES] and have an index array.
</description>
</method>
<method name="get_collision_mask_value" qualifiers="const">