diff options
Diffstat (limited to 'doc/classes/AnimationPlayer.xml')
| -rw-r--r-- | doc/classes/AnimationPlayer.xml | 162 |
1 files changed, 55 insertions, 107 deletions
diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index 7696f36009..1ef9d81d02 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/doc/classes/AnimationPlayer.xml @@ -15,136 +15,106 @@ </tutorials> <methods> <method name="add_animation"> - <return type="int" enum="Error"> - </return> - <argument index="0" name="name" type="StringName"> - </argument> - <argument index="1" name="animation" type="Animation"> - </argument> + <return type="int" enum="Error" /> + <argument index="0" name="name" type="StringName" /> + <argument index="1" name="animation" type="Animation" /> <description> Adds [code]animation[/code] to the player accessible with the key [code]name[/code]. </description> </method> <method name="advance"> - <return type="void"> - </return> - <argument index="0" name="delta" type="float"> - </argument> + <return type="void" /> + <argument index="0" name="delta" type="float" /> <description> Shifts position in the animation timeline and immediately updates the animation. [code]delta[/code] is the time in seconds to shift. Events between the current frame and [code]delta[/code] are handled. </description> </method> <method name="animation_get_next" qualifiers="const"> - <return type="StringName"> - </return> - <argument index="0" name="anim_from" type="StringName"> - </argument> + <return type="StringName" /> + <argument index="0" name="anim_from" type="StringName" /> <description> Returns the name of the next animation in the queue. </description> </method> <method name="animation_set_next"> - <return type="void"> - </return> - <argument index="0" name="anim_from" type="StringName"> - </argument> - <argument index="1" name="anim_to" type="StringName"> - </argument> + <return type="void" /> + <argument index="0" name="anim_from" type="StringName" /> + <argument index="1" name="anim_to" type="StringName" /> <description> Triggers the [code]anim_to[/code] animation when the [code]anim_from[/code] animation completes. </description> </method> <method name="clear_caches"> - <return type="void"> - </return> + <return type="void" /> <description> [AnimationPlayer] caches animated nodes. It may not notice if a node disappears; [method clear_caches] forces it to update the cache again. </description> </method> <method name="clear_queue"> - <return type="void"> - </return> + <return type="void" /> <description> Clears all queued, unplayed animations. </description> </method> <method name="find_animation" qualifiers="const"> - <return type="StringName"> - </return> - <argument index="0" name="animation" type="Animation"> - </argument> + <return type="StringName" /> + <argument index="0" name="animation" type="Animation" /> <description> Returns the name of [code]animation[/code] or an empty string if not found. </description> </method> <method name="get_animation" qualifiers="const"> - <return type="Animation"> - </return> - <argument index="0" name="name" type="StringName"> - </argument> + <return type="Animation" /> + <argument index="0" name="name" type="StringName" /> <description> Returns the [Animation] with key [code]name[/code] or [code]null[/code] if not found. </description> </method> <method name="get_animation_list" qualifiers="const"> - <return type="PackedStringArray"> - </return> + <return type="PackedStringArray" /> <description> Returns the list of stored animation names. </description> </method> <method name="get_blend_time" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="anim_from" type="StringName"> - </argument> - <argument index="1" name="anim_to" type="StringName"> - </argument> + <return type="float" /> + <argument index="0" name="anim_from" type="StringName" /> + <argument index="1" name="anim_to" type="StringName" /> <description> Gets the blend time (in seconds) between two animations, referenced by their names. </description> </method> <method name="get_playing_speed" qualifiers="const"> - <return type="float"> - </return> + <return type="float" /> <description> Gets the actual playing speed of current animation or 0 if not playing. This speed is the [member playback_speed] property multiplied by [code]custom_speed[/code] argument specified when calling the [method play] method. </description> </method> <method name="get_queue"> - <return type="PackedStringArray"> - </return> + <return type="PackedStringArray" /> <description> Returns a list of the animation names that are currently queued to play. </description> </method> <method name="has_animation" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="name" type="StringName"> - </argument> + <return type="bool" /> + <argument index="0" name="name" type="StringName" /> <description> Returns [code]true[/code] if the [AnimationPlayer] stores an [Animation] with key [code]name[/code]. </description> </method> <method name="is_playing" qualifiers="const"> - <return type="bool"> - </return> + <return type="bool" /> <description> Returns [code]true[/code] if playing an animation. </description> </method> <method name="play"> - <return type="void"> - </return> - <argument index="0" name="name" type="StringName" default=""""> - </argument> - <argument index="1" name="custom_blend" type="float" default="-1"> - </argument> - <argument index="2" name="custom_speed" type="float" default="1.0"> - </argument> - <argument index="3" name="from_end" type="bool" default="false"> - </argument> + <return type="void" /> + <argument index="0" name="name" type="StringName" default="""" /> + <argument index="1" name="custom_blend" type="float" default="-1" /> + <argument index="2" name="custom_speed" type="float" default="1.0" /> + <argument index="3" name="from_end" type="bool" default="false" /> <description> Plays the animation with key [code]name[/code]. Custom blend times and speed can be set. If [code]custom_speed[/code] is negative and [code]from_end[/code] is [code]true[/code], the animation will play backwards (which is equivalent to calling [method play_backwards]). The [AnimationPlayer] keeps track of its current or last played animation with [member assigned_animation]. If this method is called with that same animation [code]name[/code], or with no [code]name[/code] parameter, the assigned animation will resume playing if it was paused, or restart if it was stopped (see [method stop] for both pause and stop). If the animation was already playing, it will keep playing. @@ -152,76 +122,57 @@ </description> </method> <method name="play_backwards"> - <return type="void"> - </return> - <argument index="0" name="name" type="StringName" default=""""> - </argument> - <argument index="1" name="custom_blend" type="float" default="-1"> - </argument> + <return type="void" /> + <argument index="0" name="name" type="StringName" default="""" /> + <argument index="1" name="custom_blend" type="float" default="-1" /> <description> Plays the animation with key [code]name[/code] in reverse. This method is a shorthand for [method play] with [code]custom_speed = -1.0[/code] and [code]from_end = true[/code], so see its description for more information. </description> </method> <method name="queue"> - <return type="void"> - </return> - <argument index="0" name="name" type="StringName"> - </argument> + <return type="void" /> + <argument index="0" name="name" type="StringName" /> <description> Queues an animation for playback once the current one is done. [b]Note:[/b] If a looped animation is currently playing, the queued animation will never play unless the looped animation is stopped somehow. </description> </method> <method name="remove_animation"> - <return type="void"> - </return> - <argument index="0" name="name" type="StringName"> - </argument> + <return type="void" /> + <argument index="0" name="name" type="StringName" /> <description> Removes the animation with key [code]name[/code]. </description> </method> <method name="rename_animation"> - <return type="void"> - </return> - <argument index="0" name="name" type="StringName"> - </argument> - <argument index="1" name="newname" type="StringName"> - </argument> + <return type="void" /> + <argument index="0" name="name" type="StringName" /> + <argument index="1" name="newname" type="StringName" /> <description> Renames an existing animation with key [code]name[/code] to [code]newname[/code]. </description> </method> <method name="seek"> - <return type="void"> - </return> - <argument index="0" name="seconds" type="float"> - </argument> - <argument index="1" name="update" type="bool" default="false"> - </argument> + <return type="void" /> + <argument index="0" name="seconds" type="float" /> + <argument index="1" name="update" type="bool" default="false" /> <description> Seeks the animation to the [code]seconds[/code] point in time (in seconds). If [code]update[/code] is [code]true[/code], the animation updates too, otherwise it updates at process time. Events between the current frame and [code]seconds[/code] are skipped. </description> </method> <method name="set_blend_time"> - <return type="void"> - </return> - <argument index="0" name="anim_from" type="StringName"> - </argument> - <argument index="1" name="anim_to" type="StringName"> - </argument> - <argument index="2" name="sec" type="float"> - </argument> + <return type="void" /> + <argument index="0" name="anim_from" type="StringName" /> + <argument index="1" name="anim_to" type="StringName" /> + <argument index="2" name="sec" type="float" /> <description> Specifies a blend time (in seconds) between two animations, referenced by their names. </description> </method> <method name="stop"> - <return type="void"> - </return> - <argument index="0" name="reset" type="bool" default="true"> - </argument> + <return type="void" /> + <argument index="0" name="reset" type="bool" default="true" /> <description> Stops or pauses the currently playing animation. If [code]reset[/code] is [code]true[/code], the animation position is reset to [code]0[/code] and the playback speed is reset to [code]1.0[/code]. If [code]reset[/code] is [code]false[/code], the [member current_animation_position] will be kept and calling [method play] or [method play_backwards] without arguments or with the same animation name as [member assigned_animation] will resume the animation. @@ -270,24 +221,21 @@ </members> <signals> <signal name="animation_changed"> - <argument index="0" name="old_name" type="StringName"> - </argument> - <argument index="1" name="new_name" type="StringName"> - </argument> + <argument index="0" name="old_name" type="StringName" /> + <argument index="1" name="new_name" type="StringName" /> <description> - If the currently being played animation changes, this signal will notify of such change. + Emitted when a queued animation plays after the previous animation was finished. See [method queue]. + [b]Note:[/b] The signal is not emitted when the animation is changed via [method play] or from [AnimationTree]. </description> </signal> <signal name="animation_finished"> - <argument index="0" name="anim_name" type="StringName"> - </argument> + <argument index="0" name="anim_name" type="StringName" /> <description> Notifies when an animation finished playing. </description> </signal> <signal name="animation_started"> - <argument index="0" name="anim_name" type="StringName"> - </argument> + <argument index="0" name="anim_name" type="StringName" /> <description> Notifies when an animation starts playing. </description> |