Improve BTDynamic{Sequence,Selector} class docs
This commit is contained in:
parent
84201f6e44
commit
f4289ca839
|
@ -1,13 +1,13 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="BTDynamicSelector" 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 from the beginning each tick until first [code]SUCCESS[/code].
|
||||
BT composite that executes tasks from scratch every tick until first [code]SUCCESS[/code].
|
||||
</brief_description>
|
||||
<description>
|
||||
BT composite that executes child tasks from first to last until any child returns [code]SUCCESS[/code]. BTDynamicSelector will execute tasks from the beginning each tick, reevaluating their statuses.
|
||||
Returns [code]RUNNING[/code] if a task returns [code]RUNNING[/code], and remembers last [code]RUNNING[/code] child. In contrast to normal selector, on the next execution tick it will reexecute preceeding tasks and reevaluate their return statuses. If any of the preceeding tasks does not return [code]FAILURE[/code], it will cancel execution of the remembered [code]RUNNING[/code] task.
|
||||
Returns [code]FAILURE[/code] if all tasks return [code]FAILURE[/code].
|
||||
Returns [code]SUCCESS[/code] if any task returns [code]SUCCESS[/code].
|
||||
BTDynamicSelector executes its child tasks sequentially, from first to last, until any child returns [code]SUCCESS[/code]. Unlike [BTSelector], it will execute tasks from the beginning every tick, reevaluating their statuses. It is quite useful when you want to retry higher-priority behaviors in every tick.
|
||||
Returns [code]RUNNING[/code] if a child task results in [code]RUNNING[/code]. BTDynamicSelector will remember the last [code]RUNNING[/code] child, but, unlike [BTSequence], on the next execution tick, it will reexecute preceding tasks and reevaluate their return statuses. If any of the preceding tasks doesn't result in [code]FAILURE[/code], it will abort the remembered [code]RUNNING[/code] task.
|
||||
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>
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="BTDynamicSequence" 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 from the beginning each tick for as long as they return [code]SUCCESS[/code].
|
||||
BT composite that executes tasks from scratch every tick as long as they return [code]SUCCESS[/code].
|
||||
</brief_description>
|
||||
<description>
|
||||
BT composite that executes child tasks from first to last for as long as they return [code]SUCCESS[/code]. BTDynamicSequence will execute tasks from the beginning each tick, reevaluating their statuses.
|
||||
Returns [code]RUNNING[/code] if a task returns [code]RUNNING[/code], and remembers last [code]RUNNING[/code] child. In contrast to [BTSequence], on the next execution tick it will reexecute preceeding tasks and reevaluate their return statuses. If any of the preceeding tasks does not return [code]SUCCESS[/code], it will cancel execution of the remembered [code]RUNNING[/code] task.
|
||||
Returns [code]FAILURE[/code] if any task returns [code]FAILURE[/code].
|
||||
Returns [code]SUCCESS[/code] if all tasks return [code]SUCCESS[/code].
|
||||
BTDynamicSequence executes its child tasks sequentially, from first to last, for as long as they return [code]SUCCESS[/code]. Unlike [BTSequence], it will execute tasks from the beginning every tick, reevaluating their statuses. It is quite useful when you want to recheck conditions preceding a long-running action during each tick and abort the [code]RUNNING[/code] action when any condition results in [code]FAILURE[/code].
|
||||
Returns [code]RUNNING[/code] if a child task results in [code]RUNNING[/code]. BTDynamicSequence will remember the last [code]RUNNING[/code] child, but, unlike [BTSequence], on the next execution tick, it will reexecute preceding tasks and reevaluate their return statuses. If any of the preceding tasks doesn't result in [code]SUCCESS[/code], it will abort the remembered [code]RUNNING[/code] task.
|
||||
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>
|
||||
|
|
Loading…
Reference in New Issue