virtualx-engine/doc/classes/CallbackTweener.xml

<?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" />
			<argument index="0" name="delay" type="float" />
			<description>
				Makes the callback call delayed by given time in seconds. Example:
				[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>
Complete rewrite of Tweens * Tweens were changed from Node to RefCounted. New API is inspired by DOTween. * Tweens are created and managed by SceneTree, similar to SceneTreeTimer, which makes them ultra cheap to use a lot. * Animating with Tweens is done by creating sequences of Tweeners. You create them from code and they autostart by default (fire-and-forget). * There are 4 Tweeners that cover the former Tween functionality: PropertyTweener, IntervalTweener, CallbackTweener and MethodTweener. * The methods were simplified a lot. Long argument lists are replaced with chained calls on Tweens and Tweeners. * Tweeners by default execute in sequence, so it's easy to create complex chained animations. * You can bind a Tween to a node. Tween will be removed automatically when the bound node is freed. 2020-09-05 03:05:30 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions. 2022-02-14 14:18:53 +01:00			`<class name="CallbackTweener" inherits="Tweener" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
Complete rewrite of Tweens * Tweens were changed from Node to RefCounted. New API is inspired by DOTween. * Tweens are created and managed by SceneTree, similar to SceneTreeTimer, which makes them ultra cheap to use a lot. * Animating with Tweens is done by creating sequences of Tweeners. You create them from code and they autostart by default (fire-and-forget). * There are 4 Tweeners that cover the former Tween functionality: PropertyTweener, IntervalTweener, CallbackTweener and MethodTweener. * The methods were simplified a lot. Long argument lists are replaced with chained calls on Tweens and Tweeners. * Tweeners by default execute in sequence, so it's easy to create complex chained animations. * You can bind a Tween to a node. Tween will be removed automatically when the bound node is freed. 2020-09-05 03:05:30 +02:00			`<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">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 15:28:05 +02:00			`<return type="CallbackTweener" />`
			`<argument index="0" name="delay" type="float" />`
Complete rewrite of Tweens * Tweens were changed from Node to RefCounted. New API is inspired by DOTween. * Tweens are created and managed by SceneTree, similar to SceneTreeTimer, which makes them ultra cheap to use a lot. * Animating with Tweens is done by creating sequences of Tweeners. You create them from code and they autostart by default (fire-and-forget). * There are 4 Tweeners that cover the former Tween functionality: PropertyTweener, IntervalTweener, CallbackTweener and MethodTweener. * The methods were simplified a lot. Long argument lists are replaced with chained calls on Tweens and Tweeners. * Tweeners by default execute in sequence, so it's easy to create complex chained animations. * You can bind a Tween to a node. Tween will be removed automatically when the bound node is freed. 2020-09-05 03:05:30 +02:00			`<description>`
			`Makes the callback call delayed by given time in seconds. Example:`
			`[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>`