类的使用
cn.wjybxx.btree.Task

使用Task的程序包

程序包	说明
cn.wjybxx.btree
cn.wjybxx.btree.branch
cn.wjybxx.btree.branch.join
cn.wjybxx.btree.decorator
cn.wjybxx.btree.fsm
cn.wjybxx.btree.leaf

cn.wjybxx.btree中Task的使用

cn.wjybxx.btree中Task的子类

修饰符和类型	类	说明
class	ActionTask<E>	行为节点抽象 (并非所有行为节点都需要继承该类)
class	BranchTask<E>	分支任务（可能有多个子节点）
class	ConditionTask<E>	条件节点 (并非所有条件节点都需要继承该类)
class	ConditionTask2<E>	可返回详细错误码的条件节点
class	Decorator<E>	装饰任务（最多只有一个子节点）
class	LeafTask<E>	叶子任务（不能有子节点）
class	TaskEntry<E>	任务入口（可联想程序的Main）

声明为Task的cn.wjybxx.btree中的字段

修饰符和类型	字段	说明
protected Task<E>	Decorator.child

类型参数类型为Task的cn.wjybxx.btree中的字段

修饰符和类型	字段	说明
protected List<Task<E>>	BranchTask.children

返回Task的cn.wjybxx.btree中的方法

修饰符和类型	方法	说明
final Task<E>	Task.addChild(Task<E> task)	1.尽量不要在运行时增删子节点（危险操作） 2.不建议将Task从一棵树转移到另一棵树，可能产生内存泄漏（引用未删除干净） 3.如果需要知道task的索引，可提前调用getChildCount()
final Task<E>	BranchTask.getChild(int index)
Task<E>	Decorator.getChild()
final Task<E>	Decorator.getChild(int index)
final Task<E>	LeafTask.getChild(int index)
abstract Task<E>	Task.getChild(int index)	获取指定索引的child
final Task<E>	TaskEntry.getChild(int index)
final Task<E>	Task.getControl()
final Task<E>	BranchTask.getFirstChild()	主要为MainPolicy提供帮助
final Task<E>	Task.getGuard()
final Task<E>	BranchTask.getLastChild()
Task<E>	TaskEntry.getRootTask()
default <E> Task<E>	TreeLoader.loadRootTask(String treeName)
final Task<E>	Task.removeChild(int index)	删除指定索引的child
protected final Task<E>	BranchTask.removeChildImpl(int index)
protected final Task<E>	Decorator.removeChildImpl(int index)
protected final Task<E>	LeafTask.removeChildImpl(int index)
protected abstract Task<E>	Task.removeChildImpl(int index)
protected final Task<E>	TaskEntry.removeChildImpl(int index)
final Task<E>	Task.setChild(int index, Task<E> newTask)	替换指定索引位置的child （该方法可避免Task的结构发生变化，也可以减少事件数）
protected final Task<E>	BranchTask.setChildImpl(int index, Task<E> task)
protected final Task<E>	Decorator.setChildImpl(int index, Task<E> task)
protected final Task<E>	LeafTask.setChildImpl(int index, Task<E> task)
protected abstract Task<E>	Task.setChildImpl(int index, Task<E> task)
protected final Task<E>	TaskEntry.setChildImpl(int index, Task<E> task)
final Task<E>	Task.setFlags(int flags)
final Task<E>	Task.setGuard(Task<E> guard)
default <E> Task<E>	TreeLoader.tryLoadRootTask(String treeName)	尝试加载行为树的根节点

返回变量类型为Task的类型的cn.wjybxx.btree中的方法

修饰符和类型	方法	说明
final Stream<Task<E>>	BranchTask.childStream()
final Stream<Task<E>>	Decorator.childStream()
final Stream<Task<E>>	LeafTask.childStream()
abstract Stream<Task<E>>	Task.childStream()	该接口主要用于测试，该接口有一定的开销
final Stream<Task<E>>	TaskEntry.childStream()
List<Task<E>>	BranchTask.getChildren()

参数类型为Task的cn.wjybxx.btree中的方法

