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

Improve BTSelector & BTSequence class doc

This commit is contained in:
Serhii Snitsaruk 2023-09-27 12:19:36 +02:00
parent 00f9e03f02
commit 978a47f505
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc_classes/BTSelector.xml
View File

@ -4,10 +4,10 @@
BT composite that sequentially executes tasks until first [code]SUCCESS[/code].
</brief_description>
<description>
BTSelector executes its child tasks sequentially, from first to last, until any child returns [code]SUCCESS[/code].
Returns [code]RUNNING[/code] if any child task returns [code]RUNNING[/code]. The composite will also remember the last child task that returned [code]RUNNING[/code], ensuring it resumes from that point in the next execution tick.
Returns [code]FAILURE[/code] if all child tasks return [code]FAILURE[/code].
Returns [code]SUCCESS[/code] if a child task returns [code]SUCCESS[/code].
BTSelector executes its child tasks sequentially, from first to last, until any child returns [code]SUCCESS[/code]. If a child task results in [code]FAILURE[/code], BTSelector will immediately execute the next child task until one of them returns [code]SUCCESS[/code] or all of them result in [code]FAILURE[/code]. BTSelector and [BTSequence] are two of the most common building blocks of behavior trees. Essentially, while [BTSequence] is similar to a boolean AND operation, BTSelector is similar to a boolean OR operation. Selectors enable the behavior tree to respond to changes in the environment and trigger transitions between various fallback behaviors.
Returns [code]RUNNING[/code] if a child task results in [code]RUNNING[/code]. BTSelector will remember the last child task that returned [code]RUNNING[/code], ensuring it resumes from that point in the next execution tick.
Returns [code]SUCCESS[/code] if a child task results in [code]SUCCESS[/code].
Returns [code]FAILURE[/code] if all child tasks result in [code]FAILURE[/code].
</description>
<tutorials>
</tutorials>

8
doc_classes/BTSequence.xml
View File

@ -4,10 +4,10 @@
BT composite that sequentially executes tasks as long as they return [code]SUCCESS[/code].
</brief_description>
<description>
BTSequence executes its child tasks sequentially, from first to last, as long as they return [code]SUCCESS[/code].
Returns [code]RUNNING[/code] if any child task returns [code]RUNNING[/code]. The composite will also remember the last child task that returned [code]RUNNING[/code], ensuring it resumes from that point in the next execution tick.
Returns [code]FAILURE[/code] if a child task returns [code]FAILURE[/code].
Returns [code]SUCCESS[/code] if all child tasks return [code]SUCCESS[/code].
BTSequence executes its child tasks sequentially, from first to last, as long as they return [code]SUCCESS[/code]. If a child task results in [code]SUCCESS[/code], BTSequence will immediately execute the next child task until one of them returns [code]FAILURE[/code] or all of them result in [code]SUCCESS[/code]. BTSequence and [BTSelector] are two of the most common building blocks of behavior trees. Essentially, while [BTSelector] is similar to a boolean OR operation, BTSequence is similar to a boolean AND operation. Sequences enable the behavior tree to compose complex behaviors from a chain of simpler tasks.
Returns [code]RUNNING[/code] if any child task results in [code]RUNNING[/code]. BTSequence will remember the last child task that returned [code]RUNNING[/code], ensuring it resumes from that point in the next execution tick.
Returns [code]SUCCESS[/code] if all child tasks result in [code]SUCCESS[/code].
Returns [code]FAILURE[/code] if a child task results in [code]FAILURE[/code].
</description>
<tutorials>
</tutorials>