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

Improve docs for RandomWait, Wait, WaitTicks

This commit is contained in:
Serhii Snitsaruk 2023-10-19 14:27:02 +02:00
parent cab9f853c0
commit 8e53f02e00
3 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc_classes/BTRandomWait.xml
View File

@ -1,19 +1,19 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BTRandomWait" inherits="BTAction" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
BT action that waits for a randomized duration to pass and returns [code]SUCCESS[/code].
BT action that waits for a randomized duration to elapse and then returns [code]SUCCESS[/code].
</brief_description>
<description>
BT action that waits for a randomized duration to pass and returns [code]SUCCESS[/code]. Actual duration is randomized. The minimum wait time is defined by [code]min_duration[/code], and the maximum is defined by [code]max_duration[/code].
BTRandomWait action waits for a randomized duration to elapse and then returns [code]SUCCESS[/code]. The duration is randomized within the specified range, defined by [code]min_duration[/code] and [code]max_duration[/code].
</description>
<tutorials>
</tutorials>
<members>
<member name="max_duration" type="float" setter="set_max_duration" getter="get_max_duration" default="2.0">
Maximum duration to wait.
Maximum duration for the wait.
</member>
<member name="min_duration" type="float" setter="set_min_duration" getter="get_min_duration" default="1.0">
Minimum duration to wait.
Minimum duration for the wait.
</member>
</members>
</class>

2
doc_classes/BTWait.xml
View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BTWait" inherits="BTAction" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
BT action that waits for a [member duration] to pass and then returns [code]SUCCESS[/code].
BT action that waits for a specified [member duration] to elapse and then returns [code]SUCCESS[/code].
</brief_description>
<description>
</description>

4
doc_classes/BTWaitTicks.xml
View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BTWaitTicks" inherits="BTAction" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
BT action that waits for a specified number of ticks to pass and then returns [code]SUCCESS[/code].
BT action that waits for a specified number of ticks to elapse and then returns [code]SUCCESS[/code].
</brief_description>
<description>
</description>
@ -9,7 +9,7 @@
</tutorials>
<members>
<member name="num_ticks" type="int" setter="set_num_ticks" getter="get_num_ticks" default="1">
Number of ticks to wait before returning [code]SUCCESS[/code].
The number of ticks to wait before returning [code]SUCCESS[/code].
</member>
</members>
</class>