Browse Source

Documentation: Added Vector2.clampLength and Vector3.clampLength

Mugen87 9 years ago
parent
commit
a10b8f781b
2 changed files with 20 additions and 0 deletions
  1. 10 0
      docs/api/math/Vector2.html
  2. 10 0
      docs/api/math/Vector3.html

+ 10 - 0
docs/api/math/Vector2.html

@@ -171,6 +171,16 @@
 		If this vector's x or y values are less than the min value, they are replaced by the min value.
 		If this vector's x or y values are less than the min value, they are replaced by the min value.
 		</div>
 		</div>
 
 
+		<h3>[method:Vector2 clampLength]([page:Float min], [page:Float max]) [page:Vector2 this]</h3>
+		<div>
+		min -- [page:Float] the minimum value the length will be clamped to <br />
+		max -- [page:Float] the maximum value the length will be clamped to
+		</div>
+		<div>
+		If this vector's length is greater than the max value, it is replaced by the max value. <br /><br />
+		If this vector's length is less than the min value, it is replaced by the min value.
+		</div>
+
 		<h3>[method:Vector2 floor]()</h3>
 		<h3>[method:Vector2 floor]()</h3>
 		<div>
 		<div>
 		The components of the vector are rounded downwards (towards negative infinity) to an integer value.
 		The components of the vector are rounded downwards (towards negative infinity) to an integer value.

+ 10 - 0
docs/api/math/Vector3.html

@@ -206,6 +206,16 @@
 		If this vector's x, y or z values are less than the min value, they are replaced by the min value.
 		If this vector's x, y or z values are less than the min value, they are replaced by the min value.
 		</div>
 		</div>
 
 
+		<h3>[method:Vector3 clampLength]([page:Float min], [page:Float max]) [page:Vector3 this]</h3>
+		<div>
+		min -- [page:Float] the minimum value the length will be clamped to <br />
+		max -- [page:Float] the maximum value the length will be clamped to
+		</div>
+		<div>
+		If this vector's length is greater than the max value, it is replaced by the max value. <br /><br />
+		If this vector's length is less than the min value, it is replaced by the min value.
+		</div>
+
 		<h3>[method:Vector3 floor]()</h3>
 		<h3>[method:Vector3 floor]()</h3>
 		<div>
 		<div>
 		The components of the vector are rounded downwards (towards negative infinity) to an integer value.
 		The components of the vector are rounded downwards (towards negative infinity) to an integer value.