summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMichael Alexsander Silva Dias <michaelalexsander@protonmail.com>2018-10-02 23:35:59 -0300
committerMichael Alexsander Silva Dias <michaelalexsander@protonmail.com>2018-10-03 13:17:49 -0300
commita02f02b9ed7f65a38170785be2b45983842faa56 (patch)
tree6831111417da8a36a01ac680c06e55e6bb3e7838 /doc
parentf7cb23f9e3d3952869f3d3424854786b600b9c68 (diff)
Add example to Animation doc
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/Animation.xml11
1 files changed, 10 insertions, 1 deletions
diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml
index 74c6796b06..bb161cd87c 100644
--- a/doc/classes/Animation.xml
+++ b/doc/classes/Animation.xml
@@ -5,7 +5,16 @@
</brief_description>
<description>
An Animation resource contains data used to animate everything in the engine. Animations are divided into tracks, and each track must be linked to a node. The state of that node can be changed through time, by adding timed keys (events) to the track.
- Animations are just data containers, and must be added to odes such as an [AnimationPlayer] or [AnimationTreePlayer] to be played back.
+ [codeblock]
+ # This creates an animation that makes the node "Enemy" move to the right by
+ # 100 pixels in 1 second.
+ var animation = Animation.new()
+ var track_index = animation.add_track(Animation.TYPE_VALUE)
+ animation.track_set_path(track_index, "Enemy:position.x")
+ animation.track_insert_key(track_index, 0.0, 0)
+ animation.track_insert_key(track_index, 0.5, 100)
+ [/codeblock]
+ Animations are just data containers, and must be added to nodes such as an [AnimationPlayer] or [AnimationTreePlayer] to be played back.
</description>
<tutorials>
<link>http://docs.godotengine.org/en/3.0/tutorials/animation/index.html</link>