godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
f35fd681ac
godot/doc/classes/AnimationPlayer.xml

307 lines
13 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Bump version to 3.2
2019-04-01 10:33:56 +00:00
<class name="AnimationPlayer" inherits="Node" category="Core" version="3.2">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<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.
</description>
<tutorials>
doc: Use HTTPS for docs.godotengine.org and point to latest branch Fixes #23509.
2018-11-05 07:46:27 +00:00
<link>https://docs.godotengine.org/en/latest/getting_started/step_by_step/animations.html</link>
<link>https://docs.godotengine.org/en/latest/tutorials/animation/index.html</link>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</tutorials>
<methods>
<method name="add_animation">
<return type="int" enum="Error">
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="animation" type="Animation">
</argument>
<description>
[DOCS] AnimationPlayer new props, members/methods
2017-12-05 04:13:52 +00:00
Adds [code]animation[/code] to the player accessible with the key [code]name[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="advance">
<return type="void">
</return>
<argument index="0" name="delta" type="float">
</argument>
<description>
Elaborate AnimationPlayer manual advancing Elaborate the difference between AnimationPlayer::advance and AnimationPlayer::seek, specifically how intermediary events are handled for each. From the docs it is unclear that AnimationPlayer::advance is more of a 'fast-forward', playing each event (including function calls) between the two points.
2019-02-27 14:15:35 +00:00
Shifts position in the animation timeline. Delta is the time in seconds to shift. Events between the current frame and [code]delta[/code] are handled.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="animation_get_next" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="anim_from" type="String">
</argument>
<description>
[DOCS] AnimationPlayer new props, members/methods
2017-12-05 04:13:52 +00:00
Returns the name of the next animation in the queue.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="animation_set_next">
<return type="void">
</return>
<argument index="0" name="anim_from" type="String">
</argument>
<argument index="1" name="anim_to" type="String">
</argument>
<description>
[DOCS] AnimationPlayer new props, members/methods
2017-12-05 04:13:52 +00:00
Triggers the [code]anim_to[/code] animation when the [code]anim_from[/code] animation completes.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="clear_caches">
<return type="void">
</return>
<description>
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-29 22:37:35 +00:00
[AnimationPlayer] caches animated nodes. It may not notice if a node disappears, so clear_caches forces it to update the cache again.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="clear_queue">
<return type="void">
</return>
<description>
[DOCS] AnimationPlayer new props, members/methods
2017-12-05 04:13:52 +00:00
Clears all queued, unplayed animations.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="find_animation" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="animation" type="Animation">
</argument>
<description>
[DOCS] AnimationPlayer new props, members/methods
2017-12-05 04:13:52 +00:00
Returns the name of [code]animation[/code] or empty string if not found.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_animation" qualifiers="const">
<return type="Animation">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
[DOCS] AnimationPlayer new props, members/methods
2017-12-05 04:13:52 +00:00
Returns the [Animation] with key [code]name[/code] or [code]null[/code] if not found.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_animation_list" qualifiers="const">
<return type="PoolStringArray">
</return>
<description>
[DOCS] AnimationPlayer new props, members/methods
2017-12-05 04:13:52 +00:00
Returns the list of stored animation names.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_blend_time" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="anim_from" type="String">
</argument>
<argument index="1" name="anim_to" type="String">
</argument>
<description>
[DOCS] AnimationPlayer new props, members/methods
2017-12-05 04:13:52 +00:00
Get the blend time (in seconds) between two animations, referenced by their names.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Added `get_playing_speed` method to AnimationPlayer, returning the actual playing speed of the animation being played. As stated in #16550, there is no way to get the playing speed of an animation. The `playback_speed` property is for the whole AnimationPlayer node, and the argument passed to `play` method is another scale applied in top of the AnimationPlayer properties. Thus, the actual playing speed is AnimationPlayer.speed_scale * AnimationPlayer.playback.current.speed_scale. If it is not playing, the method returns 0.
2018-03-01 18:52:00 +00:00
<method name="get_playing_speed" qualifiers="const">
<return type="float">
</return>
<description>
Get the actual playing speed of current animation or 0 if not playing. This speed is the [code]playback_speed[/code] property multiplied by [code]custom_speed[/code] argument specified when calling the [code]play[/code] method.
</description>
</method>
doc: Sync classref with current source
2018-12-04 20:57:07 +00:00
<method name="get_queue">
<return type="PoolStringArray">
</return>
<description>
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="has_animation" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-29 22:37:35 +00:00
Returns [code]true[/code] if the [AnimationPlayer] stores an [Animation] with key [code]name[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="is_playing" qualifiers="const">
<return type="bool">
</return>
<description>
[DOCS] AnimationPlayer new props, members/methods
2017-12-05 04:13:52 +00:00
Returns [code]true[/code] if playing an animation.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="play">
<return type="void">
</return>
<argument index="0" name="name" type="String" 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>
Consistently wrap booleans in [code]
2019-04-17 11:42:56 +00:00
Play the animation with key [code]name[/code]. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being [code]true[/code] can play the animation backwards.
Fix some AnimationPlayer bugs and update documentation
2019-02-13 17:40:22 +00:00
If the animation has been paused by [code]stop(true)[/code] it will be resumed. Calling [code]play()[/code] without arguments will also resume the animation.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="play_backwards">
<return type="void">
</return>
<argument index="0" name="name" type="String" default="&quot;&quot;">
</argument>
<argument index="1" name="custom_blend" type="float" default="-1">
</argument>
<description>
[DOCS] AnimationPlayer new props, members/methods
2017-12-05 04:13:52 +00:00
Play the animation with key [code]name[/code] in reverse.
Fix some AnimationPlayer bugs and update documentation
2019-02-13 17:40:22 +00:00
If the animation has been paused by [code]stop(true)[/code] it will be resumed backwards. Calling [code]play_backwards()[/code] without arguments will also resume the animation backwards.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="queue">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
Queue an animation for playback once the current one is done.
</description>
</method>
<method name="remove_animation">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
[DOCS] AnimationPlayer new props, members/methods
2017-12-05 04:13:52 +00:00
Remove the animation with key [code]name[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="rename_animation">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="newname" type="String">
</argument>
<description>
[DOCS] AnimationPlayer new props, members/methods
2017-12-05 04:13:52 +00:00
Rename an existing animation with key [code]name[/code] to [code]newname[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="seek">
<return type="void">
</return>
Rename pos to position in user facing methods and variables Rename user facing methods and variables as well as the corresponding C++ methods according to the folloming changes: * pos -> position * rot -> rotation * loc -> location C++ variables are left as is.
2017-09-10 13:37:49 +00:00
<argument index="0" name="seconds" type="float">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<argument index="1" name="update" type="bool" default="false">
</argument>
<description>
Elaborate AnimationPlayer manual advancing Elaborate the difference between AnimationPlayer::advance and AnimationPlayer::seek, specifically how intermediary events are handled for each. From the docs it is unclear that AnimationPlayer::advance is more of a 'fast-forward', playing each event (including function calls) between the two points.
2019-02-27 14:15:35 +00:00
Seek 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.
Revert property changes in "[DOCS] AnimationPlayer new props, members/methods" This partially reverts commits e79456519d0c1dff98ffa5f39e8e7c962b7dd553 and 2d07fe29208b9ccef31ab654ca5405edac7a0de7, which introduced API changes needing more in-depth review at this stage. Kept the removal of "get_position" binding, redundant with "get_current_animation_position". Kept docs changes where applicable. Also removed the obsolete "stop_all" method which does the same as "stop". Fixes #14602.
2017-12-13 23:07:39 +00:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="set_blend_time">
<return type="void">
</return>
<argument index="0" name="anim_from" type="String">
</argument>
<argument index="1" name="anim_to" type="String">
</argument>
<argument index="2" name="sec" type="float">
</argument>
<description>
Specify a blend time (in seconds) between two animations, referenced by their names.
</description>
</method>
Revert property changes in "[DOCS] AnimationPlayer new props, members/methods" This partially reverts commits e79456519d0c1dff98ffa5f39e8e7c962b7dd553 and 2d07fe29208b9ccef31ab654ca5405edac7a0de7, which introduced API changes needing more in-depth review at this stage. Kept the removal of "get_position" binding, redundant with "get_current_animation_position". Kept docs changes where applicable. Also removed the obsolete "stop_all" method which does the same as "stop". Fixes #14602.
2017-12-13 23:07:39 +00:00
<method name="stop">
<return type="void">
</return>
<argument index="0" name="reset" type="bool" default="true">
</argument>
<description>
Fix some AnimationPlayer bugs and update documentation
2019-02-13 17:40:22 +00:00
Stop 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], then calling [code]play()[/code] without arguments or [code]play("same_as_before")[/code] will resume the animation. Works the same for the [code]play_backwards()[/code] method.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<members>
Fix an issue with the animation editor not seeking to the target time properly. Fixes #15646.
2018-01-14 10:28:57 +00:00
<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>
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
<member name="autoplay" type="String" setter="set_autoplay" getter="get_autoplay">
The name of the animation to play when the scene loads. Default value: [code]""[/code].
</member>
<member name="current_animation" type="String" setter="set_current_animation" getter="get_current_animation">
The name of the current animation, "" if not playing anything. When being set, does not restart the animation. See also [method play]. Default value: [code]""[/code].
</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>
Implement AnimationPlayer call modes as per #23498.
2018-12-08 18:56:20 +00:00
<member name="method_call_mode" type="int" setter="set_method_call_mode" getter="get_method_call_mode" enum="AnimationPlayer.AnimationMethodCallMode">
doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks
2019-06-27 10:34:26 +00:00
The call mode to use for Call Method tracks. Default value: [constant ANIMATION_METHOD_CALL_DEFERRED].
Implement AnimationPlayer call modes as per #23498.
2018-12-08 18:56:20 +00:00
</member>
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
<member name="playback_active" type="bool" setter="set_active" getter="is_active">
If [code]true[/code], updates animations in response to process-related notifications. Default value: [code]true[/code].
</member>
doc: Sync classref with current source
2017-12-09 23:43:30 +00:00
<member name="playback_default_blend_time" type="float" setter="set_default_blend_time" getter="get_default_blend_time">
Revert property changes in "[DOCS] AnimationPlayer new props, members/methods" This partially reverts commits e79456519d0c1dff98ffa5f39e8e7c962b7dd553 and 2d07fe29208b9ccef31ab654ca5405edac7a0de7, which introduced API changes needing more in-depth review at this stage. Kept the removal of "get_position" binding, redundant with "get_current_animation_position". Kept docs changes where applicable. Also removed the obsolete "stop_all" method which does the same as "stop". Fixes #14602.
2017-12-13 23:07:39 +00:00
The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 precision. Default value: [code]0[/code].
doc: Sync classref with current source
2017-12-09 23:43:30 +00:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="playback_process_mode" type="int" setter="set_animation_process_mode" getter="get_animation_process_mode" enum="AnimationPlayer.AnimationProcessMode">
doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks
2019-06-27 10:34:26 +00:00
The process notification in which to update animations. Default value: [constant ANIMATION_PROCESS_IDLE].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
<member name="playback_speed" type="float" setter="set_speed_scale" getter="get_speed_scale">
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. Default value: [code]1[/code].
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="root_node" type="NodePath" setter="set_root" getter="get_root">
[DOCS] AnimationPlayer new props, members/methods
2017-12-05 04:13:52 +00:00
The node from which node path references will travel. Default value: [code]".."[/code].
</member>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</members>
<signals>
<signal name="animation_changed">
<argument index="0" name="old_name" type="String">
</argument>
<argument index="1" name="new_name" type="String">
</argument>
<description>
Revert property changes in "[DOCS] AnimationPlayer new props, members/methods" This partially reverts commits e79456519d0c1dff98ffa5f39e8e7c962b7dd553 and 2d07fe29208b9ccef31ab654ca5405edac7a0de7, which introduced API changes needing more in-depth review at this stage. Kept the removal of "get_position" binding, redundant with "get_current_animation_position". Kept docs changes where applicable. Also removed the obsolete "stop_all" method which does the same as "stop". Fixes #14602.
2017-12-13 23:07:39 +00:00
If the currently being played animation changes, this signal will notify of such change.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</signal>
<signal name="animation_finished">
doc: Sync with current source
2018-01-13 10:43:30 +00:00
<argument index="0" name="anim_name" type="String">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
Revert property changes in "[DOCS] AnimationPlayer new props, members/methods" This partially reverts commits e79456519d0c1dff98ffa5f39e8e7c962b7dd553 and 2d07fe29208b9ccef31ab654ca5405edac7a0de7, which introduced API changes needing more in-depth review at this stage. Kept the removal of "get_position" binding, redundant with "get_current_animation_position". Kept docs changes where applicable. Also removed the obsolete "stop_all" method which does the same as "stop". Fixes #14602.
2017-12-13 23:07:39 +00:00
Notifies when an animation finished playing.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</signal>
<signal name="animation_started">
doc: Sync with current source
2018-01-13 10:43:30 +00:00
<argument index="0" name="anim_name" type="String">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
Revert property changes in "[DOCS] AnimationPlayer new props, members/methods" This partially reverts commits e79456519d0c1dff98ffa5f39e8e7c962b7dd553 and 2d07fe29208b9ccef31ab654ca5405edac7a0de7, which introduced API changes needing more in-depth review at this stage. Kept the removal of "get_position" binding, redundant with "get_current_animation_position". Kept docs changes where applicable. Also removed the obsolete "stop_all" method which does the same as "stop". Fixes #14602.
2017-12-13 23:07:39 +00:00
Notifies when an animation starts playing.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</signal>
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 09:56:21 +00:00
<signal name="caches_cleared">
<description>
</description>
</signal>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</signals>
<constants>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="ANIMATION_PROCESS_PHYSICS" value="0" enum="AnimationProcessMode">
Proofreading: Change a usage of "specially" to "especially" See PR godotengine/godot-docs#561. This file generates documentation touched by that PR, so must be changed to stay in sync. I couldn't find any other usages in this repo that needed changing. I looked in all files matching *.cpp *.h *.md *.txt *.xml *.html *.rst.
2017-10-31 23:47:07 +00:00
Process animation during the physics process. This is especially useful when animating physics bodies.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="ANIMATION_PROCESS_IDLE" value="1" enum="AnimationProcessMode">
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-11 21:54:43 +00:00
Process animation during the idle process.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
Add method to manually advance AnimationTree and manual process mode.
2018-08-02 07:22:24 +00:00
<constant name="ANIMATION_PROCESS_MANUAL" value="2" enum="AnimationProcessMode">
Do not process animation. Use the 'advance' method to process the animation manually.
</constant>
Implement AnimationPlayer call modes as per #23498.
2018-12-08 18:56:20 +00:00
<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>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constants>
</class>
Reference in New Issue Copy Permalink