virtualx-engine/doc/classes/AnimationPlayer.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationPlayer" inherits="Node" version="4.0">
	<brief_description>
		Container and player of [Animation] resources.
	</brief_description>
	<description>
		An animation player is used for general-purpose playback of [Animation] resources. It contains a dictionary of animations (referenced by name) and custom blend times between their transitions. Additionally, animations can be played and blended in different channels.
		[AnimationPlayer] is more suited than [Tween] for animations where you know the final values in advance. For example, fading a screen in and out is more easily done with an [AnimationPlayer] node thanks to the animation tools provided by the editor. That particular example can also be implemented with a [Tween] node, but it requires doing everything by code.
		Updating the target properties of animations occurs at process time.
	</description>
	<tutorials>
		<link title="2D Sprite animation">https://docs.godotengine.org/en/latest/tutorials/2d/2d_sprite_animation.html</link>
		<link title="Animation tutorial index">https://docs.godotengine.org/en/latest/tutorials/animation/index.html</link>
		<link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link>
	</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>
			<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>
			<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>
			<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>
			<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>
			<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>
			<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>
			<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>
			<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>
			<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>
			<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>
			<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>
			<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>
			<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>
			<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="&quot;&quot;">
			</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>
			<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.
				[b]Note:[/b] The animation will be updated the next time the [AnimationPlayer] is processed. If other variables are updated at the same time this is called, they may be updated too early. To perform the update immediately, call [code]advance(0)[/code].
			</description>
		</method>
		<method name="play_backwards">
			<return type="void">
			</return>
			<argument index="0" name="name" type="StringName" default="&quot;&quot;">
			</argument>
			<argument index="1" name="custom_blend" type="float" default="-1">
			</argument>
			<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>
			<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>
			<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>
			<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>
			<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>
			<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>
			<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.
			</description>
		</method>
	</methods>
	<members>
		<member name="assigned_animation" type="String" setter="set_assigned_animation" getter="get_assigned_animation">
			If playing, the current animation; otherwise, the animation last played. When set, would change the animation, but would not play it unless currently playing. See also [member current_animation].
		</member>
		<member name="autoplay" type="String" setter="set_autoplay" getter="get_autoplay" default="&quot;&quot;">
			The name of the animation to play when the scene loads.
		</member>
		<member name="current_animation" type="String" setter="set_current_animation" getter="get_current_animation" default="&quot;&quot;">
			The name of the currently playing animation. If no animation is playing, the property's value is an empty string. Changing this value does not restart the animation. See [method play] for more information on playing animations.
			[b]Note[/b]: while this property appears in the inspector, it's not meant to be edited and it's not saved in the scene. This property is mainly used to get the currently playing animation, and internally for animation playback tracks. For more information, see [Animation].
		</member>
		<member name="current_animation_length" type="float" setter="" getter="get_current_animation_length">
			The length (in seconds) of the currently being played animation.
		</member>
		<member name="current_animation_position" type="float" setter="" getter="get_current_animation_position">
			The position (in seconds) of the currently playing animation.
		</member>
		<member name="method_call_mode" type="int" setter="set_method_call_mode" getter="get_method_call_mode" enum="AnimationPlayer.AnimationMethodCallMode" default="0">
			The call mode to use for Call Method tracks.
		</member>
		<member name="playback_active" type="bool" setter="set_active" getter="is_active">
			If [code]true[/code], updates animations in response to process-related notifications.
		</member>
		<member name="playback_default_blend_time" type="float" setter="set_default_blend_time" getter="get_default_blend_time" default="0.0">
			The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 precision.
		</member>
		<member name="playback_process_mode" type="int" setter="set_animation_process_mode" getter="get_animation_process_mode" enum="AnimationPlayer.AnimationProcessMode" default="1">
			The process notification in which to update animations.
		</member>
		<member name="playback_speed" type="float" setter="set_speed_scale" getter="get_speed_scale" default="1.0">
			The speed scaling ratio. For instance, if this value is 1, then the animation plays at normal speed. If it's 0.5, then it plays at half speed. If it's 2, then it plays at double speed.
		</member>
		<member name="reset_on_save" type="bool" setter="set_reset_on_save_enabled" getter="is_reset_on_save_enabled" default="true">
			This is used by the editor. If set to [code]true[/code], the scene will be saved with the effects of the reset animation applied (as if it had been seeked to time 0), then reverted after saving.
			In other words, the saved scene file will contain the "default pose", as defined by the reset animation, if any, with the editor keeping the values that the nodes had before saving.
		</member>
		<member name="root_node" type="NodePath" setter="set_root" getter="get_root" default="NodePath(&quot;..&quot;)">
			The node from which node path references will travel.
		</member>
	</members>
	<signals>
		<signal name="animation_changed">
			<argument index="0" name="old_name" type="StringName">
			</argument>
			<argument index="1" name="new_name" type="StringName">
			</argument>
			<description>
				If the currently being played animation changes, this signal will notify of such change.
			</description>
		</signal>
		<signal name="animation_finished">
			<argument index="0" name="anim_name" type="StringName">
			</argument>
			<description>
				Notifies when an animation finished playing.
			</description>
		</signal>
		<signal name="animation_started">
			<argument index="0" name="anim_name" type="StringName">
			</argument>
			<description>
				Notifies when an animation starts playing.
			</description>
		</signal>
		<signal name="caches_cleared">
			<description>
				Notifies when the caches have been cleared, either automatically, or manually via [method clear_caches].
			</description>
		</signal>
	</signals>
	<constants>
		<constant name="ANIMATION_PROCESS_PHYSICS" value="0" enum="AnimationProcessMode">
			Process animation during the physics process. This is especially useful when animating physics bodies.
		</constant>
		<constant name="ANIMATION_PROCESS_IDLE" value="1" enum="AnimationProcessMode">
			Process animation during the idle process.
		</constant>
		<constant name="ANIMATION_PROCESS_MANUAL" value="2" enum="AnimationProcessMode">
			Do not process animation. Use [method advance] to process the animation manually.
		</constant>
		<constant name="ANIMATION_METHOD_CALL_DEFERRED" value="0" enum="AnimationMethodCallMode">
			Batch method calls during the animation process, then do the calls after events are processed. This avoids bugs involving deleting nodes or modifying the AnimationPlayer while playing.
		</constant>
		<constant name="ANIMATION_METHOD_CALL_IMMEDIATE" value="1" enum="AnimationMethodCallMode">
			Make method calls immediately when reached in the animation.
		</constant>
	</constants>
</class>