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

Improve BTRandom{Selector,Sequence} class docs

This commit is contained in:
Serhii Snitsaruk 2023-09-28 12:37:15 +02:00
parent d2bde1a805
commit 84201f6e44
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc_classes/BTRandomSelector.xml
View File

@ -4,10 +4,10 @@
BT composite that executes tasks in random order until first [code]SUCCESS[/code].
</brief_description>
<description>
BT composite that executes child tasks in random order until any child returns [code]SUCCESS[/code].
Returns [code]RUNNING[/code] if a task returns [code]RUNNING[/code], and remembers last [code]RUNNING[/code] child and the order of execution. BTRandomSelector will continue where it left off on the next execution tick.
Returns [code]FAILURE[/code] if all tasks return [code]FAILURE[/code].
Returns [code]SUCCESS[/code] if any task returns [code]SUCCESS[/code].
BTRandomSelector executes its child tasks in a random order until any child returns [code]SUCCESS[/code]. If a child task results in [code]FAILURE[/code], BTRandomSelector will immediately execute another child task until one of them returns [code]SUCCESS[/code] or all of them result in [code]FAILURE[/code].
Returns [code]RUNNING[/code] if a child task results in [code]RUNNING[/code]. BTRandomSelector will remember the execution order and the last child task that returned [code]RUNNING[/code], ensuring it resumes from that point in the next tick.
Returns [code]FAILURE[/code] if all child tasks result in [code]FAILURE[/code].
Returns [code]SUCCESS[/code] if a child task results in [code]SUCCESS[/code].
</description>
<tutorials>
</tutorials>

10
doc_classes/BTRandomSequence.xml
View File

@ -1,13 +1,13 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BTRandomSequence" inherits="BTComposite" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
BT composite that executes tasks in random order for as long as they return [code]SUCCESS[/code].
BT composite that executes tasks in random order as long as they return [code]SUCCESS[/code].
</brief_description>
<description>
BTRandomSequence executes child tasks in random order for as long as they return [code]SUCCESS[/code].
Returns [code]RUNNING[/code] if a task returns [code]RUNNING[/code], and remembers last [code]RUNNING[/code] child and the order of execution. BTRandomSequence will continue where it left off on the next execution tick.
Returns [code]FAILURE[/code] if any task returns [code]FAILURE[/code].
Returns [code]SUCCESS[/code] if all tasks return [code]SUCCESS[/code].
BTRandomSequence executes its child tasks in a random order as long as they return [code]SUCCESS[/code]. If a child task results in [code]SUCCESS[/code], BTRandomSequence will immediately execute the next child task until one of them returns [code]FAILURE[/code] or all of them result in [code]SUCCESS[/code].
Returns [code]RUNNING[/code] if a child task results in [code]RUNNING[/code]. BTRandomSequence will remember the execution order and the last child task that returned [code]RUNNING[/code], ensuring it resumes from that point in the next tick.
Returns [code]FAILURE[/code] if a child task results in [code]FAILURE[/code].
Returns [code]SUCCESS[/code] if all child tasks result in [code]SUCCESS[/code].
</description>
<tutorials>
</tutorials>