跳转到内容
ESEngine

蓝图可视化脚本 (Blueprint)

@esengine/blueprint 提供了一个功能完整的可视化脚本系统，支持节点式编程、事件驱动和蓝图组合。

安装

Section titled “安装”
Terminal window
npm install @esengine/blueprint

快速开始

Section titled “快速开始”
import {
    createBlueprintSystem,
    createBlueprintComponentData,
    NodeRegistry,
    RegisterNode
} from '@esengine/blueprint';


// 创建蓝图系统
const blueprintSystem = createBlueprintSystem(scene);


// 加载蓝图资产
const blueprint = await loadBlueprintAsset('player.bp');


// 创建蓝图组件数据
const componentData = createBlueprintComponentData();
componentData.blueprintAsset = blueprint;


// 在游戏循环中更新
function gameLoop(dt: number) {
    blueprintSystem.process(entities, dt);
}

核心概念

Section titled “核心概念”

蓝图资产结构

Section titled “蓝图资产结构”

蓝图保存为 .bp 文件，包含以下结构：

interface BlueprintAsset {
    version: number;           // 格式版本
    type: 'blueprint';         // 资产类型
    metadata: BlueprintMetadata; // 元数据
    variables: BlueprintVariable[]; // 变量定义
    nodes: BlueprintNode[];    // 节点实例
    connections: BlueprintConnection[]; // 连接
}

节点类型

Section titled “节点类型”

节点按功能分为以下类别：

类别说明颜色
event事件节点（入口点）红色
flow流程控制灰色
entity实体操作蓝色
component组件访问青色
math数学运算绿色
logic逻辑运算红色
variable变量访问紫色
time时间工具青色
debug调试工具灰色

引脚类型

Section titled “引脚类型”

节点通过引脚连接：

interface BlueprintPinDefinition {
    name: string;        // 引脚名称
    type: PinDataType;   // 数据类型
    direction: 'input' | 'output';
    isExec?: boolean;    // 是否是执行引脚
    defaultValue?: unknown;
}


// 支持的数据类型
type PinDataType =
    | 'exec'      // 执行流
    | 'boolean'   // 布尔值
    | 'number'    // 数字
    | 'string'    // 字符串
    | 'vector2'   // 2D 向量
    | 'vector3'   // 3D 向量
    | 'entity'    // 实体引用
    | 'component' // 组件引用
    | 'any';      // 任意类型

变量作用域

Section titled “变量作用域”
type VariableScope =
    | 'local'     // 每次执行独立
    | 'instance'  // 每个实体独立
    | 'global';   // 全局共享

文档导航

Section titled “文档导航”