使用指南
术语表
用面向使用者的语言解释 Script Graph 文档中的核心术语。
这里解释 Script Graph 文档中常见的术语。你可以先理解这些概念,再去阅读节点手册和更新记录。
基础概念
Script Graph
本插件的英文名称。文档中也会称为“脚本图编辑器”。
脚本图
用节点和连线表达脚本逻辑的可视化图。完成后的脚本图可以接入 Cocos Creator 项目,让游戏逻辑运行起来。
工作流
.sgw 文件中的节点执行图。工作流关注“什么时候执行”“数据从哪里来”“结果传到哪里去”。
节点
工作流中的基础单元。一个节点可以代表事件入口、变量读写、函数调用、分支、循环、Cocos 组件操作、资产加载或数学运算。
引脚
节点左右两侧可连接的端口。左侧通常是输入,右侧通常是输出。引脚决定节点能接收什么、能输出什么。
连线
连接两个引脚的线。执行流连线表示执行顺序,数据流连线表示值的传递。
流与类型
执行流
控制节点运行顺序的连接。执行流决定“下一步执行哪个节点”。
数据流
传递字符串、数字、布尔值、节点、组件、资产、结构体、枚举等数据的连接。数据流决定“这个值从哪里来”。
事件端口
用于绑定事件回调的特殊端口。事件绑定节点通常需要连接事件端口,并输出一个绑定句柄。
变量类型
数据引脚的基础类型,例如 string、number、boolean、cc.Node、cc.Component、cc.Asset、enum、struct、reference。
变量基数
描述一个值是单个值、数组、映射还是集合。节点手册中常见 single、array、map、set。
类型配置
复杂类型的精确身份,例如某个 Cocos 组件、某个枚举、某个结构体。它用于避免把名字相似但来源不同的类型错误连接在一起。
工作流文件类型
组件工作流
挂接到 Cocos 组件生命周期的工作流,适合写角色、UI、关卡对象等运行时行为。
函数工作流
可被调用的独立逻辑片段,拥有函数入口和函数返回。
函数库
跨文件复用的公共函数集合,适合放通用计算、工具逻辑和玩法辅助函数。
类脚本图
用可视化方式定义类、构造函数、变量和方法,适合建模背包、任务、敌人配置等领域对象。
接口编辑器
用可视化方式定义 TypeScript 接口,让类或数据结构遵守统一契约。
枚举编辑器
用可视化方式定义有限候选值,例如角色状态、道具品质、关卡阶段。
结构体编辑器
用可视化方式定义一组字段组成的数据结构,例如角色属性、战斗结果、掉落配置。
节点族
事件节点
工作流的入口或事件监听能力,例如加载事件、启动事件、更新事件、全局事件、节点事件。
流程控制节点
改变执行顺序的节点,例如分支、延迟、循环、序列、门控、执行一次、枚举 Switch。
变量节点
读取或写入变量的节点,用于保存血量、分数、当前状态等游戏数据。
函数节点
函数入口、函数返回和函数调用占位节点,用于封装和复用逻辑。
类节点
创建类实例或使用类相关能力的节点。
结构体节点
构造、拆解或修改结构体数据的节点。
枚举节点
生成枚举值或按枚举值分发执行路径的节点。
资产管理节点
加载资产包、加载资产、获取资产等节点。通常是异步节点。
资产节点
围绕某类 Cocos 资产提供读取、校验或创建能力,例如 AudioClip、SpriteFrame、Prefab、Material。
Cocos 节点
操作场景 Node 的节点,包括层级、变换、组件、激活状态、场景查找等。
Cocos 组件节点
操作 Cocos Creator 组件的节点,例如 UI、音频、动画、物理、灯光、粒子、渲染和瓦片地图组件。
数学运算节点
处理数字、向量、矩阵、四元数、颜色、矩形和尺寸等游戏数学数据。
语言基础节点
表达字符串、数组、对象、Map、Set、JSON、日期、正则和基础运算等语言能力。
物理系统节点
执行射线、形状、屏幕点等物理查询,常用于拾取、攻击检测和交互判定。
对象池节点
复用频繁创建销毁的对象,常用于子弹、特效、伤害数字、掉落物。
缓动系统节点
组合位移、缩放、旋转、透明度和曲线动画。
音频系统节点
统一管理音乐、音效、音量和播放控制。
生成与运行
TypeScript 生成
把脚本图转换成 TypeScript 组件的过程。你可以把生成结果接入 Cocos Creator 项目。
原生代码编译
让部分工作流走更高性能执行路径的能力,适合性能敏感场景。
游戏运行支持
让节点逻辑在游戏运行时真正执行的底层能力。普通使用时通常不需要直接操作它。
静态分析
编译或运行前检查节点、引脚、变量、类型和引用是否有效。它能在运行前阻止明显错误。
自定义节点
用 TypeScript 封装的项目专属节点,能像内置节点一样出现在侧边栏。
插件化节点
把自定义节点封装为独立插件后跨项目复用的能力。