diff options
Diffstat (limited to 'doc/classes/Animation.xml')
| -rw-r--r-- | doc/classes/Animation.xml | 51 |
1 files changed, 26 insertions, 25 deletions
diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml index c79903cb80..bc64cfbb19 100644 --- a/doc/classes/Animation.xml +++ b/doc/classes/Animation.xml @@ -28,7 +28,7 @@ <argument index="1" name="at_position" type="int" default="-1"> </argument> <description> - Add a track to the Animation. The track type must be specified as any of the values in the TYPE_* enumeration. + Adds a track to the Animation. </description> </method> <method name="animation_track_get_key_animation" qualifiers="const"> @@ -314,7 +314,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Remove a track by specifying the track index. + Removes a track by specifying the track index. </description> </method> <method name="track_find_key" qualifiers="const"> @@ -327,7 +327,7 @@ <argument index="2" name="exact" type="bool" default="false"> </argument> <description> - Find the key index by time in a given track. Optionally, only find it if the exact time is given. + Finds the key index by time in a given track. Optionally, only find it if the exact time is given. </description> </method> <method name="track_get_interpolation_loop_wrap" qualifiers="const"> @@ -336,7 +336,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]. + Returns [code]true[/code] if the track at [code]idx[/code] wraps the interpolation loop. New tracks wrap the interpolation loop by default. </description> </method> <method name="track_get_interpolation_type" qualifiers="const"> @@ -345,7 +345,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns the interpolation type of a given track, from the INTERPOLATION_* enum. + Returns the interpolation type of a given track. </description> </method> <method name="track_get_key_count" qualifiers="const"> @@ -376,7 +376,7 @@ <argument index="1" name="key_idx" type="int"> </argument> <description> - Returns the transition curve (easing) for a specific key (see built-in math function "ease"). + Returns the transition curve (easing) for a specific key (see the built-in math function [method @GDScript.ease]). </description> </method> <method name="track_get_key_value" qualifiers="const"> @@ -396,7 +396,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Get the path of a track. for more information on the path format, see [method track_set_path] + Gets the path of a track. For more information on the path format, see [method track_set_path]. </description> </method> <method name="track_get_type" qualifiers="const"> @@ -405,7 +405,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Get the type of a track. + Gets the type of a track. </description> </method> <method name="track_insert_key"> @@ -447,7 +447,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Move a track down. + Moves a track down. </description> </method> <method name="track_move_to"> @@ -467,7 +467,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Move a track up. + Moves a track up. </description> </method> <method name="track_remove_key"> @@ -478,7 +478,7 @@ <argument index="1" name="key_idx" type="int"> </argument> <description> - Remove a key by index in a given track. + Removes a key by index in a given track. </description> </method> <method name="track_remove_key_at_position"> @@ -489,7 +489,7 @@ <argument index="1" name="position" type="float"> </argument> <description> - Remove a key by position (seconds) in a given track. + Removes a key by position (seconds) in a given track. </description> </method> <method name="track_set_enabled"> @@ -511,7 +511,7 @@ <argument index="1" name="imported" type="bool"> </argument> <description> - Set the given track as imported or not. + Sets the given track as imported or not. </description> </method> <method name="track_set_interpolation_loop_wrap"> @@ -533,7 +533,7 @@ <argument index="1" name="interpolation" type="int" enum="Animation.InterpolationType"> </argument> <description> - Set the interpolation type of a given track, from the INTERPOLATION_* enum. + Sets the interpolation type of a given track. </description> </method> <method name="track_set_key_time"> @@ -546,7 +546,7 @@ <argument index="2" name="time" type="float"> </argument> <description> - Set the time of an existing key. + Sets the time of an existing key. </description> </method> <method name="track_set_key_transition"> @@ -559,7 +559,7 @@ <argument index="2" name="transition" type="float"> </argument> <description> - Set the transition curve (easing) for a specific key (see built-in math function "ease"). + Sets the transition curve (easing) for a specific key (see the built-in math function [method @GDScript.ease]). </description> </method> <method name="track_set_key_value"> @@ -572,7 +572,7 @@ <argument index="2" name="value" type="Variant"> </argument> <description> - Set the value of an existing key. + Sets the value of an existing key. </description> </method> <method name="track_set_path"> @@ -583,8 +583,8 @@ <argument index="1" name="path" type="NodePath"> </argument> <description> - Set the path of a track. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by ":". - [b]Example:[/b] "character/skeleton:ankle" or "character/mesh:transform/local". + Sets the path of a track. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by [code]":"[/code]. + For example, [code]"character/skeleton:ankle"[/code] or [code]"character/mesh:transform/local"[/code]. </description> </method> <method name="track_swap"> @@ -656,18 +656,19 @@ <argument index="1" name="mode" type="int" enum="Animation.UpdateMode"> </argument> <description> - Set the update mode (UPDATE_*) of a value track. + Sets the update mode ([code]UPDATE_*[/code]) of a value track. </description> </method> </methods> <members> - <member name="length" type="float" setter="set_length" getter="get_length"> - The total length of the animation (in seconds). Note that length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping. + <member name="length" type="float" setter="set_length" getter="get_length" default="1.0"> + The total length of the animation (in seconds). + [b]Note:[/b] Length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping. </member> - <member name="loop" type="bool" setter="set_loop" getter="has_loop"> + <member name="loop" type="bool" setter="set_loop" getter="has_loop" default="false"> A flag indicating that the animation must loop. This is uses for correct interpolation of animation cycles, and for hinting the player that it must restart the animation. </member> - <member name="step" type="float" setter="set_step" getter="get_step"> + <member name="step" type="float" setter="set_step" getter="get_step" default="0.1"> The animation step value. </member> </members> @@ -682,7 +683,7 @@ Value tracks set values in node properties, but only those which can be Interpolated. </constant> <constant name="TYPE_TRANSFORM" value="1" enum="TrackType"> - Transform tracks are used to change node local transforms or skeleton pose bones. Transitions are Interpolated. + Transform tracks are used to change node local transforms or skeleton pose bones. Transitions are interpolated. </constant> <constant name="TYPE_METHOD" value="2" enum="TrackType"> Method tracks call functions with given arguments per key. |