From cab107d063e2803ca954a8b3c52acbf00b7fb8cc Mon Sep 17 00:00:00 2001
From: Martin Norling <norlingjr@gmail.com>
Date: Mon, 15 Nov 2021 21:33:08 +0100
Subject: 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`.
---
 doc/classes/NavigationMesh.xml | 1 +
 1 file changed, 1 insertion(+)

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">
-- 
cgit v1.2.3