diff --git a/doc/classes/Color.xml b/doc/classes/Color.xml index 546d90fa3c4..7a87c797522 100644 --- a/doc/classes/Color.xml +++ b/doc/classes/Color.xml @@ -306,7 +306,9 @@ - Returns the linear interpolation between this color's components and [param to]'s components. The interpolation factor [param weight] should be between 0.0 and 1.0 (inclusive). See also [method @GlobalScope.lerp]. + Returns the linear interpolation between this color's components and [param to]'s components. + To perform interpolation, [param weight] should be between [code]0.0[/code] and [code]1.0[/code] (inclusive). However, values outside this range are allowed and can be used to perform [i]extrapolation[/i]. If this is not desired, use [method @GlobalScope.clampf] to limit [param weight]. + See also [method @GlobalScope.lerp]. [codeblocks] [gdscript] var red = Color(1.0, 0.0, 0.0) diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml index bdc908d3877..16277520176 100644 --- a/doc/classes/Transform2D.xml +++ b/doc/classes/Transform2D.xml @@ -145,7 +145,8 @@ Returns the result of the linear interpolation between this transform and [param xform] by the given [param weight]. - The [param weight] should be between [code]0.0[/code] and [code]1.0[/code] (inclusive). Values outside this range are allowed and can be used to perform [i]extrapolation[/i] instead. + To perform interpolation, [param weight] should be between [code]0.0[/code] and [code]1.0[/code] (inclusive). However, values outside this range are allowed and can be used to perform [i]extrapolation[/i]. If this is not desired, use [method @GlobalScope.clampf] to limit [param weight]. + See also [method @GlobalScope.lerp]. diff --git a/doc/classes/Transform3D.xml b/doc/classes/Transform3D.xml index 702509b054a..de5b33c4967 100644 --- a/doc/classes/Transform3D.xml +++ b/doc/classes/Transform3D.xml @@ -72,7 +72,8 @@ Returns the result of the linear interpolation between this transform and [param xform] by the given [param weight]. - The [param weight] should be between [code]0.0[/code] and [code]1.0[/code] (inclusive). Values outside this range are allowed and can be used to perform [i]extrapolation[/i] instead. + To perform interpolation, [param weight] should be between [code]0.0[/code] and [code]1.0[/code] (inclusive). However, values outside this range are allowed and can be used to perform [i]extrapolation[/i]. If this is not desired, use [method @GlobalScope.clampf] to limit [param weight]. + See also [method @GlobalScope.lerp]. diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index c03262bb33b..93c617fa85d 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -263,7 +263,9 @@ - Returns the result of the linear interpolation between this vector and [param to] by amount [param weight]. [param weight] is on the range of [code]0.0[/code] to [code]1.0[/code], representing the amount of interpolation. + Returns the result of the linear interpolation between this vector and [param to] by amount [param weight]. + To perform interpolation, [param weight] should be between [code]0.0[/code] and [code]1.0[/code] (inclusive). However, values outside this range are allowed and can be used to perform [i]extrapolation[/i]. If this is not desired, use [method @GlobalScope.clampf] to limit [param weight]. + See also [method @GlobalScope.lerp]. diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index 4ab3140eb63..93383ff7975 100644 --- a/doc/classes/Vector3.xml +++ b/doc/classes/Vector3.xml @@ -232,7 +232,9 @@ - Returns the result of the linear interpolation between this vector and [param to] by amount [param weight]. [param weight] is on the range of [code]0.0[/code] to [code]1.0[/code], representing the amount of interpolation. + Returns the result of the linear interpolation between this vector and [param to] by amount [param weight]. + To perform interpolation, [param weight] should be between [code]0.0[/code] and [code]1.0[/code] (inclusive). However, values outside this range are allowed and can be used to perform [i]extrapolation[/i]. If this is not desired, use [method @GlobalScope.clampf] to limit [param weight]. + See also [method @GlobalScope.lerp]. diff --git a/doc/classes/Vector4.xml b/doc/classes/Vector4.xml index 8fa17b57e6c..ca7f2da4145 100644 --- a/doc/classes/Vector4.xml +++ b/doc/classes/Vector4.xml @@ -181,7 +181,9 @@ - Returns the result of the linear interpolation between this vector and [param to] by amount [param weight]. [param weight] is on the range of [code]0.0[/code] to [code]1.0[/code], representing the amount of interpolation. + Returns the result of the linear interpolation between this vector and [param to] by amount [param weight]. + To perform interpolation, [param weight] should be between [code]0.0[/code] and [code]1.0[/code] (inclusive). However, values outside this range are allowed and can be used to perform [i]extrapolation[/i]. If this is not desired, use [method @GlobalScope.clampf] to limit [param weight]. + See also [method @GlobalScope.lerp].