修饰符和类型	方法	说明
final Task<E>	Task.addChild(Task<E> task)	1.尽量不要在运行时增删子节点（危险操作） 2.不建议将Task从一棵树转移到另一棵树，可能产生内存泄漏（引用未删除干净） 3.如果需要知道task的索引，可提前调用getChildCount()
protected final int	BranchTask.addChildImpl(Task<E> task)
protected final int	Decorator.addChildImpl(Task<E> task)
protected final int	LeafTask.addChildImpl(Task<E> task)
protected abstract int	Task.addChildImpl(Task<E> task)
protected final int	TaskEntry.addChildImpl(Task<E> task)
int	CancelToken.addListener(Task<?> task)	为Task定制的接口 1.可减少闭包，也更方便使用 2.如果Task被重入，不会被通知
final int	BranchTask.indexChild(Task<?> task)
final int	Decorator.indexChild(Task<?> task)
final int	LeafTask.indexChild(Task<?> task)
int	Task.indexChild(Task<?> task)
final int	TaskEntry.indexChild(Task<?> task)
final boolean	BranchTask.isFirstChild(Task<?> child)
final boolean	BranchTask.isLastChild(Task<?> child)
protected final void	LeafTask.onChildCompleted(Task<E> child)
protected abstract void	Task.onChildCompleted(Task<E> child)	子节点进入完成状态 1.避免方法数太多，实现类测试task的status即可 2.getNormalizedStatus()有助于switch测试 3.task可能是取消状态，甚至可能没运行过直接失败（前置条件失败） 4.钩子任务和guard不会调用该方法 5.isExecuting()有助于检测冲突，减少调用栈深度 6.同一子节点连续通知的情况下，completed的逻辑应当覆盖onChildRunning(Task)的影响。
protected void	TaskEntry.onChildCompleted(Task<E> child)
protected void	Decorator.onChildRunning(Task<E> child)
protected final void	LeafTask.onChildRunning(Task<E> child)
protected abstract void	Task.onChildRunning(Task<E> child)	子节点还需要继续运行 1.child在运行期间只会通知一次 2.该方法不应该触发状态迁移，即不应该使自己进入完成状态
protected void	TaskEntry.onChildRunning(Task<E> child)
final boolean	Task.removeChild(Task<?> task)
boolean	CancelToken.removeListener(Task<?> task)	删除task的监听
static void	Task.resetForRestart(Task<?> task)
void	Decorator.setChild(Task<E> child)
final Task<E>	Task.setChild(int index, Task<E> newTask)	替换指定索引位置的child （该方法可避免Task的结构发生变化，也可以减少事件数）
protected final Task<E>	BranchTask.setChildImpl(int index, Task<E> task)
protected final Task<E>	Decorator.setChildImpl(int index, Task<E> task)
protected final Task<E>	LeafTask.setChildImpl(int index, Task<E> task)
protected abstract Task<E>	Task.setChildImpl(int index, Task<E> task)
protected final Task<E>	TaskEntry.setChildImpl(int index, Task<E> task)
final void	Task.setControl(Task<E> control)	设置任务的控制节点
final Task<E>	Task.setGuard(Task<E> guard)
final void	Task.setGuardFailed(Task<E> control)	设置为前置条件测试失败 1.该方法仅适用于control测试child的guard失败，令child在未运行的情况下直接失败的情况。
void	TaskEntry.setRootTask(Task<E> rootTask)
static void	Task.stop(Task<?> task)
static void	Task.stopSafely(Task<?> task)
final boolean	Task.template_checkGuard(Task<E> guard)	检查前置条件 1.如果未显式设置guard的上下文，会默认捕获当前Task的上下文 2.guard的上下文在运行结束后会被清理 3.guard只应该依赖共享上下文(黑板和props)，不应当对父节点做任何的假设。
final void	Task.template_runChild(Task<E> child)	运行子节点，会检查子节点的前置条件
final void	Task.template_runChildDirectly(Task<E> child)	运行子节点，不检查子节点的前置条件
final void	Task.template_runHook(Task<E> hook)	执行钩子任务，会检查前置条件 1.钩子任务不会触发onChildRunning(Task)和onChildCompleted(Task) 2.前置条件其实是特殊的钩子任务
final void	Task.template_runHookDirectly(Task<E> hook)	执行钩子任务，不检查前置条件

