浏览代码

Clarify limit_length() for infinite vectors

kobewi 9 月之前
父节点
当前提交
3aebcaf4d3
共有 2 个文件被更改,包括 2 次插入2 次删除
  1. 1 1
      doc/classes/Vector2.xml
  2. 1 1
      doc/classes/Vector3.xml

+ 1 - 1
doc/classes/Vector2.xml

@@ -270,7 +270,7 @@
 			<return type="Vector2" />
 			<param index="0" name="length" type="float" default="1.0" />
 			<description>
-				Returns the vector with a maximum length by limiting its length to [param length].
+				Returns the vector with a maximum length by limiting its length to [param length]. If the vector is non-finite, the result is undefined.
 			</description>
 		</method>
 		<method name="max" qualifiers="const">

+ 1 - 1
doc/classes/Vector3.xml

@@ -239,7 +239,7 @@
 			<return type="Vector3" />
 			<param index="0" name="length" type="float" default="1.0" />
 			<description>
-				Returns the vector with a maximum length by limiting its length to [param length].
+				Returns the vector with a maximum length by limiting its length to [param length]. If the vector is non-finite, the result is undefined.
 			</description>
 		</method>
 		<method name="max" qualifiers="const">