summaryrefslogtreecommitdiff
path: root/doc/classes/Animation.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/Animation.xml')
-rw-r--r--doc/classes/Animation.xml53
1 files changed, 43 insertions, 10 deletions
diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml
index 677976f1d3..dd248d18f7 100644
--- a/doc/classes/Animation.xml
+++ b/doc/classes/Animation.xml
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
-<class name="Animation" inherits="Resource" category="Core" version="3.0-alpha">
+<class name="Animation" inherits="Resource" category="Core" version="3.0-beta">
<brief_description>
Contains data used to animate everything in the engine.
</brief_description>
@@ -30,6 +30,17 @@
Clear the animation (clear all tracks and reset all).
</description>
</method>
+ <method name="copy_track">
+ <return type="void">
+ </return>
+ <argument index="0" name="track" type="int">
+ </argument>
+ <argument index="1" name="to_animation" type="Animation">
+ </argument>
+ <description>
+ Adds a new track that is a copy of the given track from [code]to_animation[/code].
+ </description>
+ </method>
<method name="find_track" qualifiers="const">
<return type="int">
</return>
@@ -157,6 +168,7 @@
<argument index="0" name="idx" type="int">
</argument>
<description>
+ Returns [code]true[/code] if the track at [code]idx[/code] wraps the interpolation loop. Default value: [code]true[/code].
</description>
</method>
<method name="track_get_interpolation_type" qualifiers="const">
@@ -243,6 +255,15 @@
Insert a generic key in a given track.
</description>
</method>
+ <method name="track_is_enabled" qualifiers="const">
+ <return type="bool">
+ </return>
+ <argument index="0" name="idx" type="int">
+ </argument>
+ <description>
+ Returns [code]true[/code] if the track at index [code]idx[/code] is enabled.
+ </description>
+ </method>
<method name="track_is_imported" qualifiers="const">
<return type="bool">
</return>
@@ -292,6 +313,17 @@
Remove a key by position (seconds) in a given track.
</description>
</method>
+ <method name="track_set_enabled">
+ <return type="void">
+ </return>
+ <argument index="0" name="idx" type="int">
+ </argument>
+ <argument index="1" name="enabled" type="bool">
+ </argument>
+ <description>
+ Enables/disables the given track. Tracks are enabled by default.
+ </description>
+ </method>
<method name="track_set_imported">
<return type="void">
</return>
@@ -311,6 +343,7 @@
<argument index="1" name="interpolation" type="bool">
</argument>
<description>
+ If [code]true[/code] the track at [code]idx[/code] wraps the interpolation loop.
</description>
</method>
<method name="track_set_interpolation_type">
@@ -424,31 +457,31 @@
</method>
</methods>
<constants>
- <constant name="TYPE_VALUE" value="0">
+ <constant name="TYPE_VALUE" value="0" enum="TrackType">
Value tracks set values in node properties, but only those which can be Interpolated.
</constant>
- <constant name="TYPE_TRANSFORM" value="1">
+ <constant name="TYPE_TRANSFORM" value="1" enum="TrackType">
Transform tracks are used to change node local transforms or skeleton pose bones. Transitions are Interpolated.
</constant>
- <constant name="TYPE_METHOD" value="2">
+ <constant name="TYPE_METHOD" value="2" enum="TrackType">
Method tracks call functions with given arguments per key.
</constant>
- <constant name="INTERPOLATION_NEAREST" value="0">
+ <constant name="INTERPOLATION_NEAREST" value="0" enum="InterpolationType">
No interpolation (nearest value).
</constant>
- <constant name="INTERPOLATION_LINEAR" value="1">
+ <constant name="INTERPOLATION_LINEAR" value="1" enum="InterpolationType">
Linear interpolation.
</constant>
- <constant name="INTERPOLATION_CUBIC" value="2">
+ <constant name="INTERPOLATION_CUBIC" value="2" enum="InterpolationType">
Cubic interpolation.
</constant>
- <constant name="UPDATE_CONTINUOUS" value="0">
+ <constant name="UPDATE_CONTINUOUS" value="0" enum="UpdateMode">
Update between keyframes.
</constant>
- <constant name="UPDATE_DISCRETE" value="1">
+ <constant name="UPDATE_DISCRETE" value="1" enum="UpdateMode">
Update at the keyframes and hold the value.
</constant>
- <constant name="UPDATE_TRIGGER" value="2">
+ <constant name="UPDATE_TRIGGER" value="2" enum="UpdateMode">
Update at the keyframes.
</constant>
</constants>