新手引导‐从最简单开始 - 1226085293/MKFramework GitHub Wiki

1. 创建一个引导管理器

const guide_manage = new mk.guide_manage({
  step_update_callback_f: () => true,
});

2. 定义引导步骤

class guide_step_xxx extends mk.guide_step_base {
    // 步骤序号
    step_n = 1;
    load(jump_b_: boolean): void | Promise<void> {
        // ...进入引导步骤后的逻辑
    }
}

3. 添加引导步骤

从对象添加

guide_manage.regis([new guide_step_xxx()]);

从节点添加 (引导步骤脚本是可以挂载在节点上的🤗)

guide_manage.regis([node.getComponent(guide_step_xxx)]);

也可以混合

guide_manage.regis([new guide_step_xxx(), node.getComponent(guide_step_xxx)]);

备注：guide_manage.regis 可调用多次，只会覆盖，而不会删除之前的步骤

4. 启动新手引导

// 跳转到步骤序号为 1 的步骤
guide_manage.set_step(1);
⚠️ **GitHub.com Fallback** ⚠️