类型变量类型为Task的cn.wjybxx.btree中的方法参数

修饰符和类型	方法	说明
void	BranchTask.setChildren(List<Task<E>> children)

参数类型为Task的cn.wjybxx.btree中的构造器

限定符	构造器	说明
	BranchTask(Task<E> first, Task<E> second)
	Decorator(Task<E> child)
	TaskEntry(String name, Task<E> rootTask, E blackboard, Object entity, TreeLoader treeLoader)

类型变量类型为Task的cn.wjybxx.btree中的构造器参数

限定符	构造器	说明
	BranchTask(List<Task<E>> children)

cn.wjybxx.btree.branch中Task的使用

cn.wjybxx.btree.branch中Task的子类

修饰符和类型	类	说明
class	ActiveSelector<E>	主动选择节点 每次运行时都会重新测试节点的运行条件，选择一个新的可运行节点。
class	FixedSwitch<E>	展开的switch 在编辑器中，children根据坐标排序，容易变动；这里将其展开为字段，从而方便配置。
class	Foreach<E>	迭代所有的子节点最后返回成功
class	Join<E>	Join 1.在得出结果之前不会重复执行已完成的任务。
class	Parallel<E>	并行节点基类 定义该类主要说明一些注意事项，包括： 1.在处理子节点完成事件的时候，避免运行execute方法，否则可能导致其它task单帧内运行多次。
class	Selector<E>
class	SelectorN<E>	多选Selector。
class	Sequence<E>
class	ServiceParallel<E>	服务并发节点 其中第一个任务为主要任务，其余任务为后台服务。
class	SimpleParallel<E>	简单并发节点。
class	SingleRunningChildBranch<E>	非并行分支节点抽象 如果SingleRunningChildBranch.execute()方法是有循环体的，那么一定要注意： 只有循环的尾部运行child才是安全的，如果在运行child后还读写其它数据，可能导致bug(小心递归)。
class	Switch<E>

声明为Task的cn.wjybxx.btree.branch中的字段

修饰符和类型	字段	说明
protected Task<E>	SingleRunningChildBranch.runningChild	运行中的子节点

返回Task的cn.wjybxx.btree.branch中的方法

修饰符和类型	方法	说明
Task<E>	FixedSwitch.getBranch1()
Task<E>	FixedSwitch.getBranch2()
Task<E>	FixedSwitch.getBranch3()
Task<E>	FixedSwitch.getBranch4()
Task<E>	FixedSwitch.getBranch5()
protected Task<E>	SingleRunningChildBranch.nextChild()

参数类型为Task的cn.wjybxx.btree.branch中的方法

修饰符和类型	方法	说明
protected void	ActiveSelector.onChildCompleted(Task<E> child)
protected void	Foreach.onChildCompleted(Task<E> child)
protected void	Join.onChildCompleted(Task<E> child)
void	JoinPolicy.onChildCompleted(Join<E> join, Task<E> child)	Join在调用该方法前更新了完成计数和成功计数
protected void	Selector.onChildCompleted(Task<E> child)
protected void	SelectorN.onChildCompleted(Task<E> child)
protected void	Sequence.onChildCompleted(Task<E> child)
protected void	ServiceParallel.onChildCompleted(Task<E> child)
protected void	SimpleParallel.onChildCompleted(Task<E> child)
protected void	SingleRunningChildBranch.onChildCompleted(Task<E> child)	子类的实现模板：
protected void	Switch.onChildCompleted(Task<E> child)
protected void	Parallel.onChildRunning(Task<E> child)	并发节点通常不需要在该事件中将自己更新为运行状态，而是应该在execute()方法的末尾更新
protected void	SingleRunningChildBranch.onChildRunning(Task<E> child)
void	FixedSwitch.setBranch1(Task<E> branch1)
void	FixedSwitch.setBranch2(Task<E> branch2)
void	FixedSwitch.setBranch3(Task<E> branch3)
void	FixedSwitch.setBranch4(Task<E> branch4)
void	FixedSwitch.setBranch5(Task<E> branch5)

参数类型为Task的cn.wjybxx.btree.branch中的构造器

