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

Improve docs for AwaitAnimation and PauseAnimation

This commit is contained in:
Serhii Snitsaruk 2023-10-18 18:25:53 +02:00
parent 91d582ab09
commit 047b75258b
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc_classes/BTAwaitAnimation.xml
View File

@ -5,8 +5,8 @@
</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.
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 [AnimationPlayer] instance.
</description>
<tutorials>
</tutorials>
@ -18,7 +18,7 @@
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).
The maximum duration to wait for the animation to complete (in seconds). If the animation doesn't finish within this time, BTAwaitAnimation will return [code]FAILURE[/code].
</member>
</members>
</class>

6
doc_classes/BTPauseAnimation.xml
View File

@ -1,11 +1,11 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BTPauseAnimation" inherits="BTAction" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
BT action that pauses playback of an animation on the specified [AnimationPlayer] node.
BT action that pauses the playback of an animation on the specified [AnimationPlayer] node.
</brief_description>
<description>
BTPauseAnimation action pauses playback of an animation on the specified [AnimationPlayer] node and returns [code]SUCCESS[/code].
Returns [code]FAILURE[/code] if the action fails to acquire [AnimationPlayer] node.
BTPauseAnimation action pauses the playback of an animation on the specified [AnimationPlayer] node and returns [code]SUCCESS[/code].
Returns [code]FAILURE[/code] if the action fails to acquire the [AnimationPlayer] node.
</description>
<tutorials>
</tutorials>