Skip to content

Commit 631cab3

Browse files
committed
Added versionchanged note to Vector3.lerp, oops
1 parent 2de394e commit 631cab3

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/reST/ref/math.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -881,12 +881,18 @@ Conversion can be combined with swizzling or slicing to create a new order
881881

882882
| :sl:`returns a linear interpolation to the given vector.`
883883
| :sg:`lerp(Vector3, float, /) -> Vector3`
884+
| :sg:`lerp(Vector3, float, bool, /)`
884885
885886
Returns a Vector which is a linear interpolation between self and the
886887
given Vector. The second parameter determines how far between self an
887888
other the result is going to be. It must be a value between ``0`` and
888889
``1``, where ``0`` means self and ``1`` means other will be returned.
889890

891+
.. versionchanged:: 2.5.7 The ``do_clamp`` parameter is added with a default
892+
value of ``True``. When it's ``True``, the second parameter is limited
893+
to the closed interval ``[0, 1]``. When it's ``False``, the second parameter
894+
is not limited and the lerp will extend beyond the original two vectors.
895+
890896
.. ## Vector3.lerp ##
891897
892898
.. method:: slerp

0 commit comments

Comments
 (0)