summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHaoyu Qiu <timothyqiu32@gmail.com>2023-06-14 11:36:20 +0800
committerHaoyu Qiu <timothyqiu32@gmail.com>2023-06-14 11:36:20 +0800
commit09767d5749502b3c011d528e5225768e512985ef (patch)
treed7c7bf2c315d718b01e7363386ba5907d2856055
parenteb86dabee07e8dfce3b06cbd557b50b74afd3d6c (diff)
downloadredot-engine-09767d5749502b3c011d528e5225768e512985ef.tar.gz
Clarify move_towards does not go past final value
-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>