limboai/doc_classes/BTAwaitAnimation.xml

25 lines
1.4 KiB
XML
Raw Permalink Normal View History

2023-08-14 15:33:54 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BTAwaitAnimation" inherits="BTAction" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
2023-08-14 15:33:54 +00:00
<brief_description>
BT action that waits for an animation to finish playing.
</brief_description>
<description>
BTAwaitAnimation action 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 has finished playing or if the specified animation is not currently playing.
Returns [code]FAILURE[/code] if the specified animation doesn't exist or if the action fails to get the [AnimationPlayer] node.
2023-08-14 15:33:54 +00:00
</description>
<tutorials>
</tutorials>
<members>
<member name="animation_name" type="StringName" setter="set_animation_name" getter="get_animation_name" default="&amp;&quot;&quot;">
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">
2024-09-30 09:17:01 +00:00
The maximum duration to wait for the animation to complete (in seconds). If the animation doesn't finish within this time, BTAwaitAnimation will stop waiting and return [code]SUCCESS[/code].
2023-08-14 15:33:54 +00:00
</member>
</members>
</class>