限定符	构造器	说明
	Foreach(Task<E> first, Task<E> second)
	Selector(Task<E> first, Task<E> second)
	SelectorN(Task<E> first, Task<E> second)
	Sequence(Task<E> first, Task<E> second)
	SingleRunningChildBranch(Task<E> first, Task<E> second)

类型变量类型为Task的cn.wjybxx.btree.branch中的构造器参数

限定符	构造器	说明
	Foreach(List<Task<E>> children)
	Selector(List<Task<E>> children)
	SelectorN(List<Task<E>> children)
	Sequence(List<Task<E>> children)
	SingleRunningChildBranch(List<Task<E>> children)

cn.wjybxx.btree.branch.join中Task的使用

参数类型为Task的cn.wjybxx.btree.branch.join中的方法

修饰符和类型	方法	说明
void	JoinAnyOf.onChildCompleted(Join<E> join, Task<E> child)
void	JoinMain.onChildCompleted(Join<E> join, Task<E> child)
void	JoinSelector.onChildCompleted(Join<E> join, Task<E> child)
void	JoinSelectorN.onChildCompleted(Join<E> join, Task<E> child)
void	JoinSequence.onChildCompleted(Join<E> join, Task<E> child)
void	JoinWaitAll.onChildCompleted(Join<E> join, Task<E> child)

cn.wjybxx.btree.decorator中Task的使用

cn.wjybxx.btree.decorator中Task的子类

修饰符和类型	类	说明
class	AlwaysCheckGuard<E>	每一帧都检查子节点的前置条件，如果前置条件失败，则取消child执行并返回失败
class	AlwaysFail<E>	在子节点完成之后固定返回失败
class	AlwaysRunning<E>	在子节点完成之后仍返回运行。
class	AlwaysSuccess<E>	在子节点完成之后固定返回成功
class	Inverter<E>	反转装饰器，它用于反转子节点的执行结果。
class	LoopDecorator<E>	循环节点抽象 如果LoopDecorator.execute()方法是有循环体的，那么一定要注意： 只有循环的尾部运行child才是安全的，如果在运行child后还读写其它数据，可能导致bug(小心递归)。
class	OnlyOnce<E>	只执行一次。
class	Repeat<E>	重复N次
class	SubtreeRef<E>	子树引用
class	UntilCond<E>	循环子节点直到给定的条件达成
class	UntilFail<E>	重复运行子节点，直到该任务失败 （超类做了死循环避免）
class	UntilSuccess<E>

返回Task的cn.wjybxx.btree.decorator中的方法

修饰符和类型	方法	说明
Task<E>	UntilCond.getCond()

参数类型为Task的cn.wjybxx.btree.decorator中的方法

修饰符和类型	方法	说明
protected void	AlwaysCheckGuard.onChildCompleted(Task<E> child)
protected void	AlwaysFail.onChildCompleted(Task<E> child)
protected void	AlwaysRunning.onChildCompleted(Task<E> child)
protected void	AlwaysSuccess.onChildCompleted(Task<E> child)
protected void	Inverter.onChildCompleted(Task<E> child)
protected void	OnlyOnce.onChildCompleted(Task<E> child)
protected void	Repeat.onChildCompleted(Task<E> child)
protected void	SubtreeRef.onChildCompleted(Task<E> child)
protected void	UntilCond.onChildCompleted(Task<E> child)
protected void	UntilFail.onChildCompleted(Task<E> child)
protected void	UntilSuccess.onChildCompleted(Task<E> child)
UntilCond<E>	UntilCond.setCond(Task<E> cond)

参数类型为Task的cn.wjybxx.btree.decorator中的构造器

限定符	构造器	说明
	AlwaysCheckGuard(Task<E> child)
	AlwaysFail(Task<E> child)
	AlwaysSuccess(Task<E> child)
	Inverter(Task<E> child)
	OnlyOnce(Task<E> child)

cn.wjybxx.btree.fsm中Task的使用

cn.wjybxx.btree.fsm中Task的子类

修饰符和类型	类	说明
class	ChangeStateTask<E>
class	StateMachineTask<E>	状态机节点 1.redo和undo是很有用的特性，因此我们在顶层给予支持，但默认的队列不会保存状态。

