-
-
Notifications
You must be signed in to change notification settings - Fork 21.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Backport the new Tween system as SceneTreeTween
Co-authored-by: Tomasz Chabora <kobewi4e@gmail.com>
- Loading branch information
1 parent
036f36b
commit 153dc4d
Showing
25 changed files
with
2,221 additions
and
351 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
<?xml version="1.0" encoding="UTF-8" ?> | ||
<class name="CallbackTweener" inherits="Tweener" version="3.5" 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 SceneTreeTween.tween_callback] for more usage information. | ||
[b]Note:[/b] [method SceneTreeTween.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> | ||
<constants> | ||
</constants> | ||
</class> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
<?xml version="1.0" encoding="UTF-8" ?> | ||
<class name="IntervalTweener" inherits="Tweener" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> | ||
<brief_description> | ||
Creates an idle interval in a [SceneTreeTween] animation. | ||
</brief_description> | ||
<description> | ||
[IntervalTweener] is used to make delays in a tweening sequence. See [method SceneTreeTween.tween_interval] for more usage information. | ||
[b]Note:[/b] [method SceneTreeTween.tween_interval] is the only correct way to create [IntervalTweener]. Any [IntervalTweener] created manually will not function correctly. | ||
</description> | ||
<tutorials> | ||
</tutorials> | ||
<methods> | ||
</methods> | ||
<constants> | ||
</constants> | ||
</class> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
<?xml version="1.0" encoding="UTF-8" ?> | ||
<class name="MethodTweener" inherits="Tweener" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> | ||
<brief_description> | ||
Interpolates an abstract value and supplies it to a method called over time. | ||
</brief_description> | ||
<description> | ||
[MethodTweener] is similar to a combination of [CallbackTweener] and [PropertyTweener]. It calls a method providing an interpolated value as a parameter. See [method SceneTreeTween.tween_method] for more usage information. | ||
[b]Note:[/b] [method SceneTreeTween.tween_method] is the only correct way to create [MethodTweener]. Any [MethodTweener] created manually will not function correctly. | ||
</description> | ||
<tutorials> | ||
</tutorials> | ||
<methods> | ||
<method name="set_delay"> | ||
<return type="MethodTweener" /> | ||
<argument index="0" name="delay" type="float" /> | ||
<description> | ||
Sets the time in seconds after which the [MethodTweener] will start interpolating. By default there's no delay. | ||
</description> | ||
</method> | ||
<method name="set_ease"> | ||
<return type="MethodTweener" /> | ||
<argument index="0" name="ease" type="int" enum="Tween.EaseType" /> | ||
<description> | ||
Sets the type of used easing from [enum Tween.EaseType]. If not set, the default easing is used from the [SceneTreeTween] that contains this Tweener. | ||
</description> | ||
</method> | ||
<method name="set_trans"> | ||
<return type="MethodTweener" /> | ||
<argument index="0" name="trans" type="int" enum="Tween.TransitionType" /> | ||
<description> | ||
Sets the type of used transition from [enum Tween.TransitionType]. If not set, the default transition is used from the [SceneTreeTween] that contains this Tweener. | ||
</description> | ||
</method> | ||
</methods> | ||
<constants> | ||
</constants> | ||
</class> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
<?xml version="1.0" encoding="UTF-8" ?> | ||
<class name="PropertyTweener" inherits="Tweener" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> | ||
<brief_description> | ||
Interpolates an [Object]'s property over time. | ||
</brief_description> | ||
<description> | ||
[PropertyTweener] is used to interpolate a property in an object. See [method SceneTreeTween.tween_property] for more usage information. | ||
[b]Note:[/b] [method SceneTreeTween.tween_property] is the only correct way to create [PropertyTweener]. Any [PropertyTweener] created manually will not function correctly. | ||
</description> | ||
<tutorials> | ||
</tutorials> | ||
<methods> | ||
<method name="as_relative"> | ||
<return type="PropertyTweener" /> | ||
<description> | ||
When called, the final value will be used as a relative value instead. Example: | ||
[codeblock] | ||
var tween = get_tree().create_tween() | ||
tween.tween_property(self, "position", Vector2.RIGHT * 100, 1).as_relative() #the node will move by 100 pixels to the right | ||
[/codeblock] | ||
</description> | ||
</method> | ||
<method name="from"> | ||
<return type="PropertyTweener" /> | ||
<argument index="0" name="value" type="Variant" /> | ||
<description> | ||
Sets a custom initial value to the [PropertyTweener]. Example: | ||
[codeblock] | ||
var tween = get_tree().create_tween() | ||
tween.tween_property(self, "position", Vector2(200, 100), 1).from(Vector2(100, 100) #this will move the node from position (100, 100) to (200, 100) | ||
[/codeblock] | ||
</description> | ||
</method> | ||
<method name="from_current"> | ||
<return type="PropertyTweener" /> | ||
<description> | ||
Makes the [PropertyTweener] use the current property value (i.e. at the time of creating this [PropertyTweener]) as a starting point. This is equivalent of using [method from] with the current value. These two calls will do the same: | ||
[codeblock] | ||
tween.tween_property(self, "position", Vector2(200, 100), 1).from(position) | ||
tween.tween_property(self, "position", Vector2(200, 100), 1).from_current() | ||
[/codeblock] | ||
</description> | ||
</method> | ||
<method name="set_delay"> | ||
<return type="PropertyTweener" /> | ||
<argument index="0" name="delay" type="float" /> | ||
<description> | ||
Sets the time in seconds after which the [PropertyTweener] will start interpolating. By default there's no delay. | ||
</description> | ||
</method> | ||
<method name="set_ease"> | ||
<return type="PropertyTweener" /> | ||
<argument index="0" name="ease" type="int" enum="Tween.EaseType" /> | ||
<description> | ||
Sets the type of used easing from [enum Tween.EaseType]. If not set, the default easing is used from the [Tween] that contains this Tweener. | ||
</description> | ||
</method> | ||
<method name="set_trans"> | ||
<return type="PropertyTweener" /> | ||
<argument index="0" name="trans" type="int" enum="Tween.TransitionType" /> | ||
<description> | ||
Sets the type of used transition from [enum Tween.TransitionType]. If not set, the default transition is used from the [Tween] that contains this Tweener. | ||
</description> | ||
</method> | ||
</methods> | ||
<constants> | ||
</constants> | ||
</class> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.