mirror of
https://github.com/godotengine/godot-docs-l10n.git
synced 2025-12-31 09:49:22 +03:00
929 lines
79 KiB
ReStructuredText
929 lines
79 KiB
ReStructuredText
:github_url: hide
|
||
|
||
.. _class_AnimationPlayer:
|
||
|
||
AnimationPlayer
|
||
===============
|
||
|
||
**Успадковує:** :ref:`AnimationMixer<class_AnimationMixer>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
||
|
||
Вузол, який використовується для відтворення анімації.
|
||
|
||
.. rst-class:: classref-introduction-group
|
||
|
||
Опис
|
||
--------
|
||
|
||
Програвач анімації використовується для відтворення анімацій загального призначення. Він містить словник ресурсів :ref:`AnimationLibrary<class_AnimationLibrary>` і спеціальний час змішування між переходами анімації.
|
||
|
||
Деякі методи та властивості використовують один ключ для безпосереднього посилання на анімацію. Ці ключі відформатовані як ключ для бібліотеки, за яким йде коса риска, а потім ключ для анімації в бібліотеці, наприклад ``"рух/біг"``. Якщо ключ бібліотеки є порожнім рядком (відомий як бібліотека за замовчуванням), коса риска пропускається, оскільки це той самий ключ, який використовується бібліотекою.
|
||
|
||
\ **AnimationPlayer** краще підходить, ніж :ref:`Tween<class_Tween>`, для складніших анімацій, наприклад із нетривіальними хронометражами. Його також можна використовувати поверх :ref:`Tween<class_Tween>`, якщо редактор доріжок анімації зручніший, ніж робити це в коді.
|
||
|
||
Оновлення цільових властивостей анімацій відбувається на кадрі процесу.
|
||
|
||
.. rst-class:: classref-introduction-group
|
||
|
||
Посібники
|
||
------------------
|
||
|
||
- :doc:`Анімація 2D спрайтів <../tutorials/2d/2d_sprite_animation>`
|
||
|
||
- :doc:`Індекс анімаційної документації <../tutorials/animation/index>`
|
||
|
||
- `Демо-версія шутера від третьої особи (TPS) <https://godotengine.org/asset-library/asset/2710>`__
|
||
|
||
.. rst-class:: classref-reftable-group
|
||
|
||
Властивості
|
||
----------------------
|
||
|
||
.. table::
|
||
:widths: auto
|
||
|
||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+
|
||
| :ref:`StringName<class_StringName>` | :ref:`assigned_animation<class_AnimationPlayer_property_assigned_animation>` | |
|
||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+
|
||
| :ref:`StringName<class_StringName>` | :ref:`autoplay<class_AnimationPlayer_property_autoplay>` | ``&""`` |
|
||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+
|
||
| :ref:`StringName<class_StringName>` | :ref:`current_animation<class_AnimationPlayer_property_current_animation>` | ``&""`` |
|
||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+
|
||
| :ref:`float<class_float>` | :ref:`current_animation_length<class_AnimationPlayer_property_current_animation_length>` | |
|
||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+
|
||
| :ref:`float<class_float>` | :ref:`current_animation_position<class_AnimationPlayer_property_current_animation_position>` | |
|
||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+
|
||
| :ref:`bool<class_bool>` | :ref:`movie_quit_on_finish<class_AnimationPlayer_property_movie_quit_on_finish>` | ``false`` |
|
||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+
|
||
| :ref:`bool<class_bool>` | :ref:`playback_auto_capture<class_AnimationPlayer_property_playback_auto_capture>` | ``true`` |
|
||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+
|
||
| :ref:`float<class_float>` | :ref:`playback_auto_capture_duration<class_AnimationPlayer_property_playback_auto_capture_duration>` | ``-1.0`` |
|
||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+
|
||
| :ref:`EaseType<enum_Tween_EaseType>` | :ref:`playback_auto_capture_ease_type<class_AnimationPlayer_property_playback_auto_capture_ease_type>` | ``0`` |
|
||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+
|
||
| :ref:`TransitionType<enum_Tween_TransitionType>` | :ref:`playback_auto_capture_transition_type<class_AnimationPlayer_property_playback_auto_capture_transition_type>` | ``0`` |
|
||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+
|
||
| :ref:`float<class_float>` | :ref:`playback_default_blend_time<class_AnimationPlayer_property_playback_default_blend_time>` | ``0.0`` |
|
||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+
|
||
| :ref:`float<class_float>` | :ref:`speed_scale<class_AnimationPlayer_property_speed_scale>` | ``1.0`` |
|
||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+
|
||
|
||
.. rst-class:: classref-reftable-group
|
||
|
||
Методи
|
||
------------
|
||
|
||
.. table::
|
||
:widths: auto
|
||
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`StringName<class_StringName>` | :ref:`animation_get_next<class_AnimationPlayer_method_animation_get_next>`\ (\ animation_from\: :ref:`StringName<class_StringName>`\ ) |const| |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`animation_set_next<class_AnimationPlayer_method_animation_set_next>`\ (\ animation_from\: :ref:`StringName<class_StringName>`, animation_to\: :ref:`StringName<class_StringName>`\ ) |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`clear_queue<class_AnimationPlayer_method_clear_queue>`\ (\ ) |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`float<class_float>` | :ref:`get_blend_time<class_AnimationPlayer_method_get_blend_time>`\ (\ animation_from\: :ref:`StringName<class_StringName>`, animation_to\: :ref:`StringName<class_StringName>`\ ) |const| |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`AnimationMethodCallMode<enum_AnimationPlayer_AnimationMethodCallMode>` | :ref:`get_method_call_mode<class_AnimationPlayer_method_get_method_call_mode>`\ (\ ) |const| |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`float<class_float>` | :ref:`get_playing_speed<class_AnimationPlayer_method_get_playing_speed>`\ (\ ) |const| |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`AnimationProcessCallback<enum_AnimationPlayer_AnimationProcessCallback>` | :ref:`get_process_callback<class_AnimationPlayer_method_get_process_callback>`\ (\ ) |const| |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Array<class_Array>`\[:ref:`StringName<class_StringName>`\] | :ref:`get_queue<class_AnimationPlayer_method_get_queue>`\ (\ ) |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`NodePath<class_NodePath>` | :ref:`get_root<class_AnimationPlayer_method_get_root>`\ (\ ) |const| |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`float<class_float>` | :ref:`get_section_end_time<class_AnimationPlayer_method_get_section_end_time>`\ (\ ) |const| |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`float<class_float>` | :ref:`get_section_start_time<class_AnimationPlayer_method_get_section_start_time>`\ (\ ) |const| |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`has_section<class_AnimationPlayer_method_has_section>`\ (\ ) |const| |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`is_animation_active<class_AnimationPlayer_method_is_animation_active>`\ (\ ) |const| |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimationPlayer_method_is_playing>`\ (\ ) |const| |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`pause<class_AnimationPlayer_method_pause>`\ (\ ) |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`play<class_AnimationPlayer_method_play>`\ (\ name\: :ref:`StringName<class_StringName>` = &"", custom_blend\: :ref:`float<class_float>` = -1, custom_speed\: :ref:`float<class_float>` = 1.0, from_end\: :ref:`bool<class_bool>` = false\ ) |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`play_backwards<class_AnimationPlayer_method_play_backwards>`\ (\ name\: :ref:`StringName<class_StringName>` = &"", custom_blend\: :ref:`float<class_float>` = -1\ ) |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`play_section<class_AnimationPlayer_method_play_section>`\ (\ name\: :ref:`StringName<class_StringName>` = &"", start_time\: :ref:`float<class_float>` = -1, end_time\: :ref:`float<class_float>` = -1, custom_blend\: :ref:`float<class_float>` = -1, custom_speed\: :ref:`float<class_float>` = 1.0, from_end\: :ref:`bool<class_bool>` = false\ ) |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`play_section_backwards<class_AnimationPlayer_method_play_section_backwards>`\ (\ name\: :ref:`StringName<class_StringName>` = &"", start_time\: :ref:`float<class_float>` = -1, end_time\: :ref:`float<class_float>` = -1, custom_blend\: :ref:`float<class_float>` = -1\ ) |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`play_section_with_markers<class_AnimationPlayer_method_play_section_with_markers>`\ (\ name\: :ref:`StringName<class_StringName>` = &"", start_marker\: :ref:`StringName<class_StringName>` = &"", end_marker\: :ref:`StringName<class_StringName>` = &"", custom_blend\: :ref:`float<class_float>` = -1, custom_speed\: :ref:`float<class_float>` = 1.0, from_end\: :ref:`bool<class_bool>` = false\ ) |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`play_section_with_markers_backwards<class_AnimationPlayer_method_play_section_with_markers_backwards>`\ (\ name\: :ref:`StringName<class_StringName>` = &"", start_marker\: :ref:`StringName<class_StringName>` = &"", end_marker\: :ref:`StringName<class_StringName>` = &"", custom_blend\: :ref:`float<class_float>` = -1\ ) |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`play_with_capture<class_AnimationPlayer_method_play_with_capture>`\ (\ name\: :ref:`StringName<class_StringName>` = &"", duration\: :ref:`float<class_float>` = -1.0, custom_blend\: :ref:`float<class_float>` = -1, custom_speed\: :ref:`float<class_float>` = 1.0, from_end\: :ref:`bool<class_bool>` = false, trans_type\: :ref:`TransitionType<enum_Tween_TransitionType>` = 0, ease_type\: :ref:`EaseType<enum_Tween_EaseType>` = 0\ ) |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`queue<class_AnimationPlayer_method_queue>`\ (\ name\: :ref:`StringName<class_StringName>`\ ) |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`reset_section<class_AnimationPlayer_method_reset_section>`\ (\ ) |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`seek<class_AnimationPlayer_method_seek>`\ (\ seconds\: :ref:`float<class_float>`, update\: :ref:`bool<class_bool>` = false, update_only\: :ref:`bool<class_bool>` = false\ ) |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`set_blend_time<class_AnimationPlayer_method_set_blend_time>`\ (\ animation_from\: :ref:`StringName<class_StringName>`, animation_to\: :ref:`StringName<class_StringName>`, sec\: :ref:`float<class_float>`\ ) |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`set_method_call_mode<class_AnimationPlayer_method_set_method_call_mode>`\ (\ mode\: :ref:`AnimationMethodCallMode<enum_AnimationPlayer_AnimationMethodCallMode>`\ ) |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`set_process_callback<class_AnimationPlayer_method_set_process_callback>`\ (\ mode\: :ref:`AnimationProcessCallback<enum_AnimationPlayer_AnimationProcessCallback>`\ ) |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`set_root<class_AnimationPlayer_method_set_root>`\ (\ path\: :ref:`NodePath<class_NodePath>`\ ) |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`set_section<class_AnimationPlayer_method_set_section>`\ (\ start_time\: :ref:`float<class_float>` = -1, end_time\: :ref:`float<class_float>` = -1\ ) |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`set_section_with_markers<class_AnimationPlayer_method_set_section_with_markers>`\ (\ start_marker\: :ref:`StringName<class_StringName>` = &"", end_marker\: :ref:`StringName<class_StringName>` = &""\ ) |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`stop<class_AnimationPlayer_method_stop>`\ (\ keep_state\: :ref:`bool<class_bool>` = false\ ) |
|
||
+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
||
.. rst-class:: classref-section-separator
|
||
|
||
----
|
||
|
||
.. rst-class:: classref-descriptions-group
|
||
|
||
Сигнали
|
||
--------------
|
||
|
||
.. _class_AnimationPlayer_signal_animation_changed:
|
||
|
||
.. rst-class:: classref-signal
|
||
|
||
**animation_changed**\ (\ old_name\: :ref:`StringName<class_StringName>`, new_name\: :ref:`StringName<class_StringName>`\ ) :ref:`🔗<class_AnimationPlayer_signal_animation_changed>`
|
||
|
||
Випускається, коли анімація в черзі відтворюється після завершення попередньої анімації. Дивіться також :ref:`queue()<class_AnimationPlayer_method_queue>`.
|
||
|
||
\ **Примітка:** Сигнал не випромінюється, коли анімацію змінено за допомогою :ref:`play()<class_AnimationPlayer_method_play>` або :ref:`AnimationTree<class_AnimationTree>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_signal_current_animation_changed:
|
||
|
||
.. rst-class:: classref-signal
|
||
|
||
**current_animation_changed**\ (\ name\: :ref:`StringName<class_StringName>`\ ) :ref:`🔗<class_AnimationPlayer_signal_current_animation_changed>`
|
||
|
||
Видається, коли :ref:`current_animation<class_AnimationPlayer_property_current_animation>` змінюється.
|
||
|
||
.. rst-class:: classref-section-separator
|
||
|
||
----
|
||
|
||
.. rst-class:: classref-descriptions-group
|
||
|
||
Переліки
|
||
----------------
|
||
|
||
.. _enum_AnimationPlayer_AnimationProcessCallback:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **AnimationProcessCallback**: :ref:`🔗<enum_AnimationPlayer_AnimationProcessCallback>`
|
||
|
||
.. _class_AnimationPlayer_constant_ANIMATION_PROCESS_PHYSICS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AnimationProcessCallback<enum_AnimationPlayer_AnimationProcessCallback>` **ANIMATION_PROCESS_PHYSICS** = ``0``
|
||
|
||
**Застаріло:** See :ref:`AnimationMixer.ANIMATION_CALLBACK_MODE_PROCESS_PHYSICS<class_AnimationMixer_constant_ANIMATION_CALLBACK_MODE_PROCESS_PHYSICS>`.
|
||
|
||
|
||
|
||
.. _class_AnimationPlayer_constant_ANIMATION_PROCESS_IDLE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AnimationProcessCallback<enum_AnimationPlayer_AnimationProcessCallback>` **ANIMATION_PROCESS_IDLE** = ``1``
|
||
|
||
**Застаріло:** See :ref:`AnimationMixer.ANIMATION_CALLBACK_MODE_PROCESS_IDLE<class_AnimationMixer_constant_ANIMATION_CALLBACK_MODE_PROCESS_IDLE>`.
|
||
|
||
|
||
|
||
.. _class_AnimationPlayer_constant_ANIMATION_PROCESS_MANUAL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AnimationProcessCallback<enum_AnimationPlayer_AnimationProcessCallback>` **ANIMATION_PROCESS_MANUAL** = ``2``
|
||
|
||
**Застаріло:** See :ref:`AnimationMixer.ANIMATION_CALLBACK_MODE_PROCESS_MANUAL<class_AnimationMixer_constant_ANIMATION_CALLBACK_MODE_PROCESS_MANUAL>`.
|
||
|
||
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_AnimationPlayer_AnimationMethodCallMode:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **AnimationMethodCallMode**: :ref:`🔗<enum_AnimationPlayer_AnimationMethodCallMode>`
|
||
|
||
.. _class_AnimationPlayer_constant_ANIMATION_METHOD_CALL_DEFERRED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AnimationMethodCallMode<enum_AnimationPlayer_AnimationMethodCallMode>` **ANIMATION_METHOD_CALL_DEFERRED** = ``0``
|
||
|
||
**Застаріло:** See :ref:`AnimationMixer.ANIMATION_CALLBACK_MODE_METHOD_DEFERRED<class_AnimationMixer_constant_ANIMATION_CALLBACK_MODE_METHOD_DEFERRED>`.
|
||
|
||
|
||
|
||
.. _class_AnimationPlayer_constant_ANIMATION_METHOD_CALL_IMMEDIATE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`AnimationMethodCallMode<enum_AnimationPlayer_AnimationMethodCallMode>` **ANIMATION_METHOD_CALL_IMMEDIATE** = ``1``
|
||
|
||
**Застаріло:** See :ref:`AnimationMixer.ANIMATION_CALLBACK_MODE_METHOD_IMMEDIATE<class_AnimationMixer_constant_ANIMATION_CALLBACK_MODE_METHOD_IMMEDIATE>`.
|
||
|
||
|
||
|
||
.. rst-class:: classref-section-separator
|
||
|
||
----
|
||
|
||
.. rst-class:: classref-descriptions-group
|
||
|
||
Описи властивостей
|
||
------------------------------------
|
||
|
||
.. _class_AnimationPlayer_property_assigned_animation:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`StringName<class_StringName>` **assigned_animation** :ref:`🔗<class_AnimationPlayer_property_assigned_animation>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_assigned_animation**\ (\ value\: :ref:`StringName<class_StringName>`\ )
|
||
- :ref:`StringName<class_StringName>` **get_assigned_animation**\ (\ )
|
||
|
||
Якщо відтворюється, ключ поточної анімації, інакше анімація, яка відтворювалася останньою. Якщо встановлено, це змінює анімацію, але не відтворюватиме її, якщо вона вже не відтворюється. Дивіться також :ref:`current_animation<class_AnimationPlayer_property_current_animation>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_property_autoplay:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`StringName<class_StringName>` **autoplay** = ``&""`` :ref:`🔗<class_AnimationPlayer_property_autoplay>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_autoplay**\ (\ value\: :ref:`StringName<class_StringName>`\ )
|
||
- :ref:`StringName<class_StringName>` **get_autoplay**\ (\ )
|
||
|
||
Ключ анімації для відтворення при завантаженні сцени.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_property_current_animation:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`StringName<class_StringName>` **current_animation** = ``&""`` :ref:`🔗<class_AnimationPlayer_property_current_animation>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_current_animation**\ (\ value\: :ref:`StringName<class_StringName>`\ )
|
||
- :ref:`StringName<class_StringName>` **get_current_animation**\ (\ )
|
||
|
||
Ключ поточної анімації, що відтворюється. Якщо анімація не відтворюється, значенням властивості є порожній рядок. Зміна цього значення не перезапускає анімацію. Докладнішу інформацію про відтворення анімації див. у :ref:`play()<class_AnimationPlayer_method_play>`.
|
||
|
||
\ **Примітка:** Хоча ця властивість відображається в інспекторі, вона не призначена для редагування і не зберігається у сцені. Ця властивість здебільшого використовується для отримання поточної анімації, що відтворюється, а також для внутрішніх доріжок відтворення анімації. Докладнішу інформацію наведено у розділі :ref:`Animation<class_Animation>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_property_current_animation_length:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`float<class_float>` **current_animation_length** :ref:`🔗<class_AnimationPlayer_property_current_animation_length>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- :ref:`float<class_float>` **get_current_animation_length**\ (\ )
|
||
|
||
Тривалість поточної анімації, що відтворюється (у секундах).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_property_current_animation_position:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`float<class_float>` **current_animation_position** :ref:`🔗<class_AnimationPlayer_property_current_animation_position>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- :ref:`float<class_float>` **get_current_animation_position**\ (\ )
|
||
|
||
Позиція (у секундах) поточного відтворення анімації.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_property_movie_quit_on_finish:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **movie_quit_on_finish** = ``false`` :ref:`🔗<class_AnimationPlayer_property_movie_quit_on_finish>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_movie_quit_on_finish_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **is_movie_quit_on_finish_enabled**\ (\ )
|
||
|
||
Якщо ``true`` і механізм запущено в режимі Movie Maker (див. :ref:`MovieWriter<class_MovieWriter>`), завершує роботу механізму за допомогою :ref:`SceneTree.quit()<class_SceneTree_method_quit>`, щойно відтворення анімації в цьому **AnimationPlayer** завершиться. Коли двигун вимикається з цієї причини, друкується повідомлення.
|
||
|
||
\ **Примітка: ** Це підпорядковується тій самій логіці, що й сигнал :ref:`AnimationMixer.animation_finished<class_AnimationMixer_signal_animation_finished>`, тому він не вийде з механізму, якщо анімація налаштована на повторення.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_property_playback_auto_capture:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **playback_auto_capture** = ``true`` :ref:`🔗<class_AnimationPlayer_property_playback_auto_capture>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_auto_capture**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **is_auto_capture**\ (\ )
|
||
|
||
Якщо ``true``, перед автоматичним відтворенням виконується :ref:`AnimationMixer.capture()<class_AnimationMixer_method_capture>`. Це означає, що лише :ref:`play_with_capture()<class_AnimationPlayer_method_play_with_capture>` виконується з аргументами за замовчуванням замість :ref:`play()<class_AnimationPlayer_method_play>`.
|
||
|
||
\ **Примітка.** Інтерполяція захоплення виконується, лише якщо анімація містить трек захоплення. Дивіться також :ref:`Animation.UPDATE_CAPTURE<class_Animation_constant_UPDATE_CAPTURE>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_property_playback_auto_capture_duration:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`float<class_float>` **playback_auto_capture_duration** = ``-1.0`` :ref:`🔗<class_AnimationPlayer_property_playback_auto_capture_duration>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_auto_capture_duration**\ (\ value\: :ref:`float<class_float>`\ )
|
||
- :ref:`float<class_float>` **get_auto_capture_duration**\ (\ )
|
||
|
||
Дивіться також :ref:`play_with_capture()<class_AnimationPlayer_method_play_with_capture>` і :ref:`AnimationMixer.capture()<class_AnimationMixer_method_capture>`.
|
||
|
||
Якщо :ref:`playback_auto_capture_duration<class_AnimationPlayer_property_playback_auto_capture_duration>` є від’ємним значенням, тривалістю встановлюється інтервал між поточною позицією та першою клавішею.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_property_playback_auto_capture_ease_type:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`EaseType<enum_Tween_EaseType>` **playback_auto_capture_ease_type** = ``0`` :ref:`🔗<class_AnimationPlayer_property_playback_auto_capture_ease_type>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_auto_capture_ease_type**\ (\ value\: :ref:`EaseType<enum_Tween_EaseType>`\ )
|
||
- :ref:`EaseType<enum_Tween_EaseType>` **get_auto_capture_ease_type**\ (\ )
|
||
|
||
Легкий тип інтерполяції захоплення. Дивіться також :ref:`EaseType<enum_Tween_EaseType>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_property_playback_auto_capture_transition_type:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`TransitionType<enum_Tween_TransitionType>` **playback_auto_capture_transition_type** = ``0`` :ref:`🔗<class_AnimationPlayer_property_playback_auto_capture_transition_type>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_auto_capture_transition_type**\ (\ value\: :ref:`TransitionType<enum_Tween_TransitionType>`\ )
|
||
- :ref:`TransitionType<enum_Tween_TransitionType>` **get_auto_capture_transition_type**\ (\ )
|
||
|
||
Тип переходу інтерполяції захоплення. Дивіться також :ref:`TransitionType<enum_Tween_TransitionType>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_property_playback_default_blend_time:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`float<class_float>` **playback_default_blend_time** = ``0.0`` :ref:`🔗<class_AnimationPlayer_property_playback_default_blend_time>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_default_blend_time**\ (\ value\: :ref:`float<class_float>`\ )
|
||
- :ref:`float<class_float>` **get_default_blend_time**\ (\ )
|
||
|
||
Час за замовчуванням для змішування анімації. Діапазон від 0 до 4096 з точністю до 0.01.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_property_speed_scale:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`float<class_float>` **speed_scale** = ``1.0`` :ref:`🔗<class_AnimationPlayer_property_speed_scale>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_speed_scale**\ (\ value\: :ref:`float<class_float>`\ )
|
||
- :ref:`float<class_float>` **get_speed_scale**\ (\ )
|
||
|
||
Коефіцієнт масштабування швидкості. Наприклад, якщо це значення ``1``, то анімація відтворюється з нормальною швидкістю. Якщо це ``0.5``, то вона відтворюється наполовину швидко. Якщо це ``2``, то анімація відтворюється з подвійною швидкістю.
|
||
|
||
Якщо встановлено від'ємне значення, анімація відтворюється у зворотному напрямку. Якщо встановлено ``0``, анімація не буде відтворюватися.
|
||
|
||
.. rst-class:: classref-section-separator
|
||
|
||
----
|
||
|
||
.. rst-class:: classref-descriptions-group
|
||
|
||
Описи методів
|
||
--------------------------
|
||
|
||
.. _class_AnimationPlayer_method_animation_get_next:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`StringName<class_StringName>` **animation_get_next**\ (\ animation_from\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`🔗<class_AnimationPlayer_method_animation_get_next>`
|
||
|
||
Повертає ключ анімації, яка стоїть у черзі для відтворення після анімації ``animation_from``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_animation_set_next:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **animation_set_next**\ (\ animation_from\: :ref:`StringName<class_StringName>`, animation_to\: :ref:`StringName<class_StringName>`\ ) :ref:`🔗<class_AnimationPlayer_method_animation_set_next>`
|
||
|
||
Запускає анімацію ``animation_to``, коли завершується анімація ``animation_from``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_clear_queue:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **clear_queue**\ (\ ) :ref:`🔗<class_AnimationPlayer_method_clear_queue>`
|
||
|
||
Очищає всі анімації, що стоять у черзі та не відтворюються.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_get_blend_time:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`float<class_float>` **get_blend_time**\ (\ animation_from\: :ref:`StringName<class_StringName>`, animation_to\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`🔗<class_AnimationPlayer_method_get_blend_time>`
|
||
|
||
Повертає час змішування (у секундах) двох анімацій, на які посилаються їхні ключі.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_get_method_call_mode:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`AnimationMethodCallMode<enum_AnimationPlayer_AnimationMethodCallMode>` **get_method_call_mode**\ (\ ) |const| :ref:`🔗<class_AnimationPlayer_method_get_method_call_mode>`
|
||
|
||
**Застаріло:** Use :ref:`AnimationMixer.callback_mode_method<class_AnimationMixer_property_callback_mode_method>` instead.
|
||
|
||
Повертає режим виклику, який використовується для треків "Метод виклику".
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_get_playing_speed:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`float<class_float>` **get_playing_speed**\ (\ ) |const| :ref:`🔗<class_AnimationPlayer_method_get_playing_speed>`
|
||
|
||
Повертає фактичну швидкість відтворення поточної анімації або ``0``, якщо вона не відтворюється. Ця швидкість - це властивість :ref:`speed_scale<class_AnimationPlayer_property_speed_scale>`, помножена на аргумент ``custom_speed``, вказаний при виклику методу :ref:`play()<class_AnimationPlayer_method_play>`.
|
||
|
||
Повертає від'ємне значення, якщо поточна анімація відтворюється у зворотному напрямку.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_get_process_callback:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`AnimationProcessCallback<enum_AnimationPlayer_AnimationProcessCallback>` **get_process_callback**\ (\ ) |const| :ref:`🔗<class_AnimationPlayer_method_get_process_callback>`
|
||
|
||
**Застаріло:** Use :ref:`AnimationMixer.callback_mode_process<class_AnimationMixer_property_callback_mode_process>` instead.
|
||
|
||
Повертає сповіщення про процес, у якому потрібно оновити анімацію.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_get_queue:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Array<class_Array>`\[:ref:`StringName<class_StringName>`\] **get_queue**\ (\ ) :ref:`🔗<class_AnimationPlayer_method_get_queue>`
|
||
|
||
Повертає список ключів анімації, які зараз стоять у черзі для відтворення.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_get_root:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`NodePath<class_NodePath>` **get_root**\ (\ ) |const| :ref:`🔗<class_AnimationPlayer_method_get_root>`
|
||
|
||
**Застаріло:** Use :ref:`AnimationMixer.root_node<class_AnimationMixer_property_root_node>` instead.
|
||
|
||
Повертає вузол, з якого будуть проходити посилання на шлях вузла.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_get_section_end_time:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`float<class_float>` **get_section_end_time**\ (\ ) |const| :ref:`🔗<class_AnimationPlayer_method_get_section_end_time>`
|
||
|
||
Повертає час закінчення розділу, який зараз відтворюється.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_get_section_start_time:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`float<class_float>` **get_section_start_time**\ (\ ) |const| :ref:`🔗<class_AnimationPlayer_method_get_section_start_time>`
|
||
|
||
Повертає час початку розділу, який зараз відтворюється.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_has_section:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **has_section**\ (\ ) |const| :ref:`🔗<class_AnimationPlayer_method_has_section>`
|
||
|
||
Повертає ``true``, якщо анімація наразі відтворюється з певним розділом.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_is_animation_active:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **is_animation_active**\ (\ ) |const| :ref:`🔗<class_AnimationPlayer_method_is_animation_active>`
|
||
|
||
Returns ``true`` if the an animation is currently active. An animation is active if it was played by calling :ref:`play()<class_AnimationPlayer_method_play>` and was not finished yet, or was stopped by calling :ref:`stop()<class_AnimationPlayer_method_stop>`.
|
||
|
||
This can be used to check whether an animation is currently paused or stopped.
|
||
|
||
::
|
||
|
||
var is_paused = not is_playing() and is_animation_active()
|
||
var is_stopped = not is_playing() and not is_animation_active()
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_is_playing:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **is_playing**\ (\ ) |const| :ref:`🔗<class_AnimationPlayer_method_is_playing>`
|
||
|
||
Повертає ``true``, якщо анімація зараз відтворюється (навіть якщо :ref:`speed_scale<class_AnimationPlayer_property_speed_scale>` та/або ``custom_speed`` рівні ``0``).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_pause:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **pause**\ (\ ) :ref:`🔗<class_AnimationPlayer_method_pause>`
|
||
|
||
Призупиняє відтворення поточної анімації. :ref:`current_animation_position<class_AnimationPlayer_property_current_animation_position>` буде збережено, а виклик :ref:`play()<class_AnimationPlayer_method_play>` або :ref:`play_backwards()<class_AnimationPlayer_method_play_backwards>` без аргументів або з тією самою назвою анімації, що й :ref:`assigned_animation<class_AnimationPlayer_property_assigned_animation>`, відновить анімацію.
|
||
|
||
Дивіться також :ref:`stop()<class_AnimationPlayer_method_stop>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_play:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **play**\ (\ name\: :ref:`StringName<class_StringName>` = &"", custom_blend\: :ref:`float<class_float>` = -1, custom_speed\: :ref:`float<class_float>` = 1.0, from_end\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_AnimationPlayer_method_play>`
|
||
|
||
Відтворює анімацію за допомогою клавіші ``name``. Можна встановити власний час та швидкість накладання.
|
||
|
||
Параметр ``from_end`` впливає лише при переході на нову доріжку анімації або на ту саму доріжку, але на початку або в кінці. Він не впливає на відновлення відтворення, яке було призупинено посеред анімації. Якщо ``custom_speed`` має від'ємне значення, а ``from_end`` - ``true``, анімація буде відтворюватися у зворотному напрямку (що еквівалентно виклику :ref:`play_backwards()<class_AnimationPlayer_method_play_backwards>`).
|
||
|
||
Програвач **AnimationPlayer** відстежує поточну або останню відтворену анімацію за допомогою :ref:`assigned_animation<class_AnimationPlayer_property_assigned_animation>`. Якщо цей метод викликати з тією самою анімацією ``name`` або без параметра ``name``, призначена анімація відновить відтворення, якщо її було призупинено.
|
||
|
||
\ **Примітка:** Анімацію буде оновлено при наступній обробці **AnimationPlayer**. Якщо інші змінні оновлюються одночасно з цим викликом, вони можуть бути оновлені занадто рано. Щоб виконати оновлення негайно, викличте ``advance(0)``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_play_backwards:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **play_backwards**\ (\ name\: :ref:`StringName<class_StringName>` = &"", custom_blend\: :ref:`float<class_float>` = -1\ ) :ref:`🔗<class_AnimationPlayer_method_play_backwards>`
|
||
|
||
Відтворює анімацію з ключем ``name`` у зворотному напрямку.
|
||
|
||
Цей метод є скороченням від :ref:`play()<class_AnimationPlayer_method_play>` з ``custom_speed = -1.0`` і ``from_end = true``, тому дивіться його опис для додаткової інформації.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_play_section:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **play_section**\ (\ name\: :ref:`StringName<class_StringName>` = &"", start_time\: :ref:`float<class_float>` = -1, end_time\: :ref:`float<class_float>` = -1, custom_blend\: :ref:`float<class_float>` = -1, custom_speed\: :ref:`float<class_float>` = 1.0, from_end\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_AnimationPlayer_method_play_section>`
|
||
|
||
Відтворює анімацію з ключем ``name`` і розділом, починаючи з ``start_time`` і закінчуючи ``end_time``. Дивіться також :ref:`play()<class_AnimationPlayer_method_play>`.
|
||
|
||
Встановлення ``start_time`` значення поза межами діапазону анімації означає, що замість цього буде використано початок анімації, а встановлення ``end_time`` значення поза діапазоном анімації означає, що замість цього буде використано кінець анімації. ``start_time`` не може дорівнювати ``end_time``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_play_section_backwards:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **play_section_backwards**\ (\ name\: :ref:`StringName<class_StringName>` = &"", start_time\: :ref:`float<class_float>` = -1, end_time\: :ref:`float<class_float>` = -1, custom_blend\: :ref:`float<class_float>` = -1\ ) :ref:`🔗<class_AnimationPlayer_method_play_section_backwards>`
|
||
|
||
Відтворює анімацію з ключем ``name`` і розділом, починаючи з ``start_time`` і закінчуючи ``end_time`` у зворотному порядку.
|
||
|
||
Цей метод є скороченням для :ref:`play_section()<class_AnimationPlayer_method_play_section>` з ``custom_speed = -1.0`` і ``from_end = true``, див. його опис для отримання додаткової інформації.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_play_section_with_markers:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **play_section_with_markers**\ (\ name\: :ref:`StringName<class_StringName>` = &"", start_marker\: :ref:`StringName<class_StringName>` = &"", end_marker\: :ref:`StringName<class_StringName>` = &"", custom_blend\: :ref:`float<class_float>` = -1, custom_speed\: :ref:`float<class_float>` = 1.0, from_end\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_AnimationPlayer_method_play_section_with_markers>`
|
||
|
||
Відтворює анімацію з ключем ``name`` і розділом, що починається від ``start_marker`` і закінчується на ``end_marker``.
|
||
|
||
Якщо маркер початку порожній, розділ починається з початку анімації. Якщо маркер кінця порожній, розділ закінчується в кінці анімації. Дивіться також :ref:`play()<class_AnimationPlayer_method_play>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_play_section_with_markers_backwards:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **play_section_with_markers_backwards**\ (\ name\: :ref:`StringName<class_StringName>` = &"", start_marker\: :ref:`StringName<class_StringName>` = &"", end_marker\: :ref:`StringName<class_StringName>` = &"", custom_blend\: :ref:`float<class_float>` = -1\ ) :ref:`🔗<class_AnimationPlayer_method_play_section_with_markers_backwards>`
|
||
|
||
Відтворює анімацію з ключем ``name`` і секцією, що починається від ``start_marker`` і закінчується на ``end_marker`` у зворотному порядку.
|
||
|
||
Цей метод є скороченням для :ref:`play_section_with_markers()<class_AnimationPlayer_method_play_section_with_markers>` з ``custom_speed = -1.0`` і ``from_end = true``, див. його опис для отримання додаткової інформації.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_play_with_capture:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **play_with_capture**\ (\ name\: :ref:`StringName<class_StringName>` = &"", duration\: :ref:`float<class_float>` = -1.0, custom_blend\: :ref:`float<class_float>` = -1, custom_speed\: :ref:`float<class_float>` = 1.0, from_end\: :ref:`bool<class_bool>` = false, trans_type\: :ref:`TransitionType<enum_Tween_TransitionType>` = 0, ease_type\: :ref:`EaseType<enum_Tween_EaseType>` = 0\ ) :ref:`🔗<class_AnimationPlayer_method_play_with_capture>`
|
||
|
||
Дивіться також :ref:`AnimationMixer.capture()<class_AnimationMixer_method_capture>`.
|
||
|
||
Ви можете використовувати цей метод, щоб використовувати більш детальні параметри захоплення, ніж ті, які виконує :ref:`playback_auto_capture<class_AnimationPlayer_property_playback_auto_capture>`. Коли :ref:`playback_auto_capture<class_AnimationPlayer_property_playback_auto_capture>` має значення ``false``, цей метод майже такий самий, як і наступний:
|
||
|
||
::
|
||
|
||
capture(name, duration, trans_type, ease_type)
|
||
play (name, custom_blend, custom_speed, from_end)
|
||
|
||
Якщо ``name`` порожнє, воно визначає :ref:`assigned_animation<class_AnimationPlayer_property_assigned_animation>`.
|
||
|
||
Якщо ``duration`` є від’ємним значенням, тривалість встановлюється на інтервал між поточною позицією та першим ключем, коли ``from_end`` має значення ``true``, використовується інтервал між поточною позицією та першим ключем. натомість останній ключ.
|
||
|
||
\ **Примітка:** ``duration`` враховує :ref:`speed_scale<class_AnimationPlayer_property_speed_scale>`, а ``custom_speed`` — ні, оскільки кеш захоплення інтерполюється з результатом змішування, і результат може містити кілька анімацій.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_queue:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **queue**\ (\ name\: :ref:`StringName<class_StringName>`\ ) :ref:`🔗<class_AnimationPlayer_method_queue>`
|
||
|
||
Ставить анімацію в чергу для відтворення після завершення поточної анімації та всіх попередніх анімацій у черзі.
|
||
|
||
\ **Примітка.** Якщо зараз відтворюється зациклена анімацію, анімація, яка стоїть у черзі, ніколи не відтворюватиметься, якщо її якось не зупинити.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_reset_section:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **reset_section**\ (\ ) :ref:`🔗<class_AnimationPlayer_method_reset_section>`
|
||
|
||
Скидає поточний розділ. Нічого не робить, якщо розділ не було встановлено.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_seek:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **seek**\ (\ seconds\: :ref:`float<class_float>`, update\: :ref:`bool<class_bool>` = false, update_only\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_AnimationPlayer_method_seek>`
|
||
|
||
Перегляд анімації на точку ``seconds`` (в секундах). Якщо ``update`` є ``true``, анімація оновлень теж, інакше він оновлюється в час процесу. Заходи між поточною рамою та ``seconds`` пропускаються.
|
||
|
||
Якщо ``update_only`` є ``true``, метод / аудіо / анімація відтворення треків не буде оброблятися.
|
||
|
||
\ **Примітка:** Подивитися до кінця анімації не випромінює :ref:`AnimationMixer.animation_finished<class_AnimationMixer_signal_animation_finished>`. Якщо ви хочете пропустити анімацію і випромінювати сигнал, скористайтеся :ref:`AnimationMixe.advance()<class_AnimationMixe_method_advance>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_set_blend_time:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **set_blend_time**\ (\ animation_from\: :ref:`StringName<class_StringName>`, animation_to\: :ref:`StringName<class_StringName>`, sec\: :ref:`float<class_float>`\ ) :ref:`🔗<class_AnimationPlayer_method_set_blend_time>`
|
||
|
||
Задає час змішування (у секундах) двох анімацій, на які посилаються їхні ключі.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_set_method_call_mode:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **set_method_call_mode**\ (\ mode\: :ref:`AnimationMethodCallMode<enum_AnimationPlayer_AnimationMethodCallMode>`\ ) :ref:`🔗<class_AnimationPlayer_method_set_method_call_mode>`
|
||
|
||
**Застаріло:** Use :ref:`AnimationMixer.callback_mode_method<class_AnimationMixer_property_callback_mode_method>` instead.
|
||
|
||
Встановлює режим виклику, який використовується для треків "Метод виклику".
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_set_process_callback:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **set_process_callback**\ (\ mode\: :ref:`AnimationProcessCallback<enum_AnimationPlayer_AnimationProcessCallback>`\ ) :ref:`🔗<class_AnimationPlayer_method_set_process_callback>`
|
||
|
||
**Застаріло:** Use :ref:`AnimationMixer.callback_mode_process<class_AnimationMixer_property_callback_mode_process>` instead.
|
||
|
||
Встановлює сповіщення процесу для оновлення анімацій.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_set_root:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **set_root**\ (\ path\: :ref:`NodePath<class_NodePath>`\ ) :ref:`🔗<class_AnimationPlayer_method_set_root>`
|
||
|
||
**Застаріло:** Use :ref:`AnimationMixer.root_node<class_AnimationMixer_property_root_node>` instead.
|
||
|
||
Встановлює вузол, з якого переходитимуть посилання на шлях вузла.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_set_section:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **set_section**\ (\ start_time\: :ref:`float<class_float>` = -1, end_time\: :ref:`float<class_float>` = -1\ ) :ref:`🔗<class_AnimationPlayer_method_set_section>`
|
||
|
||
Змінює час початку та закінчення відтворюваного розділу. Поточне положення відтворення буде зафіксовано в новому розділі. Дивіться також :ref:`play_section()<class_AnimationPlayer_method_play_section>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_set_section_with_markers:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **set_section_with_markers**\ (\ start_marker\: :ref:`StringName<class_StringName>` = &"", end_marker\: :ref:`StringName<class_StringName>` = &""\ ) :ref:`🔗<class_AnimationPlayer_method_set_section_with_markers>`
|
||
|
||
Змінює маркери початку та кінця розділу, що відтворюється. Поточне положення відтворення буде зафіксовано в новому розділі. Дивіться також :ref:`play_section_with_markers()<class_AnimationPlayer_method_play_section_with_markers>`.
|
||
|
||
Якщо аргумент порожній, розділ використовує початок або кінець анімації. Якщо обидва порожні, це означає, що розділ не встановлено.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_AnimationPlayer_method_stop:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **stop**\ (\ keep_state\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_AnimationPlayer_method_stop>`
|
||
|
||
Зупиняє відтворення поточної анімації. Позицію анімації буде скинуто до ``0``, а ``custom_speed`` буде скинуто до ``1.0``. Дивіться також :ref:`pause()<class_AnimationPlayer_method_pause>`.
|
||
|
||
Якщо ``keep_state`` має значення ``true``, стан анімації не оновлюється візуально.
|
||
|
||
\ **Примітка:** Доріжки відтворення методу / аудіо / анімації не будуть оброблятися цим методом.
|
||
|
||
.. |virtual| replace:: :abbr:`virtual (Зазвичай, цей метод перевизначається користувачем, щоб він мав вплив.)`
|
||
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
|
||
.. |const| replace:: :abbr:`const (Цей метод не має побічних ефектів. Не змінює ніяку змінну екземпляра об'єкта.)`
|
||
.. |vararg| replace:: :abbr:`vararg (Цей метод приймає будь-яке число аргументів після описаних тут.)`
|
||
.. |constructor| replace:: :abbr:`constructor (Цей метод використовується для побудови типів.)`
|
||
.. |static| replace:: :abbr:`static (Цей метод не потребує екземпляра для виклику, його можна викликати безпосередньо за допомогою назви класу.)`
|
||
.. |operator| replace:: :abbr:`operator (Цей метод описує дійсний оператор для взаємодії з цим типом як з лівим операндом.)`
|
||
.. |bitfield| replace:: :abbr:`BitField (Це значення є цілим числом, складеним у вигляді бітової маски з наступних прапорів.)`
|
||
.. |void| replace:: :abbr:`void (Значення не повертається.)`
|