diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2019-01-18 12:32:23 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-01-18 12:32:23 +0100 |
| commit | 7ae4cb7f7dc9913f6b1c7e9c9ff90a481ce93ba7 (patch) | |
| tree | bc5d4c7cf37175c167069937c478096413dbd971 /doc | |
| parent | 6384dd8f2ca80b47e3b7d426906ec5a8bb2c93da (diff) | |
| parent | d024979e84155a745f56d239f8b87c49c8b067bf (diff) | |
Merge pull request #25093 from akien-mga/lerp-returns-variant
GDScript: Fix return value of "lerp" builtin
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/@GDScript.xml | 7 | ||||
| -rw-r--r-- | doc/classes/Shape2D.xml | 4 |
2 files changed, 7 insertions, 4 deletions
diff --git a/doc/classes/@GDScript.xml b/doc/classes/@GDScript.xml index 601b1385ae..072eec800f 100644 --- a/doc/classes/@GDScript.xml +++ b/doc/classes/@GDScript.xml @@ -539,7 +539,7 @@ </description> </method> <method name="lerp"> - <return type="float"> + <return type="Variant"> </return> <argument index="0" name="from" type="Variant"> </argument> @@ -549,8 +549,11 @@ </argument> <description> Linearly interpolates between two values by a normalized value. + If the [code]from[/code] and [code]to[/code] arguments are of type [int] or [float], the return value is a [float]. + If both are of the same vector type ([Vector2], [Vector3] or [Color]), the return value will be of the same type ([code]lerp[/code] then calls the vector type's [code]linear_interpolate[/code] method). [codeblock] - lerp(1, 3, 0.5) # returns 2 + lerp(0, 4, 0.75) # returns 3.0 + lerp(Vector2(1, 5), Vector2(3, 2), 0.5) # returns Vector2(2, 3.5) [/codeblock] </description> </method> diff --git a/doc/classes/Shape2D.xml b/doc/classes/Shape2D.xml index 96b8a77d9e..fc773faf5e 100644 --- a/doc/classes/Shape2D.xml +++ b/doc/classes/Shape2D.xml @@ -27,7 +27,7 @@ </description> </method> <method name="collide_and_get_contacts"> - <return type="Variant"> + <return type="Array"> </return> <argument index="0" name="local_xform" type="Transform2D"> </argument> @@ -59,7 +59,7 @@ </description> </method> <method name="collide_with_motion_and_get_contacts"> - <return type="Variant"> + <return type="Array"> </return> <argument index="0" name="local_xform" type="Transform2D"> </argument> |