class_animationmixer.rst 51 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationMixer.xml.
  6. .. _class_AnimationMixer:
  7. AnimationMixer
  8. ==============
  9. **Inherits:** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  10. **Inherited By:** :ref:`AnimationPlayer<class_AnimationPlayer>`, :ref:`AnimationTree<class_AnimationTree>`
  11. Base class for :ref:`AnimationPlayer<class_AnimationPlayer>` and :ref:`AnimationTree<class_AnimationTree>`.
  12. .. rst-class:: classref-introduction-group
  13. Description
  14. -----------
  15. Base class for :ref:`AnimationPlayer<class_AnimationPlayer>` and :ref:`AnimationTree<class_AnimationTree>` to manage animation lists. It also has general properties and methods for playback and blending.
  16. After instantiating the playback information data within the extended class, the blending is processed by the **AnimationMixer**.
  17. .. rst-class:: classref-reftable-group
  18. Properties
  19. ----------
  20. .. table::
  21. :widths: auto
  22. +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+--------------------+
  23. | :ref:`bool<class_bool>` | :ref:`active<class_AnimationMixer_property_active>` | ``true`` |
  24. +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+--------------------+
  25. | :ref:`int<class_int>` | :ref:`audio_max_polyphony<class_AnimationMixer_property_audio_max_polyphony>` | ``32`` |
  26. +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+--------------------+
  27. | :ref:`AnimationCallbackModeDiscrete<enum_AnimationMixer_AnimationCallbackModeDiscrete>` | :ref:`callback_mode_discrete<class_AnimationMixer_property_callback_mode_discrete>` | ``0`` |
  28. +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+--------------------+
  29. | :ref:`AnimationCallbackModeMethod<enum_AnimationMixer_AnimationCallbackModeMethod>` | :ref:`callback_mode_method<class_AnimationMixer_property_callback_mode_method>` | ``0`` |
  30. +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+--------------------+
  31. | :ref:`AnimationCallbackModeProcess<enum_AnimationMixer_AnimationCallbackModeProcess>` | :ref:`callback_mode_process<class_AnimationMixer_property_callback_mode_process>` | ``1`` |
  32. +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+--------------------+
  33. | :ref:`bool<class_bool>` | :ref:`deterministic<class_AnimationMixer_property_deterministic>` | ``false`` |
  34. +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+--------------------+
  35. | :ref:`bool<class_bool>` | :ref:`reset_on_save<class_AnimationMixer_property_reset_on_save>` | ``true`` |
  36. +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+--------------------+
  37. | :ref:`NodePath<class_NodePath>` | :ref:`root_motion_track<class_AnimationMixer_property_root_motion_track>` | ``NodePath("")`` |
  38. +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+--------------------+
  39. | :ref:`NodePath<class_NodePath>` | :ref:`root_node<class_AnimationMixer_property_root_node>` | ``NodePath("..")`` |
  40. +-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+--------------------+
  41. .. rst-class:: classref-reftable-group
  42. Methods
  43. -------
  44. .. table::
  45. :widths: auto
  46. +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  47. | :ref:`Variant<class_Variant>` | :ref:`_post_process_key_value<class_AnimationMixer_private_method__post_process_key_value>`\ (\ animation\: :ref:`Animation<class_Animation>`, track\: :ref:`int<class_int>`, value\: :ref:`Variant<class_Variant>`, object_id\: :ref:`int<class_int>`, object_sub_idx\: :ref:`int<class_int>`\ ) |virtual| |const| |
  48. +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  49. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`add_animation_library<class_AnimationMixer_method_add_animation_library>`\ (\ name\: :ref:`StringName<class_StringName>`, library\: :ref:`AnimationLibrary<class_AnimationLibrary>`\ ) |
  50. +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | |void| | :ref:`advance<class_AnimationMixer_method_advance>`\ (\ delta\: :ref:`float<class_float>`\ ) |
  52. +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  53. | |void| | :ref:`capture<class_AnimationMixer_method_capture>`\ (\ name\: :ref:`StringName<class_StringName>`, duration\: :ref:`float<class_float>`, trans_type\: :ref:`TransitionType<enum_Tween_TransitionType>` = 0, ease_type\: :ref:`EaseType<enum_Tween_EaseType>` = 0\ ) |
  54. +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  55. | |void| | :ref:`clear_caches<class_AnimationMixer_method_clear_caches>`\ (\ ) |
  56. +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  57. | :ref:`StringName<class_StringName>` | :ref:`find_animation<class_AnimationMixer_method_find_animation>`\ (\ animation\: :ref:`Animation<class_Animation>`\ ) |const| |
  58. +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  59. | :ref:`StringName<class_StringName>` | :ref:`find_animation_library<class_AnimationMixer_method_find_animation_library>`\ (\ animation\: :ref:`Animation<class_Animation>`\ ) |const| |
  60. +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | :ref:`Animation<class_Animation>` | :ref:`get_animation<class_AnimationMixer_method_get_animation>`\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const| |
  62. +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  63. | :ref:`AnimationLibrary<class_AnimationLibrary>` | :ref:`get_animation_library<class_AnimationMixer_method_get_animation_library>`\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const| |
  64. +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  65. | :ref:`Array<class_Array>`\[:ref:`StringName<class_StringName>`\] | :ref:`get_animation_library_list<class_AnimationMixer_method_get_animation_library_list>`\ (\ ) |const| |
  66. +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  67. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_animation_list<class_AnimationMixer_method_get_animation_list>`\ (\ ) |const| |
  68. +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  69. | :ref:`Vector3<class_Vector3>` | :ref:`get_root_motion_position<class_AnimationMixer_method_get_root_motion_position>`\ (\ ) |const| |
  70. +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  71. | :ref:`Vector3<class_Vector3>` | :ref:`get_root_motion_position_accumulator<class_AnimationMixer_method_get_root_motion_position_accumulator>`\ (\ ) |const| |
  72. +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  73. | :ref:`Quaternion<class_Quaternion>` | :ref:`get_root_motion_rotation<class_AnimationMixer_method_get_root_motion_rotation>`\ (\ ) |const| |
  74. +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  75. | :ref:`Quaternion<class_Quaternion>` | :ref:`get_root_motion_rotation_accumulator<class_AnimationMixer_method_get_root_motion_rotation_accumulator>`\ (\ ) |const| |
  76. +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  77. | :ref:`Vector3<class_Vector3>` | :ref:`get_root_motion_scale<class_AnimationMixer_method_get_root_motion_scale>`\ (\ ) |const| |
  78. +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  79. | :ref:`Vector3<class_Vector3>` | :ref:`get_root_motion_scale_accumulator<class_AnimationMixer_method_get_root_motion_scale_accumulator>`\ (\ ) |const| |
  80. +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  81. | :ref:`bool<class_bool>` | :ref:`has_animation<class_AnimationMixer_method_has_animation>`\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const| |
  82. +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  83. | :ref:`bool<class_bool>` | :ref:`has_animation_library<class_AnimationMixer_method_has_animation_library>`\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const| |
  84. +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  85. | |void| | :ref:`remove_animation_library<class_AnimationMixer_method_remove_animation_library>`\ (\ name\: :ref:`StringName<class_StringName>`\ ) |
  86. +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  87. | |void| | :ref:`rename_animation_library<class_AnimationMixer_method_rename_animation_library>`\ (\ name\: :ref:`StringName<class_StringName>`, newname\: :ref:`StringName<class_StringName>`\ ) |
  88. +------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  89. .. rst-class:: classref-section-separator
  90. ----
  91. .. rst-class:: classref-descriptions-group
  92. Signals
  93. -------
  94. .. _class_AnimationMixer_signal_animation_finished:
  95. .. rst-class:: classref-signal
  96. **animation_finished**\ (\ anim_name\: :ref:`StringName<class_StringName>`\ )
  97. Notifies when an animation finished playing.
  98. \ **Note:** This signal is not emitted if an animation is looping.
  99. .. rst-class:: classref-item-separator
  100. ----
  101. .. _class_AnimationMixer_signal_animation_libraries_updated:
  102. .. rst-class:: classref-signal
  103. **animation_libraries_updated**\ (\ )
  104. Notifies when the animation libraries have changed.
  105. .. rst-class:: classref-item-separator
  106. ----
  107. .. _class_AnimationMixer_signal_animation_list_changed:
  108. .. rst-class:: classref-signal
  109. **animation_list_changed**\ (\ )
  110. Notifies when an animation list is changed.
  111. .. rst-class:: classref-item-separator
  112. ----
  113. .. _class_AnimationMixer_signal_animation_started:
  114. .. rst-class:: classref-signal
  115. **animation_started**\ (\ anim_name\: :ref:`StringName<class_StringName>`\ )
  116. Notifies when an animation starts playing.
  117. .. rst-class:: classref-item-separator
  118. ----
  119. .. _class_AnimationMixer_signal_caches_cleared:
  120. .. rst-class:: classref-signal
  121. **caches_cleared**\ (\ )
  122. Notifies when the caches have been cleared, either automatically, or manually via :ref:`clear_caches<class_AnimationMixer_method_clear_caches>`.
  123. .. rst-class:: classref-item-separator
  124. ----
  125. .. _class_AnimationMixer_signal_mixer_updated:
  126. .. rst-class:: classref-signal
  127. **mixer_updated**\ (\ )
  128. Editor only. Notifies when the property have been updated to update dummy :ref:`AnimationPlayer<class_AnimationPlayer>` in animation player editor.
  129. .. rst-class:: classref-section-separator
  130. ----
  131. .. rst-class:: classref-descriptions-group
  132. Enumerations
  133. ------------
  134. .. _enum_AnimationMixer_AnimationCallbackModeProcess:
  135. .. rst-class:: classref-enumeration
  136. enum **AnimationCallbackModeProcess**:
  137. .. _class_AnimationMixer_constant_ANIMATION_CALLBACK_MODE_PROCESS_PHYSICS:
  138. .. rst-class:: classref-enumeration-constant
  139. :ref:`AnimationCallbackModeProcess<enum_AnimationMixer_AnimationCallbackModeProcess>` **ANIMATION_CALLBACK_MODE_PROCESS_PHYSICS** = ``0``
  140. Process animation during physics frames (see :ref:`Node.NOTIFICATION_INTERNAL_PHYSICS_PROCESS<class_Node_constant_NOTIFICATION_INTERNAL_PHYSICS_PROCESS>`). This is especially useful when animating physics bodies.
  141. .. _class_AnimationMixer_constant_ANIMATION_CALLBACK_MODE_PROCESS_IDLE:
  142. .. rst-class:: classref-enumeration-constant
  143. :ref:`AnimationCallbackModeProcess<enum_AnimationMixer_AnimationCallbackModeProcess>` **ANIMATION_CALLBACK_MODE_PROCESS_IDLE** = ``1``
  144. Process animation during process frames (see :ref:`Node.NOTIFICATION_INTERNAL_PROCESS<class_Node_constant_NOTIFICATION_INTERNAL_PROCESS>`).
  145. .. _class_AnimationMixer_constant_ANIMATION_CALLBACK_MODE_PROCESS_MANUAL:
  146. .. rst-class:: classref-enumeration-constant
  147. :ref:`AnimationCallbackModeProcess<enum_AnimationMixer_AnimationCallbackModeProcess>` **ANIMATION_CALLBACK_MODE_PROCESS_MANUAL** = ``2``
  148. Do not process animation. Use :ref:`advance<class_AnimationMixer_method_advance>` to process the animation manually.
  149. .. rst-class:: classref-item-separator
  150. ----
  151. .. _enum_AnimationMixer_AnimationCallbackModeMethod:
  152. .. rst-class:: classref-enumeration
  153. enum **AnimationCallbackModeMethod**:
  154. .. _class_AnimationMixer_constant_ANIMATION_CALLBACK_MODE_METHOD_DEFERRED:
  155. .. rst-class:: classref-enumeration-constant
  156. :ref:`AnimationCallbackModeMethod<enum_AnimationMixer_AnimationCallbackModeMethod>` **ANIMATION_CALLBACK_MODE_METHOD_DEFERRED** = ``0``
  157. 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.
  158. .. _class_AnimationMixer_constant_ANIMATION_CALLBACK_MODE_METHOD_IMMEDIATE:
  159. .. rst-class:: classref-enumeration-constant
  160. :ref:`AnimationCallbackModeMethod<enum_AnimationMixer_AnimationCallbackModeMethod>` **ANIMATION_CALLBACK_MODE_METHOD_IMMEDIATE** = ``1``
  161. Make method calls immediately when reached in the animation.
  162. .. rst-class:: classref-item-separator
  163. ----
  164. .. _enum_AnimationMixer_AnimationCallbackModeDiscrete:
  165. .. rst-class:: classref-enumeration
  166. enum **AnimationCallbackModeDiscrete**:
  167. .. _class_AnimationMixer_constant_ANIMATION_CALLBACK_MODE_DISCRETE_DOMINANT:
  168. .. rst-class:: classref-enumeration-constant
  169. :ref:`AnimationCallbackModeDiscrete<enum_AnimationMixer_AnimationCallbackModeDiscrete>` **ANIMATION_CALLBACK_MODE_DISCRETE_DOMINANT** = ``0``
  170. An :ref:`Animation.UPDATE_DISCRETE<class_Animation_constant_UPDATE_DISCRETE>` track value takes precedence when blending :ref:`Animation.UPDATE_CONTINUOUS<class_Animation_constant_UPDATE_CONTINUOUS>` or :ref:`Animation.UPDATE_CAPTURE<class_Animation_constant_UPDATE_CAPTURE>` track values and :ref:`Animation.UPDATE_DISCRETE<class_Animation_constant_UPDATE_DISCRETE>` track values. This is the default behavior for :ref:`AnimationPlayer<class_AnimationPlayer>`.
  171. \ **Note:** If a value track has non-numeric type key values, it is internally converted to use :ref:`ANIMATION_CALLBACK_MODE_DISCRETE_DOMINANT<class_AnimationMixer_constant_ANIMATION_CALLBACK_MODE_DISCRETE_DOMINANT>` with :ref:`Animation.UPDATE_DISCRETE<class_Animation_constant_UPDATE_DISCRETE>`.
  172. .. _class_AnimationMixer_constant_ANIMATION_CALLBACK_MODE_DISCRETE_RECESSIVE:
  173. .. rst-class:: classref-enumeration-constant
  174. :ref:`AnimationCallbackModeDiscrete<enum_AnimationMixer_AnimationCallbackModeDiscrete>` **ANIMATION_CALLBACK_MODE_DISCRETE_RECESSIVE** = ``1``
  175. An :ref:`Animation.UPDATE_CONTINUOUS<class_Animation_constant_UPDATE_CONTINUOUS>` or :ref:`Animation.UPDATE_CAPTURE<class_Animation_constant_UPDATE_CAPTURE>` track value takes precedence when blending the :ref:`Animation.UPDATE_CONTINUOUS<class_Animation_constant_UPDATE_CONTINUOUS>` or :ref:`Animation.UPDATE_CAPTURE<class_Animation_constant_UPDATE_CAPTURE>` track values and the :ref:`Animation.UPDATE_DISCRETE<class_Animation_constant_UPDATE_DISCRETE>` track values.
  176. .. _class_AnimationMixer_constant_ANIMATION_CALLBACK_MODE_DISCRETE_FORCE_CONTINUOUS:
  177. .. rst-class:: classref-enumeration-constant
  178. :ref:`AnimationCallbackModeDiscrete<enum_AnimationMixer_AnimationCallbackModeDiscrete>` **ANIMATION_CALLBACK_MODE_DISCRETE_FORCE_CONTINUOUS** = ``2``
  179. Always treat the :ref:`Animation.UPDATE_DISCRETE<class_Animation_constant_UPDATE_DISCRETE>` track value as :ref:`Animation.UPDATE_CONTINUOUS<class_Animation_constant_UPDATE_CONTINUOUS>` with :ref:`Animation.INTERPOLATION_NEAREST<class_Animation_constant_INTERPOLATION_NEAREST>`. This is the default behavior for :ref:`AnimationTree<class_AnimationTree>`.
  180. .. rst-class:: classref-section-separator
  181. ----
  182. .. rst-class:: classref-descriptions-group
  183. Property Descriptions
  184. ---------------------
  185. .. _class_AnimationMixer_property_active:
  186. .. rst-class:: classref-property
  187. :ref:`bool<class_bool>` **active** = ``true``
  188. .. rst-class:: classref-property-setget
  189. - |void| **set_active**\ (\ value\: :ref:`bool<class_bool>`\ )
  190. - :ref:`bool<class_bool>` **is_active**\ (\ )
  191. If ``true``, the **AnimationMixer** will be processing.
  192. .. rst-class:: classref-item-separator
  193. ----
  194. .. _class_AnimationMixer_property_audio_max_polyphony:
  195. .. rst-class:: classref-property
  196. :ref:`int<class_int>` **audio_max_polyphony** = ``32``
  197. .. rst-class:: classref-property-setget
  198. - |void| **set_audio_max_polyphony**\ (\ value\: :ref:`int<class_int>`\ )
  199. - :ref:`int<class_int>` **get_audio_max_polyphony**\ (\ )
  200. The number of possible simultaneous sounds for each of the assigned AudioStreamPlayers.
  201. For example, if this value is ``32`` and the animation has two audio tracks, the two :ref:`AudioStreamPlayer<class_AudioStreamPlayer>`\ s assigned can play simultaneously up to ``32`` voices each.
  202. .. rst-class:: classref-item-separator
  203. ----
  204. .. _class_AnimationMixer_property_callback_mode_discrete:
  205. .. rst-class:: classref-property
  206. :ref:`AnimationCallbackModeDiscrete<enum_AnimationMixer_AnimationCallbackModeDiscrete>` **callback_mode_discrete** = ``0``
  207. .. rst-class:: classref-property-setget
  208. - |void| **set_callback_mode_discrete**\ (\ value\: :ref:`AnimationCallbackModeDiscrete<enum_AnimationMixer_AnimationCallbackModeDiscrete>`\ )
  209. - :ref:`AnimationCallbackModeDiscrete<enum_AnimationMixer_AnimationCallbackModeDiscrete>` **get_callback_mode_discrete**\ (\ )
  210. Ordinarily, tracks can be set to :ref:`Animation.UPDATE_DISCRETE<class_Animation_constant_UPDATE_DISCRETE>` to update infrequently, usually when using nearest interpolation.
  211. However, when blending with :ref:`Animation.UPDATE_CONTINUOUS<class_Animation_constant_UPDATE_CONTINUOUS>` several results are considered. The :ref:`callback_mode_discrete<class_AnimationMixer_property_callback_mode_discrete>` specify it explicitly. See also :ref:`AnimationCallbackModeDiscrete<enum_AnimationMixer_AnimationCallbackModeDiscrete>`.
  212. To make the blended results look good, it is recommended to set this to :ref:`ANIMATION_CALLBACK_MODE_DISCRETE_FORCE_CONTINUOUS<class_AnimationMixer_constant_ANIMATION_CALLBACK_MODE_DISCRETE_FORCE_CONTINUOUS>` to update every frame during blending. Other values exist for compatibility and they are fine if there is no blending, but not so, may produce artifacts.
  213. .. rst-class:: classref-item-separator
  214. ----
  215. .. _class_AnimationMixer_property_callback_mode_method:
  216. .. rst-class:: classref-property
  217. :ref:`AnimationCallbackModeMethod<enum_AnimationMixer_AnimationCallbackModeMethod>` **callback_mode_method** = ``0``
  218. .. rst-class:: classref-property-setget
  219. - |void| **set_callback_mode_method**\ (\ value\: :ref:`AnimationCallbackModeMethod<enum_AnimationMixer_AnimationCallbackModeMethod>`\ )
  220. - :ref:`AnimationCallbackModeMethod<enum_AnimationMixer_AnimationCallbackModeMethod>` **get_callback_mode_method**\ (\ )
  221. The call mode used for "Call Method" tracks.
  222. .. rst-class:: classref-item-separator
  223. ----
  224. .. _class_AnimationMixer_property_callback_mode_process:
  225. .. rst-class:: classref-property
  226. :ref:`AnimationCallbackModeProcess<enum_AnimationMixer_AnimationCallbackModeProcess>` **callback_mode_process** = ``1``
  227. .. rst-class:: classref-property-setget
  228. - |void| **set_callback_mode_process**\ (\ value\: :ref:`AnimationCallbackModeProcess<enum_AnimationMixer_AnimationCallbackModeProcess>`\ )
  229. - :ref:`AnimationCallbackModeProcess<enum_AnimationMixer_AnimationCallbackModeProcess>` **get_callback_mode_process**\ (\ )
  230. The process notification in which to update animations.
  231. .. rst-class:: classref-item-separator
  232. ----
  233. .. _class_AnimationMixer_property_deterministic:
  234. .. rst-class:: classref-property
  235. :ref:`bool<class_bool>` **deterministic** = ``false``
  236. .. rst-class:: classref-property-setget
  237. - |void| **set_deterministic**\ (\ value\: :ref:`bool<class_bool>`\ )
  238. - :ref:`bool<class_bool>` **is_deterministic**\ (\ )
  239. If ``true``, the blending uses the deterministic algorithm. The total weight is not normalized and the result is accumulated with an initial value (``0`` or a ``"RESET"`` animation if present).
  240. This means that if the total amount of blending is ``0.0``, the result is equal to the ``"RESET"`` animation.
  241. If the number of tracks between the blended animations is different, the animation with the missing track is treated as if it had the initial value.
  242. If ``false``, The blend does not use the deterministic algorithm. The total weight is normalized and always ``1.0``. If the number of tracks between the blended animations is different, nothing is done about the animation that is missing a track.
  243. \ **Note:** In :ref:`AnimationTree<class_AnimationTree>`, the blending with :ref:`AnimationNodeAdd2<class_AnimationNodeAdd2>`, :ref:`AnimationNodeAdd3<class_AnimationNodeAdd3>`, :ref:`AnimationNodeSub2<class_AnimationNodeSub2>` or the weight greater than ``1.0`` may produce unexpected results.
  244. For example, if :ref:`AnimationNodeAdd2<class_AnimationNodeAdd2>` blends two nodes with the amount ``1.0``, then total weight is ``2.0`` but it will be normalized to make the total amount ``1.0`` and the result will be equal to :ref:`AnimationNodeBlend2<class_AnimationNodeBlend2>` with the amount ``0.5``.
  245. .. rst-class:: classref-item-separator
  246. ----
  247. .. _class_AnimationMixer_property_reset_on_save:
  248. .. rst-class:: classref-property
  249. :ref:`bool<class_bool>` **reset_on_save** = ``true``
  250. .. rst-class:: classref-property-setget
  251. - |void| **set_reset_on_save_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
  252. - :ref:`bool<class_bool>` **is_reset_on_save_enabled**\ (\ )
  253. This is used by the editor. If set to ``true``, the scene will be saved with the effects of the reset animation (the animation with the key ``"RESET"``) applied as if it had been seeked to time 0, with the editor keeping the values that the scene had before saving.
  254. This makes it more convenient to preview and edit animations in the editor, as changes to the scene will not be saved as long as they are set in the reset animation.
  255. .. rst-class:: classref-item-separator
  256. ----
  257. .. _class_AnimationMixer_property_root_motion_track:
  258. .. rst-class:: classref-property
  259. :ref:`NodePath<class_NodePath>` **root_motion_track** = ``NodePath("")``
  260. .. rst-class:: classref-property-setget
  261. - |void| **set_root_motion_track**\ (\ value\: :ref:`NodePath<class_NodePath>`\ )
  262. - :ref:`NodePath<class_NodePath>` **get_root_motion_track**\ (\ )
  263. The path to the Animation track used for root motion. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. To specify a track that controls properties or bones, append its name after the path, separated by ``":"``. For example, ``"character/skeleton:ankle"`` or ``"character/mesh:transform/local"``.
  264. If the track has type :ref:`Animation.TYPE_POSITION_3D<class_Animation_constant_TYPE_POSITION_3D>`, :ref:`Animation.TYPE_ROTATION_3D<class_Animation_constant_TYPE_ROTATION_3D>` or :ref:`Animation.TYPE_SCALE_3D<class_Animation_constant_TYPE_SCALE_3D>` the transformation will be canceled visually, and the animation will appear to stay in place. See also :ref:`get_root_motion_position<class_AnimationMixer_method_get_root_motion_position>`, :ref:`get_root_motion_rotation<class_AnimationMixer_method_get_root_motion_rotation>`, :ref:`get_root_motion_scale<class_AnimationMixer_method_get_root_motion_scale>` and :ref:`RootMotionView<class_RootMotionView>`.
  265. .. rst-class:: classref-item-separator
  266. ----
  267. .. _class_AnimationMixer_property_root_node:
  268. .. rst-class:: classref-property
  269. :ref:`NodePath<class_NodePath>` **root_node** = ``NodePath("..")``
  270. .. rst-class:: classref-property-setget
  271. - |void| **set_root_node**\ (\ value\: :ref:`NodePath<class_NodePath>`\ )
  272. - :ref:`NodePath<class_NodePath>` **get_root_node**\ (\ )
  273. The node which node path references will travel from.
  274. .. rst-class:: classref-section-separator
  275. ----
  276. .. rst-class:: classref-descriptions-group
  277. Method Descriptions
  278. -------------------
  279. .. _class_AnimationMixer_private_method__post_process_key_value:
  280. .. rst-class:: classref-method
  281. :ref:`Variant<class_Variant>` **_post_process_key_value**\ (\ animation\: :ref:`Animation<class_Animation>`, track\: :ref:`int<class_int>`, value\: :ref:`Variant<class_Variant>`, object_id\: :ref:`int<class_int>`, object_sub_idx\: :ref:`int<class_int>`\ ) |virtual| |const|
  282. A virtual function for processing after getting a key during playback.
  283. .. rst-class:: classref-item-separator
  284. ----
  285. .. _class_AnimationMixer_method_add_animation_library:
  286. .. rst-class:: classref-method
  287. :ref:`Error<enum_@GlobalScope_Error>` **add_animation_library**\ (\ name\: :ref:`StringName<class_StringName>`, library\: :ref:`AnimationLibrary<class_AnimationLibrary>`\ )
  288. Adds ``library`` to the animation player, under the key ``name``.
  289. .. rst-class:: classref-item-separator
  290. ----
  291. .. _class_AnimationMixer_method_advance:
  292. .. rst-class:: classref-method
  293. |void| **advance**\ (\ delta\: :ref:`float<class_float>`\ )
  294. Manually advance the animations by the specified time (in seconds).
  295. .. rst-class:: classref-item-separator
  296. ----
  297. .. _class_AnimationMixer_method_capture:
  298. .. rst-class:: classref-method
  299. |void| **capture**\ (\ name\: :ref:`StringName<class_StringName>`, duration\: :ref:`float<class_float>`, trans_type\: :ref:`TransitionType<enum_Tween_TransitionType>` = 0, ease_type\: :ref:`EaseType<enum_Tween_EaseType>` = 0\ )
  300. If the animation track specified by ``name`` has an option :ref:`Animation.UPDATE_CAPTURE<class_Animation_constant_UPDATE_CAPTURE>`, stores current values of the objects indicated by the track path as a cache. If there is already a captured cache, the old cache is discarded.
  301. After this it will interpolate with current animation blending result during the playback process for the time specified by ``duration``, working like a crossfade.
  302. You can specify ``trans_type`` as the curve for the interpolation. For better results, it may be appropriate to specify :ref:`Tween.TRANS_LINEAR<class_Tween_constant_TRANS_LINEAR>` for cases where the first key of the track begins with a non-zero value or where the key value does not change, and :ref:`Tween.TRANS_QUAD<class_Tween_constant_TRANS_QUAD>` for cases where the key value changes linearly.
  303. .. rst-class:: classref-item-separator
  304. ----
  305. .. _class_AnimationMixer_method_clear_caches:
  306. .. rst-class:: classref-method
  307. |void| **clear_caches**\ (\ )
  308. **AnimationMixer** caches animated nodes. It may not notice if a node disappears; :ref:`clear_caches<class_AnimationMixer_method_clear_caches>` forces it to update the cache again.
  309. .. rst-class:: classref-item-separator
  310. ----
  311. .. _class_AnimationMixer_method_find_animation:
  312. .. rst-class:: classref-method
  313. :ref:`StringName<class_StringName>` **find_animation**\ (\ animation\: :ref:`Animation<class_Animation>`\ ) |const|
  314. Returns the key of ``animation`` or an empty :ref:`StringName<class_StringName>` if not found.
  315. .. rst-class:: classref-item-separator
  316. ----
  317. .. _class_AnimationMixer_method_find_animation_library:
  318. .. rst-class:: classref-method
  319. :ref:`StringName<class_StringName>` **find_animation_library**\ (\ animation\: :ref:`Animation<class_Animation>`\ ) |const|
  320. Returns the key for the :ref:`AnimationLibrary<class_AnimationLibrary>` that contains ``animation`` or an empty :ref:`StringName<class_StringName>` if not found.
  321. .. rst-class:: classref-item-separator
  322. ----
  323. .. _class_AnimationMixer_method_get_animation:
  324. .. rst-class:: classref-method
  325. :ref:`Animation<class_Animation>` **get_animation**\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const|
  326. Returns the :ref:`Animation<class_Animation>` with the key ``name``. If the animation does not exist, ``null`` is returned and an error is logged.
  327. .. rst-class:: classref-item-separator
  328. ----
  329. .. _class_AnimationMixer_method_get_animation_library:
  330. .. rst-class:: classref-method
  331. :ref:`AnimationLibrary<class_AnimationLibrary>` **get_animation_library**\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const|
  332. Returns the first :ref:`AnimationLibrary<class_AnimationLibrary>` with key ``name`` or ``null`` if not found.
  333. To get the :ref:`AnimationPlayer<class_AnimationPlayer>`'s global animation library, use ``get_animation_library("")``.
  334. .. rst-class:: classref-item-separator
  335. ----
  336. .. _class_AnimationMixer_method_get_animation_library_list:
  337. .. rst-class:: classref-method
  338. :ref:`Array<class_Array>`\[:ref:`StringName<class_StringName>`\] **get_animation_library_list**\ (\ ) |const|
  339. Returns the list of stored library keys.
  340. .. rst-class:: classref-item-separator
  341. ----
  342. .. _class_AnimationMixer_method_get_animation_list:
  343. .. rst-class:: classref-method
  344. :ref:`PackedStringArray<class_PackedStringArray>` **get_animation_list**\ (\ ) |const|
  345. Returns the list of stored animation keys.
  346. .. rst-class:: classref-item-separator
  347. ----
  348. .. _class_AnimationMixer_method_get_root_motion_position:
  349. .. rst-class:: classref-method
  350. :ref:`Vector3<class_Vector3>` **get_root_motion_position**\ (\ ) |const|
  351. Retrieve the motion delta of position with the :ref:`root_motion_track<class_AnimationMixer_property_root_motion_track>` as a :ref:`Vector3<class_Vector3>` that can be used elsewhere.
  352. If :ref:`root_motion_track<class_AnimationMixer_property_root_motion_track>` is not a path to a track of type :ref:`Animation.TYPE_POSITION_3D<class_Animation_constant_TYPE_POSITION_3D>`, returns ``Vector3(0, 0, 0)``.
  353. See also :ref:`root_motion_track<class_AnimationMixer_property_root_motion_track>` and :ref:`RootMotionView<class_RootMotionView>`.
  354. The most basic example is applying position to :ref:`CharacterBody3D<class_CharacterBody3D>`:
  355. .. tabs::
  356. .. code-tab:: gdscript
  357. var current_rotation: Quaternion
  358. func _process(delta):
  359. if Input.is_action_just_pressed("animate"):
  360. current_rotation = get_quaternion()
  361. state_machine.travel("Animate")
  362. var velocity: Vector3 = current_rotation * animation_tree.get_root_motion_position() / delta
  363. set_velocity(velocity)
  364. move_and_slide()
  365. By using this in combination with :ref:`get_root_motion_position_accumulator<class_AnimationMixer_method_get_root_motion_position_accumulator>`, you can apply the root motion position more correctly to account for the rotation of the node.
  366. .. tabs::
  367. .. code-tab:: gdscript
  368. func _process(delta):
  369. if Input.is_action_just_pressed("animate"):
  370. state_machine.travel("Animate")
  371. set_quaternion(get_quaternion() * animation_tree.get_root_motion_rotation())
  372. var velocity: Vector3 = (animation_tree.get_root_motion_rotation_accumulator().inverse() * get_quaternion()) * animation_tree.get_root_motion_position() / delta
  373. set_velocity(velocity)
  374. move_and_slide()
  375. .. rst-class:: classref-item-separator
  376. ----
  377. .. _class_AnimationMixer_method_get_root_motion_position_accumulator:
  378. .. rst-class:: classref-method
  379. :ref:`Vector3<class_Vector3>` **get_root_motion_position_accumulator**\ (\ ) |const|
  380. Retrieve the blended value of the position tracks with the :ref:`root_motion_track<class_AnimationMixer_property_root_motion_track>` as a :ref:`Vector3<class_Vector3>` that can be used elsewhere.
  381. This is useful in cases where you want to respect the initial key values of the animation.
  382. For example, if an animation with only one key ``Vector3(0, 0, 0)`` is played in the previous frame and then an animation with only one key ``Vector3(1, 0, 1)`` is played in the next frame, the difference can be calculated as follows:
  383. .. tabs::
  384. .. code-tab:: gdscript
  385. var prev_root_motion_position_accumulator: Vector3
  386. func _process(delta):
  387. if Input.is_action_just_pressed("animate"):
  388. state_machine.travel("Animate")
  389. var current_root_motion_position_accumulator: Vector3 = animation_tree.get_root_motion_position_accumulator()
  390. var difference: Vector3 = current_root_motion_position_accumulator - prev_root_motion_position_accumulator
  391. prev_root_motion_position_accumulator = current_root_motion_position_accumulator
  392. transform.origin += difference
  393. However, if the animation loops, an unintended discrete change may occur, so this is only useful for some simple use cases.
  394. .. rst-class:: classref-item-separator
  395. ----
  396. .. _class_AnimationMixer_method_get_root_motion_rotation:
  397. .. rst-class:: classref-method
  398. :ref:`Quaternion<class_Quaternion>` **get_root_motion_rotation**\ (\ ) |const|
  399. Retrieve the motion delta of rotation with the :ref:`root_motion_track<class_AnimationMixer_property_root_motion_track>` as a :ref:`Quaternion<class_Quaternion>` that can be used elsewhere.
  400. If :ref:`root_motion_track<class_AnimationMixer_property_root_motion_track>` is not a path to a track of type :ref:`Animation.TYPE_ROTATION_3D<class_Animation_constant_TYPE_ROTATION_3D>`, returns ``Quaternion(0, 0, 0, 1)``.
  401. See also :ref:`root_motion_track<class_AnimationMixer_property_root_motion_track>` and :ref:`RootMotionView<class_RootMotionView>`.
  402. The most basic example is applying rotation to :ref:`CharacterBody3D<class_CharacterBody3D>`:
  403. .. tabs::
  404. .. code-tab:: gdscript
  405. func _process(delta):
  406. if Input.is_action_just_pressed("animate"):
  407. state_machine.travel("Animate")
  408. set_quaternion(get_quaternion() * animation_tree.get_root_motion_rotation())
  409. .. rst-class:: classref-item-separator
  410. ----
  411. .. _class_AnimationMixer_method_get_root_motion_rotation_accumulator:
  412. .. rst-class:: classref-method
  413. :ref:`Quaternion<class_Quaternion>` **get_root_motion_rotation_accumulator**\ (\ ) |const|
  414. Retrieve the blended value of the rotation tracks with the :ref:`root_motion_track<class_AnimationMixer_property_root_motion_track>` as a :ref:`Quaternion<class_Quaternion>` that can be used elsewhere.
  415. This is necessary to apply the root motion position correctly, taking rotation into account. See also :ref:`get_root_motion_position<class_AnimationMixer_method_get_root_motion_position>`.
  416. Also, this is useful in cases where you want to respect the initial key values of the animation.
  417. For example, if an animation with only one key ``Quaternion(0, 0, 0, 1)`` is played in the previous frame and then an animation with only one key ``Quaternion(0, 0.707, 0, 0.707)`` is played in the next frame, the difference can be calculated as follows:
  418. .. tabs::
  419. .. code-tab:: gdscript
  420. var prev_root_motion_rotation_accumulator: Quaternion
  421. func _process(delta):
  422. if Input.is_action_just_pressed("animate"):
  423. state_machine.travel("Animate")
  424. var current_root_motion_rotation_accumulator: Quaternion = animation_tree.get_root_motion_Quaternion_accumulator()
  425. var difference: Quaternion = prev_root_motion_rotation_accumulator.inverse() * current_root_motion_rotation_accumulator
  426. prev_root_motion_rotation_accumulator = current_root_motion_rotation_accumulator
  427. transform.basis *= difference
  428. However, if the animation loops, an unintended discrete change may occur, so this is only useful for some simple use cases.
  429. .. rst-class:: classref-item-separator
  430. ----
  431. .. _class_AnimationMixer_method_get_root_motion_scale:
  432. .. rst-class:: classref-method
  433. :ref:`Vector3<class_Vector3>` **get_root_motion_scale**\ (\ ) |const|
  434. Retrieve the motion delta of scale with the :ref:`root_motion_track<class_AnimationMixer_property_root_motion_track>` as a :ref:`Vector3<class_Vector3>` that can be used elsewhere.
  435. If :ref:`root_motion_track<class_AnimationMixer_property_root_motion_track>` is not a path to a track of type :ref:`Animation.TYPE_SCALE_3D<class_Animation_constant_TYPE_SCALE_3D>`, returns ``Vector3(0, 0, 0)``.
  436. See also :ref:`root_motion_track<class_AnimationMixer_property_root_motion_track>` and :ref:`RootMotionView<class_RootMotionView>`.
  437. The most basic example is applying scale to :ref:`CharacterBody3D<class_CharacterBody3D>`:
  438. .. tabs::
  439. .. code-tab:: gdscript
  440. var current_scale: Vector3 = Vector3(1, 1, 1)
  441. var scale_accum: Vector3 = Vector3(1, 1, 1)
  442. func _process(delta):
  443. if Input.is_action_just_pressed("animate"):
  444. current_scale = get_scale()
  445. scale_accum = Vector3(1, 1, 1)
  446. state_machine.travel("Animate")
  447. scale_accum += animation_tree.get_root_motion_scale()
  448. set_scale(current_scale * scale_accum)
  449. .. rst-class:: classref-item-separator
  450. ----
  451. .. _class_AnimationMixer_method_get_root_motion_scale_accumulator:
  452. .. rst-class:: classref-method
  453. :ref:`Vector3<class_Vector3>` **get_root_motion_scale_accumulator**\ (\ ) |const|
  454. Retrieve the blended value of the scale tracks with the :ref:`root_motion_track<class_AnimationMixer_property_root_motion_track>` as a :ref:`Vector3<class_Vector3>` that can be used elsewhere.
  455. For example, if an animation with only one key ``Vector3(1, 1, 1)`` is played in the previous frame and then an animation with only one key ``Vector3(2, 2, 2)`` is played in the next frame, the difference can be calculated as follows:
  456. .. tabs::
  457. .. code-tab:: gdscript
  458. var prev_root_motion_scale_accumulator: Vector3
  459. func _process(delta):
  460. if Input.is_action_just_pressed("animate"):
  461. state_machine.travel("Animate")
  462. var current_root_motion_scale_accumulator: Vector3 = animation_tree.get_root_motion_scale_accumulator()
  463. var difference: Vector3 = current_root_motion_scale_accumulator - prev_root_motion_scale_accumulator
  464. prev_root_motion_scale_accumulator = current_root_motion_scale_accumulator
  465. transform.basis = transform.basis.scaled(difference)
  466. However, if the animation loops, an unintended discrete change may occur, so this is only useful for some simple use cases.
  467. .. rst-class:: classref-item-separator
  468. ----
  469. .. _class_AnimationMixer_method_has_animation:
  470. .. rst-class:: classref-method
  471. :ref:`bool<class_bool>` **has_animation**\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const|
  472. Returns ``true`` if the :ref:`AnimationPlayer<class_AnimationPlayer>` stores an :ref:`Animation<class_Animation>` with key ``name``.
  473. .. rst-class:: classref-item-separator
  474. ----
  475. .. _class_AnimationMixer_method_has_animation_library:
  476. .. rst-class:: classref-method
  477. :ref:`bool<class_bool>` **has_animation_library**\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const|
  478. Returns ``true`` if the :ref:`AnimationPlayer<class_AnimationPlayer>` stores an :ref:`AnimationLibrary<class_AnimationLibrary>` with key ``name``.
  479. .. rst-class:: classref-item-separator
  480. ----
  481. .. _class_AnimationMixer_method_remove_animation_library:
  482. .. rst-class:: classref-method
  483. |void| **remove_animation_library**\ (\ name\: :ref:`StringName<class_StringName>`\ )
  484. Removes the :ref:`AnimationLibrary<class_AnimationLibrary>` associated with the key ``name``.
  485. .. rst-class:: classref-item-separator
  486. ----
  487. .. _class_AnimationMixer_method_rename_animation_library:
  488. .. rst-class:: classref-method
  489. |void| **rename_animation_library**\ (\ name\: :ref:`StringName<class_StringName>`, newname\: :ref:`StringName<class_StringName>`\ )
  490. Moves the :ref:`AnimationLibrary<class_AnimationLibrary>` associated with the key ``name`` to the key ``newname``.
  491. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  492. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  493. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  494. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  495. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  496. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  497. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  498. .. |void| replace:: :abbr:`void (No return value.)`