aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRémi Verschelde2016-03-01 08:33:43 +0100
committerRémi Verschelde2016-03-01 08:38:23 +0100
commit459b914d9cfc1207e5eff967bfa1808e2079e421 (patch)
tree888c4fdae79d7d7fb077ac23685dcb7d695b6f02
parent9ed3d21d5a3f0c5bad70b9a24d0fd2be8b6e81e8 (diff)
downloadgodot-459b914d9cfc1207e5eff967bfa1808e2079e421.tar.gz
godot-459b914d9cfc1207e5eff967bfa1808e2079e421.tar.zst
godot-459b914d9cfc1207e5eff967bfa1808e2079e421.zip
Quick fixes to tween documentation formatting
Maybe the reST parser should be improved instead though ;) (cherry picked from commit a12c63ef9e6332d0003228e1d8d79a57ef3995fb)
-rw-r--r--doc/base/classes.xml14
1 files changed, 2 insertions, 12 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml
index 5bb2e5c52..a5ab5cb89 100644
--- a/doc/base/classes.xml
+++ b/doc/base/classes.xml
@@ -37977,17 +37977,13 @@ This method controls whether the position between two cached points is interpola
</brief_description>
<description>
Node useful for animations with unknown start and end points, procedural animations, making one node follow another, and other simple behavior.
-
Because it is easy to get it wrong, here is a quick usage example:
-
[codeblock]
var tween = get_node("Tween")
tween.interpolate_property(get_node("Node2D_to_move"), "transform/pos", Vector2(0,0), Vector2(100,100), Tween.TRANS_LINEAR, Tween.EASE_IN_OUT)
tween.start()
[/codeblock]
-
Some of the methods of this class require a property name. You can get the property name by hovering over the property in the inspector of the editor.
-
Many of the methods accept [code]trans_type[/code] and [code]ease_type[/code]. The first accepts an TRANS_* constant, and refers to the way the timing of the animation is handled (you might want to see [code]http://easings.net/[/code] for some examples). The second accepts an EASE_* constant, and controls the where [code]trans_type[/code] is applied to the interpolation (in the begining, the end, or both). If you don't know which transision and easing to pick, you can try different TRANS_* constants with EASE_IN_OUT, and use the one that looks best.
</description>
<methods>
@@ -38169,8 +38165,7 @@ This method controls whether the position between two cached points is interpola
<argument index="7" name="delay" type="float" default="0">
</argument>
<description>
- Animate [code]property[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] seconds later.
-
+ Animate [code]property[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] seconds later.
[code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description.
</description>
</method>
@@ -38195,7 +38190,6 @@ This method controls whether the position between two cached points is interpola
</argument>
<description>
Animate [code]method[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecuitive values.
-
[code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description.
</description>
</method>
@@ -38268,7 +38262,6 @@ This method controls whether the position between two cached points is interpola
</argument>
<description>
Follow [code]property[/code] of [code]object[/code] and apply it on [code]target_property[/code] of [code]target[/code], beginning from [code]initial_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] seconds later. Note that [code]target:target_property[/code] would equal [code]object:property[/code] at the end of the tween.
-
[code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description.
</description>
</method>
@@ -38295,7 +38288,6 @@ This method controls whether the position between two cached points is interpola
</argument>
<description>
Follow [code]method[/code] of [code]object[/code] and apply the returned value on [code]target_method[/code] of [code]target[/code], beginning from [code]initial_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] later. Methods are animated by calling them with consequitive values.
-
[code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description.
</description>
</method>
@@ -38321,8 +38313,7 @@ This method controls whether the position between two cached points is interpola
<argument index="8" name="delay" type="float" default="0">
</argument>
<description>
- Animate [code]property[/code] of [code]object[/code] from the current value of the [code]initial_val[/code] property of [code]initial[/code] to [code]final_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] seconds later.
-
+ Animate [code]property[/code] of [code]object[/code] from the current value of the [code]initial_val[/code] property of [code]initial[/code] to [code]final_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] seconds later.
[code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description.
</description>
</method>
@@ -38349,7 +38340,6 @@ This method controls whether the position between two cached points is interpola
</argument>
<description>
Animate [code]method[/code] of [code]object[/code] from the value returned by [code]initial.initial_method[/code] to [code]final_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecuitive values.
-
[code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description.
</description>
</method>