Skip to content

Commit a2575cb

Browse files
committed
Merge pull request #78212 from timothyqiu/move-towards
Clarify `move_towards` does not go past final value
2 parents 754a52a + 09767d5 commit a2575cb

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

doc/classes/@GlobalScope.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -725,11 +725,12 @@
725725
<param index="1" name="to" type="float" />
726726
<param index="2" name="delta" type="float" />
727727
<description>
728-
Moves [param from] toward [param to] by the [param delta] value.
728+
Moves [param from] toward [param to] by the [param delta] amount. Will not go past [param to].
729729
Use a negative [param delta] value to move away.
730730
[codeblock]
731731
move_toward(5, 10, 4) # Returns 9
732732
move_toward(10, 5, 4) # Returns 6
733+
move_toward(5, 10, 9) # Returns 10
733734
move_toward(10, 5, -1.5) # Returns 11.5
734735
[/codeblock]
735736
</description>

0 commit comments

Comments
 (0)