返回Task的cn.wjybxx.btree.fsm中的方法

修饰符和类型	方法	说明
final Task<E>	StateMachineTask.discardTempNextState()	丢弃未切换的临时状态
final Task<E>	StateMachineTask.getCurState()	获取当前状态
Task<E>	StateMachineTask.getInitState()
Task<E>	ChangeStateTask.getNextState()
final Task<E>	StateMachineTask.getTempNextState()	获取临时的下一个状态
final Task<E>	StateMachineTask.peekRedoState()	查看redo对应的state
final Task<E>	StateMachineTask.peekUndoState()	查看undo对应的state

返回变量类型为Task的类型的cn.wjybxx.btree.fsm中的方法

修饰符和类型	方法	说明
final Deque<Task<E>>	StateMachineTask.getRedoQueue()	开放以允许填充
final Deque<Task<E>>	StateMachineTask.getUndoQueue()	开放以允许填充
final Deque<Task<E>>	StateMachineTask.setRedoQueueSize(int maxSize)
final Deque<Task<E>>	StateMachineTask.setUndoQueueSize(int maxSize)

参数类型为Task的cn.wjybxx.btree.fsm中的方法

修饰符和类型	方法	说明
void	StateMachineListener.beforeChangeState(StateMachineTask<E> stateMachineTask, Task<E> curState, Task<E> nextState)	1.两个参数最多一个为null 2.可以设置新状态的黑板和其它数据 3.用户此时可为新状态分配上下文；同时清理前一个状态的上下文 4.用户此时可拿到新状态ChangeStateArgs，后续则不可 5.如果task需要感知redo和undo，则由用户将信息写入黑板
final void	StateMachineTask.changeState(Task<E> nextState)	切换状态 -- 如果状态机处于运行中，则立即切换
void	StateMachineTask.changeState(Task<E> nextState, ChangeStateArgs changeStateArgs)	切换状态 1.如果当前有一个待切换的状态，则会被悄悄丢弃(可以增加一个通知) 2.无论何种模式，在当前状态进入完成状态时一定会触发 3.如果状态机未运行，则仅仅保存在那里，等待下次运行的时候执行 4.当前状态可先正常完成，然后再切换状态，就可以避免进入被取消状态；可参考ChangeStateTask
static <E> StateMachineTask<E>	StateMachineTask.findStateMachine(Task<E> task)	查找task最近的状态机节点 1.仅递归查询父节点和长兄节点 2.优先查找附近的，然后测试长兄节点 - 状态机作为第一个节点的情况比较常见
static <E> StateMachineTask<E>	StateMachineTask.findStateMachine(Task<E> task, String name)	查找task最近的状态机节点 1.名字不为空的情况下，支持从兄弟节点中查询 2.优先测试父节点，然后测试兄弟节点
protected final boolean	StateMachineTask.isReady(Task<E> curState, Task<?> nextState)
protected final void	StateMachineTask.notifyChangeState(Task<E> curState, Task<E> nextState)
protected void	StateMachineTask.onChildCompleted(Task<E> child)
boolean	StateMachineHandler.onNextStateAbsent(StateMachineTask<E> stateMachineTask, Task<E> preState)	当状态机没有下一个状态时调用该方法，以避免无可用状态 注意： 1.状态机启动时不会调用该方法 2.如果该方法返回后仍无可用状态，将触发无状态逻辑 3.
default void	StateMachineHandler.onNextStateGuardFailed(StateMachineTask<E> stateMachineTask, Task<E> nextState)	下个状态的前置条件检查失败
void	StateMachineTask.setInitState(Task<E> initState)
void	ChangeStateTask.setNextState(Task<E> nextState)

参数类型为Task的cn.wjybxx.btree.fsm中的构造器

限定符	构造器	说明
	ChangeStateTask(Task<E> nextState)

cn.wjybxx.btree.leaf中Task的使用

cn.wjybxx.btree.leaf中Task的子类

修饰符和类型	类	说明
class	Failure<E>
class	Running<E>
class	SimpleRandom<E>	简单随机任务 在正式的项目中，Random应当从实体上获取。
class	Success<E>
class	WaitFrame<E>	等待N帧