Parcourir la source

Improve the `SurfaceTool.generate_normals()` documentation

(cherry picked from commit b8df8b10435114ec068c8164f8711e0a1d14709b)
Hugo Locurcio il y a 4 ans
Parent
commit
2261e738c2
1 fichiers modifiés avec 2 ajouts et 2 suppressions
  1. 2 2
      doc/classes/SurfaceTool.xml

+ 2 - 2
doc/classes/SurfaceTool.xml

@@ -218,8 +218,8 @@
 			<argument index="0" name="flip" type="bool" default="false">
 			</argument>
 			<description>
-				Generates normals from vertices so you do not have to do it manually. If [code]flip[/code] is [code]true[/code], the resulting normals will be inverted.
-				Requires the primitive type to be set to [constant Mesh.PRIMITIVE_TRIANGLES].
+				Generates normals from vertices so you do not have to do it manually. If [code]flip[/code] is [code]true[/code], the resulting normals will be inverted. [method generate_normals] should be called [i]after[/i] generating geometry and [i]before[/i] committing the mesh using [method commit] or [method commit_to_arrays].
+				[b]Note:[/b] [method generate_normals] only works if the primitive type to be set to [constant Mesh.PRIMITIVE_TRIANGLES].
 			</description>
 		</method>
 		<method name="generate_tangents">