BTStopAnimation

Inherits: BTAction < BTTask < BT

BT action that stops the playback of an animation on the specified AnimationPlayer node.

Description

BTStopAnimation action stops the playback of an animation on the specified AnimationPlayer node and returns SUCCESS. If animation_name is set, it will only stop the playback if the specified animation is currently playing.

Returns FAILURE if the action fails to get the AnimationPlayer node.

Properties

StringName

animation_name

&""

BBNode

animation_player

bool

keep_state

false

Property Descriptions

StringName animation_name = &""

  • void set_animation_name ( StringName value )

  • StringName get_animation_name ( )

Animation’s key within the AnimationPlayer node. If not empty, BTStopAnimation will only stop the playback if the specified animation is currently playing.

BBNode animation_player

  • void set_animation_player ( BBNode value )

  • BBNode get_animation_player ( )

Parameter that specifies the AnimationPlayer node.

bool keep_state = false

  • void set_keep_state ( bool value )

  • bool get_keep_state ( )

If true, the animation state is not updated visually.