botaccount
/
limboai
mirror of https://github.com/limbonaut/limboai.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add BTStopAnimation class docs

This commit is contained in:
Serhii Snitsaruk 2023-08-14 13:25:58 +02:00
parent 92b0f24dcb
commit 404c9274f9
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
doc_classes/BTStopAnimation.xml Normal file
View File

@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BTStopAnimation" inherits="BTAction" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
BT action that stops playback of an animation on the specified AnimationPlayer node.
</brief_description>
<description>
BTStopAnimation action stops playback of an animation on the specified AnimationPlayer node and returns [code]SUCCESS[/code]. If [member animation_name] is set, it will only stop playback if the specified animation is currently playing.
Returns [code]FAILURE[/code] if the action fails to acquire AnimationPlayer node.
</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. If not empty, BTStopAnimation will only stop playback if the specified animation is currently playing.
</member>
<member name="animation_player" type="BBNode" setter="set_animation_player" getter="get_animation_player">
Parameter that specifies the AnimationPlayer node.
</member>
<member name="keep_state" type="bool" setter="set_keep_state" getter="get_keep_state" default="false">
If [code]true[/code], the animation state is not updated visually.
</member>
</members>
</class>