Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
godotengine
GitHub Repository: godotengine/godot
Path: blob/master/doc/classes/AnimationTree.xml
10277 views
1
<?xml version="1.0" encoding="UTF-8" ?>
2
<class name="AnimationTree" inherits="AnimationMixer" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
3
<brief_description>
4
A node used for advanced animation transitions in an [AnimationPlayer].
5
</brief_description>
6
<description>
7
A node used for advanced animation transitions in an [AnimationPlayer].
8
[b]Note:[/b] When linked with an [AnimationPlayer], several properties and methods of the corresponding [AnimationPlayer] will not function as expected. Playback and transitions should be handled using only the [AnimationTree] and its constituent [AnimationNode](s). The [AnimationPlayer] node should be used solely for adding, deleting, and editing animations.
9
</description>
10
<tutorials>
11
<link title="Using AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link>
12
<link title="Third Person Shooter (TPS) Demo">https://godotengine.org/asset-library/asset/2710</link>
13
</tutorials>
14
<methods>
15
<method name="get_process_callback" qualifiers="const" deprecated="Use [member AnimationMixer.callback_mode_process] instead.">
16
<return type="int" enum="AnimationTree.AnimationProcessCallback" />
17
<description>
18
Returns the process notification in which to update animations.
19
</description>
20
</method>
21
<method name="set_process_callback" deprecated="Use [member AnimationMixer.callback_mode_process] instead.">
22
<return type="void" />
23
<param index="0" name="mode" type="int" enum="AnimationTree.AnimationProcessCallback" />
24
<description>
25
Sets the process notification in which to update animations.
26
</description>
27
</method>
28
</methods>
29
<members>
30
<member name="advance_expression_base_node" type="NodePath" setter="set_advance_expression_base_node" getter="get_advance_expression_base_node" default="NodePath(&quot;.&quot;)">
31
The path to the [Node] used to evaluate the [AnimationNode] [Expression] if one is not explicitly specified internally.
32
</member>
33
<member name="anim_player" type="NodePath" setter="set_animation_player" getter="get_animation_player" default="NodePath(&quot;&quot;)">
34
The path to the [AnimationPlayer] used for animating.
35
</member>
36
<member name="callback_mode_discrete" type="int" setter="set_callback_mode_discrete" getter="get_callback_mode_discrete" overrides="AnimationMixer" enum="AnimationMixer.AnimationCallbackModeDiscrete" default="2" />
37
<member name="deterministic" type="bool" setter="set_deterministic" getter="is_deterministic" overrides="AnimationMixer" default="true" />
38
<member name="tree_root" type="AnimationRootNode" setter="set_tree_root" getter="get_tree_root">
39
The root animation node of this [AnimationTree]. See [AnimationRootNode].
40
</member>
41
</members>
42
<signals>
43
<signal name="animation_player_changed">
44
<description>
45
Emitted when the [member anim_player] is changed.
46
</description>
47
</signal>
48
</signals>
49
<constants>
50
<constant name="ANIMATION_PROCESS_PHYSICS" value="0" enum="AnimationProcessCallback" deprecated="See [constant AnimationMixer.ANIMATION_CALLBACK_MODE_PROCESS_PHYSICS].">
51
</constant>
52
<constant name="ANIMATION_PROCESS_IDLE" value="1" enum="AnimationProcessCallback" deprecated="See [constant AnimationMixer.ANIMATION_CALLBACK_MODE_PROCESS_IDLE].">
53
</constant>
54
<constant name="ANIMATION_PROCESS_MANUAL" value="2" enum="AnimationProcessCallback" deprecated="See [constant AnimationMixer.ANIMATION_CALLBACK_MODE_PROCESS_MANUAL].">
55
</constant>
56
</constants>
57
</class>
58
59