更新文档

This commit is contained in:
gongxh
2025-09-22 15:14:18 +08:00
parent 50e29feeb8
commit 80a2438f6e
10 changed files with 803 additions and 75 deletions

117
README.md
View File

@@ -1,15 +1,20 @@
# 行为树
> 一个简洁、高效的 TypeScript 行为树库。遵循"好品味"设计原则:简单数据结构,消除特殊情况,直接暴露问题。
[![npm version](https://badge.fury.io/js/kunpocc-behaviortree.svg)](https://badge.fury.io/js/kunpocc-behaviortree)
[![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg)](https://opensource.org/licenses/ISC)
一个简洁、高效的 TypeScript 行为树库。
该库无任何依赖理论上可用于所有js、ts项目。
作者主要使用此库作为游戏AI的实现。
## 什么是行为树
行为树Behavior Tree是一种用于描述和控制复杂行为逻辑的数据结构最初在游戏AI领域大放异彩现在已经广泛应用于机器人控制、自动化系统等领域。它简单、直观、可扩展是真正解决实际问题的好工具。
行为树本质上是一个**有向无环图**,用树状结构来组织和执行行为逻辑。每个节点代表一个行为或决策,通过父子关系形成层次化的控制流。
## 特性
- 🎯 **简洁设计**: 零废话,直接解决问题
- 🔧 **类型安全**: 完整 TypeScript 支持
- 🚀 **高性能**: 优化的执行机制,最小开销
- 📦 **零依赖**: 纯净实现,无第三方依赖
- 🔄 **状态管理**: 分层黑板系统,数据隔离清晰
@@ -21,17 +26,20 @@
npm install kunpocc-behaviortree
```
#### 内置demo
#### 内置demo (基于cocos creator 3.8.6)
项目根目录下的 `bt-demo`文件夹
demo是基于`cocos creator3.8.6`制作的
## GUI编辑器
查看详情: [GUI编辑器](./docs/USED.md)
![image](./image/image_tree.png)
## 核心概念
### 状态类型
#### 状态类型
```typescript
enum Status {
SUCCESS, // 成功
@@ -40,14 +48,13 @@ enum Status {
}
```
### 节点类型
#### 节点类型
- **组合节点**: 包含多个子节点 (Composite)
- **装饰节点**: 有且只有一个子节点Decorator
- **叶子节点**: 不能包含子节点 (LeafNode)
- **条件节点**: 特殊的叶子节点 (Condition)
## 装饰器
> **自行实现的节点,通过装饰器把数据暴露给行为树编辑器**
@@ -75,14 +82,14 @@ enum Status {
* 按顺序执行子节点执行过程中子节点返回非SUCCESS则返回子节点状态全部成功返回SUCCESS
##### Parallel - 并行节点
* 执行所有子节点,全部成功才成功
* 并不是真正的并行,也有执行顺序
* 依次执行所有子节点(从左到右),全部成功才成功
* 注意:这里的"并行"是逻辑概念,实际是顺序执行
##### RandomSelector - 随机选择节点
* 随机选择一个子节点执行
##### ParallelAnySuccess - 并行任一成功
* 同时执行所有子节点,任一成功就成功
* 依次执行所有子节点(从左到右),任一成功就成功
@@ -136,6 +143,8 @@ enum Status {
##### WaitTime - 时间等待节点
### 条件节点 (Condition)
##### Condition - 条件节点基类
@@ -154,36 +163,68 @@ enum Status {
## 黑板系统
黑板系统提供分层数据存储,支持数据隔离和查找链:
### 黑板系统的作用
黑板系统Blackboard System是行为树中的数据共享中心类似于传统 AI 系统中的黑板概念。它解决了行为树中节点间数据传递和状态共享的核心问题:
- **数据传递**:在不同节点间传递运行时数据
- **状态管理**:维护游戏对象的状态信息
- **解耦设计**:避免节点间直接依赖,提高代码可维护性
- **上下文感知**:让节点能够感知周围环境和历史状态
### 数据隔离层次
黑板系统采用三层数据隔离设计,形成清晰的数据作用域:
#### 1. 本地数据Node Level
- **作用域**:当前节点可见
- **生命周期**:随节点创建和销毁
- **用途**:节点内部状态、临时变量、私有数据
#### 2. 树级数据Tree Level
- **作用域**:整棵行为树内所有节点可见
- **生命周期**:随行为树创建和销毁
- **用途**:树内节点间共享的状态、任务进度、策略参数
#### 3. 全局数据Global Level
- **作用域**:所有行为树实例可见
- **生命周期**:应用程序生命周期
- **用途**:全局配置、静态数据、跨树共享状态
### 黑板的使用
```typescript
// 在节点中使用黑板
new Action((node) => {
// 直接获取实体
const entity = node.getEntity<Character>();
// 本地数据(仅当前节点可见)
node.set('local_count', 1);
const count = node.get<number>('local_count');
// 树级数据(整棵树可见)
node.setRoot('tree_data', 'shared');
const shared = node.getRoot<string>('tree_data');
// 全局数据(所有树可见)
node.setGlobal('global_config', config);
const config = node.getGlobal<Config>('global_config');
return Status.SUCCESS;
})
import * as BT from "kunpocc-behaviortree";
// 设置全局数据 所有行为树实例可见
BT.globalBlackboard.set("playerPosition", {x: 100, y: 100});
// 在节点中使用黑板数据
export class BTAction extends BT.LeafNode {
public tick(): BT.Status {
// 获取全局数据
const playerPosition = this.getGlobal<{x: number, y: number}>("playerPosition");
console.log(playerPosition);
// 设置树级数据
this.setRoot("isDead", true);
// 获取树级数据
const isDead = this.getRoot<boolean>("isDead");
console.log(isDead);
// 设置节点数据
this.set<boolean>("finished", true);
// 获取节点数据
const finished = this.get<boolean>("finished");
console.log(finished);
return BT.Status.SUCCESS;
}
}
```
## 许可证
ISC License - 详见 [LICENSE](LICENSE) 文件
## 贡献
欢迎提交 Issue 和 Pull Request。请确保