Improve docs for AwaitAnimation and PauseAnimation
This commit is contained in:
parent
91d582ab09
commit
047b75258b
|
@ -5,8 +5,8 @@
|
||||||
</brief_description>
|
</brief_description>
|
||||||
<description>
|
<description>
|
||||||
BTAwaitAnimation waits for an animation on the specified [AnimationPlayer] node to finish playing and returns [code]SUCCESS[/code].
|
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]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 the action failed to get [AnimationPlayer] instance.
|
Returns [code]FAILURE[/code] if the specified animation doesn't exist or if the action fails to get [AnimationPlayer] instance.
|
||||||
</description>
|
</description>
|
||||||
<tutorials>
|
<tutorials>
|
||||||
</tutorials>
|
</tutorials>
|
||||||
|
@ -18,7 +18,7 @@
|
||||||
Parameter that specifies the [AnimationPlayer] node.
|
Parameter that specifies the [AnimationPlayer] node.
|
||||||
</member>
|
</member>
|
||||||
<member name="max_time" type="float" setter="set_max_time" getter="get_max_time" default="1.0">
|
<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>
|
</member>
|
||||||
</members>
|
</members>
|
||||||
</class>
|
</class>
|
||||||
|
|
|
@ -1,11 +1,11 @@
|
||||||
<?xml version="1.0" encoding="UTF-8" ?>
|
<?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">
|
<class name="BTPauseAnimation" inherits="BTAction" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
|
||||||
<brief_description>
|
<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>
|
</brief_description>
|
||||||
<description>
|
<description>
|
||||||
BTPauseAnimation action pauses playback of an animation on the specified [AnimationPlayer] node and returns [code]SUCCESS[/code].
|
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 [AnimationPlayer] node.
|
Returns [code]FAILURE[/code] if the action fails to acquire the [AnimationPlayer] node.
|
||||||
</description>
|
</description>
|
||||||
<tutorials>
|
<tutorials>
|
||||||
</tutorials>
|
</tutorials>
|
||||||
|
|
Loading…
Reference in New Issue