summaryrefslogtreecommitdiff
path: root/doc/classes/CallbackTweener.xml
blob: 626405bc8e14303b4ee3cc040018fa105d9e1318 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
<?xml version="1.0" encoding="UTF-8" ?>
<class name="CallbackTweener" inherits="Tweener" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Calls the specified method after optional delay.
	</brief_description>
	<description>
		[CallbackTweener] is used to call a method in a tweening sequence. See [method Tween.tween_callback] for more usage information.
		[b]Note:[/b] [method Tween.tween_callback] is the only correct way to create [CallbackTweener]. Any [CallbackTweener] created manually will not function correctly.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="set_delay">
			<return type="CallbackTweener" />
			<param index="0" name="delay" type="float" />
			<description>
				Makes the callback call delayed by given time in seconds.
				[b]Example:[/b]
				[codeblock]
				var tween = get_tree().create_tween()
				tween.tween_callback(queue_free).set_delay(2) #this will call queue_free() after 2 seconds
				[/codeblock]
			</description>
		</method>
	</methods>
</class>