AnimationTreePlayer

####Inherits: Node ####Category: Core

Brief Description

Animation Player that uses a node graph for the blending.

Member Functions

• void add_node ( int type, String id )
• bool node_exists ( String node ) const
• int node_rename ( String node, String new_name )
• int node_get_type ( String id ) const
• int node_get_input_count ( String id ) const
• String node_get_input_source ( String id, int idx ) const
• void animation_node_set_animation ( String id, Animation animation )
• Animation animation_node_get_animation ( String id ) const
• void animation_node_set_master_animation ( String id, String source )
• String animation_node_get_master_animation ( String id ) const
• void oneshot_node_set_fadein_time ( String id, float time_sec )
• float oneshot_node_get_fadein_time ( String id ) const
• void oneshot_node_set_fadeout_time ( String id, float time_sec )
• float oneshot_node_get_fadeout_time ( String id ) const
• void oneshot_node_set_autorestart ( String id, bool enable )
• void oneshot_node_set_autorestart_delay ( String id, float delay_sec )
• void oneshot_node_set_autorestart_random_delay ( String id, float rand_sec )
• bool oneshot_node_has_autorestart ( String id ) const
• float oneshot_node_get_autorestart_delay ( String id ) const
• float oneshot_node_get_autorestart_random_delay ( String id ) const
• void oneshot_node_start ( String id )
• void oneshot_node_stop ( String id )
• bool oneshot_node_is_active ( String id ) const
• void oneshot_node_set_filter_path ( String id, NodePath path, bool enable )
• void mix_node_set_amount ( String id, float ratio )
• float mix_node_get_amount ( String id ) const
• void blend2_node_set_amount ( String id, float blend )
• float blend2_node_get_amount ( String id ) const
• void blend2_node_set_filter_path ( String id, NodePath path, bool enable )
• void blend3_node_set_amount ( String id, float blend )
• float blend3_node_get_amount ( String id ) const
• void blend4_node_set_amount ( String id, Vector2 blend )
• Vector2 blend4_node_get_amount ( String id ) const
• void timescale_node_set_scale ( String id, float scale )
• float timescale_node_get_scale ( String id ) const
• void timeseek_node_seek ( String id, float pos_sec )
• void transition_node_set_input_count ( String id, int count )
• int transition_node_get_input_count ( String id ) const
• void transition_node_delete_input ( String id, int input_idx )
• void transition_node_set_input_auto_advance ( String id, int input_idx, bool enable )
• bool transition_node_has_input_auto_advance ( String id, int input_idx ) const
• void transition_node_set_xfade_time ( String id, float time_sec )
• float transition_node_get_xfade_time ( String id ) const
• void transition_node_set_current ( String id, int input_idx )
• int transition_node_get_current ( String id ) const
• void node_set_pos ( String id, Vector2 screen_pos )
• Vector2 node_get_pos ( String id ) const
• void remove_node ( String id )
• int connect ( String id, String dst_id, int dst_input_idx )
• bool is_connected ( String id, String dst_id, int dst_input_idx ) const
• void disconnect ( String id, int dst_input_idx )
• void set_active ( bool enabled )
• bool is_active ( ) const
• void set_base_path ( NodePath path )
• NodePath get_base_path ( ) const
• StringArray get_node_list ( )
• void reset ( )
• void recompute_caches ( )

Numeric Constants

• NODE_OUTPUT = 0
• NODE_ANIMATION = 1
• NODE_ONESHOT = 2
• NODE_MIX = 3
• NODE_BLEND2 = 4
• NODE_BLEND3 = 5
• NODE_BLEND4 = 6
• NODE_TIMESCALE = 7
• NODE_TIMESEEK = 8
• NODE_TRANSITION = 9

Description

Animation Player that uses a node graph for the blending. This kind of player is very useful when animating character or other skeleton based rigs, because it can combine several animations to form a desired pose.

Member Function Description

add_node

• void add_node ( int type, String id )

Add a node of a given type in the graph with given id.

node_exists

• bool node_exists ( String node ) const

Check if a node exists (by name).

node_rename

• int node_rename ( String node, String new_name )

Rename a node in the graph.

node_get_type

• int node_get_type ( String id ) const

Get the node type, will return from NODE_* enum.

node_get_input_count

• int node_get_input_count ( String id ) const

Return the input count for a given node. Different types of nodes have different amount of inputs.

node_get_input_source

• String node_get_input_source ( String id, int idx ) const

Return the input source for a given node input.

animation_node_set_animation

• void animation_node_set_animation ( String id, Animation animation )

Set the animation for an animation node.