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

Fixes for class docs

This commit is contained in:
Serhii Snitsaruk 2023-08-14 14:42:46 +02:00
parent 0c4a98cf35
commit 694eebcf6d
3 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc_classes/BTPauseAnimation.xml
View File

@ -1,17 +1,17 @@
<?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 playback of an animation on the specified [AnimationPlayer] node.
</brief_description>
<description>
BTPauseAnimation action pauses playback of an animation on the specified [class AnimationPlayer] node and returns [code]SUCCESS[/code].
Returns [code]FAILURE[/code] if the action fails to acquire AnimationPlayer node.
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.
</description>
<tutorials>
</tutorials>
<members>
<member name="animation_player" type="BBNode" setter="set_animation_player" getter="get_animation_player">
Parameter that specifies the AnimationPlayer node.
Parameter that specifies the [AnimationPlayer] node.
</member>
</members>
</class>

8
doc_classes/BTPlayAnimation.xml
View File

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BTPlayAnimation" inherits="BTAction" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
BT action that plays an animation on the specified AnimationPlayer node.
BT action that plays an animation on the specified [AnimationPlayer] node.
</brief_description>
<description>
BTPlayAnimation action plays an animation on the specified AnimationPlayer node. If the [member await_completion] is greater than [code]0[/code], the action will wait for the animation to complete, with a maximum waiting time equal to [member await_completion].
BTPlayAnimation action plays an animation on the specified [AnimationPlayer] node. If the [member await_completion] is greater than [code]0[/code], the action will wait for the animation to complete, with a maximum waiting time equal to [member await_completion].
Returns [code]SUCCESS[/code] if the animation finishes playing or if the elapsed time exceeds [member await_completion]. When [member await_completion] is set to [code]0[/code], BTPlayAnimation doesn't wait for the animation to finish and immediately returns [code]SUCCESS[/code].
Returns [code]RUNNING[/code] if the animation is still playing and the elapsed time is less than [member await_completion].
Returns [code]FAILURE[/code] if the action fails to play the requested animation.
@ -13,10 +13,10 @@
</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 empty, BTPlayAnimation will resume the last played animation if [class AnimationPlayer] was paused.
Animation's key within the [AnimationPlayer] node. If empty, BTPlayAnimation will resume the last played animation if [AnimationPlayer] was paused.
</member>
<member name="animation_player" type="BBNode" setter="set_animation_player" getter="get_animation_player">
Parameter that specifies the AnimationPlayer node.
Parameter that specifies the [AnimationPlayer] node.
</member>
<member name="await_completion" type="float" setter="set_await_completion" getter="get_await_completion" default="0.0">
Duration to wait for the animation to finish (in seconds).

10
doc_classes/BTStopAnimation.xml
View File

@ -1,20 +1,20 @@
<?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.
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.
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.
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.
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.