summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorkobewi <kobewi4e@gmail.com>2022-03-22 17:39:01 +0100
committerkobewi <kobewi4e@gmail.com>2022-03-29 13:34:05 +0200
commite04ae8c8bcabfd5f9e66544090f9921bfc15e0ad (patch)
tree331b98c1ae24446edf7be68aa1ca1d79b0d54b84 /doc
parenta30d17fe23cab95716e4b1bff9dfac21b70b5481 (diff)
Add get_total_elapsed_time() to Tween
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/Tween.xml7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/classes/Tween.xml b/doc/classes/Tween.xml
index 2c152410ce..72f32f39c2 100644
--- a/doc/classes/Tween.xml
+++ b/doc/classes/Tween.xml
@@ -72,6 +72,13 @@
[b]Note:[/b] The [Tween] will become invalid after finished, but you can call [method stop] after the step, to keep it and reset.
</description>
</method>
+ <method name="get_total_elapsed_time" qualifiers="const">
+ <return type="float" />
+ <description>
+ Returns the total time in seconds the [Tween] has been animating (i.e. time since it started, not counting pauses etc.). The time is affected by [method set_speed_scale] and [method stop] will reset it to [code]0[/code].
+ [b]Note:[/code] As it results from accumulating frame deltas, the time returned after the [Tween] has finished animating will be slightly greater than the actual [Tween] duration.
+ </description>
+ </method>
<method name="interpolate_value">
<return type="Variant" />
<argument index="0" name="initial_value" type="Variant" />