summaryrefslogtreecommitdiff
path: root/doc/base/classes.xml
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2016-03-01 08:33:43 +0100
committerRémi Verschelde <rverschelde@gmail.com>2016-03-01 08:37:35 +0100
commita12c63ef9e6332d0003228e1d8d79a57ef3995fb (patch)
tree03f11fdb8c06b1f164a681be55281002bf1cf119 /doc/base/classes.xml
parentc0382a1731b2979ad6231720372dc850b2cd4db9 (diff)
Quick fixes to tween documentation formatting
Maybe the reST parser should be improved instead though ;)
Diffstat (limited to 'doc/base/classes.xml')
-rw-r--r--doc/base/classes.xml20
1 files changed, 5 insertions, 15 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml
index 4b623ea590..034fac1136 100644
--- a/doc/base/classes.xml
+++ b/doc/base/classes.xml
@@ -27633,11 +27633,11 @@ This method controls whether the position between two cached points is interpola
<method name="set_range">
<return type="Object">
</return>
- <argument index="0" name="arg1" type="var">
+ <argument index="0" name="arg1" type="Variant">
</argument>
- <argument index="1" name="arg2" type="var" default="NULL">
+ <argument index="1" name="arg2" type="Variant" default="NULL">
</argument>
- <argument index="2" name="arg3" type="var" default="NULL">
+ <argument index="2" name="arg3" type="Variant" default="NULL">
</argument>
<description>
</description>
@@ -38698,17 +38698,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>
@@ -38890,8 +38886,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>
@@ -38916,7 +38911,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>
@@ -38989,7 +38983,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>
@@ -39016,7 +39009,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>
@@ -39042,8 +39034,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>
@@ -39070,7 +39061,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>