Add class docs for BTAwaitAnimation
This commit is contained in:
parent
015ec64771
commit
d642dbedc5
|
@ -0,0 +1,24 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="BTAwaitAnimation" inherits="BTAction" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
|
||||
<brief_description>
|
||||
BT action that waits for an animation to finish playing.
|
||||
</brief_description>
|
||||
<description>
|
||||
BTAwaitAnimation waits for an animation on the specified [AnimationPlayer] node to finish playing and returns [code]SUCCESS[/code].
|
||||
Returns [code]SUCCESS[/code] if the specified animation finished playing or if the specified animation is not currently playing.
|
||||
Returns [code]FAILURE[/code] if the specified animation doesn't exist or the action failed to get [AnimationPlayer] instance.
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
<members>
|
||||
<member name="animation_name" type="StringName" setter="set_animation_name" getter="get_animation_name" default="&""">
|
||||
Animation's key within the [AnimationPlayer] node.
|
||||
</member>
|
||||
<member name="animation_player" type="BBNode" setter="set_animation_player" getter="get_animation_player">
|
||||
Parameter that specifies the [AnimationPlayer] node.
|
||||
</member>
|
||||
<member name="max_time" type="float" setter="set_max_time" getter="get_max_time" default="1.0">
|
||||
Maximum duration to wait for the animation to finish (in seconds).
|
||||
</member>
|
||||
</members>
|
||||
</class>
|
Loading…
Reference in New Issue