summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2023-06-14 09:27:57 +0200
committerRémi Verschelde <rverschelde@gmail.com>2023-06-14 09:27:57 +0200
commita2575cba48121a9e31c3a550ebd29398a7facf3f (patch)
tree67ac369684a0cc44039795eb0eb7f5957b028fc7 /doc
parent754a52a4ab2e9c65c1e6789aa1e6a3f9047396c9 (diff)
parent09767d5749502b3c011d528e5225768e512985ef (diff)
downloadredot-engine-a2575cba48121a9e31c3a550ebd29398a7facf3f.tar.gz
Merge pull request #78212 from timothyqiu/move-towards
Clarify `move_towards` does not go past final value
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/@GlobalScope.xml3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml
index 2bf43be39d..57094bfdd2 100644
--- a/doc/classes/@GlobalScope.xml
+++ b/doc/classes/@GlobalScope.xml
@@ -725,11 +725,12 @@
<param index="1" name="to" type="float" />
<param index="2" name="delta" type="float" />
<description>
- Moves [param from] toward [param to] by the [param delta] value.
+ Moves [param from] toward [param to] by the [param delta] amount. Will not go past [param to].
Use a negative [param delta] value to move away.
[codeblock]
move_toward(5, 10, 4) # Returns 9
move_toward(10, 5, 4) # Returns 6
+ move_toward(5, 10, 9) # Returns 10
move_toward(10, 5, -1.5) # Returns 11.5
[/codeblock]
</description>