3-7. 流程模块 - ProcedureModule

ProcedureLaunch
  ↓
ProcedureSplash
  ↓
ProcedureInitPackage
  ↓
ProcedureInitResources
  ↓                          ← 根据运行模式分支：
  ├─ EditorSimulateMode / OfflinePlayMode → ProcedurePreload（直通）
  └─ HostPlayMode → ProcedureCreateDownloader → ProcedureDownloadFile → ProcedureDownloadOver → ProcedureClearCache → ProcedurePreload
  ↓
ProcedurePreload
  ↓
ProcedureLoadAssembly
  ↓
ProcedureStartGame

注意：联机模式下，ProcedureInitResources 之后会进入版本更新和下载流程（ProcedureCreateDownloader → ProcedureDownloadFile → ProcedureDownloadOver → ProcedureClearCache），然后才进入 ProcedurePreload。编辑器模拟模式和单机模式则直接跳到 ProcedurePreload。

💡 自定义流程

创建自定义流程节点

using ProcedureOwner = TEngine.IFsm<TEngine.IProcedureModule>;

/// <summary>
/// 自定义流程节点。
/// </summary>
public class ProcedureCustom : ProcedureBase
{
    public override bool UseNativeDialog => false;

    protected override void OnEnter(ProcedureOwner procedureOwner)
    {
        base.OnEnter(procedureOwner);
        
        // 流程进入逻辑
        Log.Info("进入自定义流程");
        
        // 执行异步操作，使用 UniTask 并 Forget 启动
        DoSomethingAsync(procedureOwner).Forget();
    }
    
    protected override void OnUpdate(ProcedureOwner procedureOwner, float elapseSeconds, float realElapseSeconds)
    {
        base.OnUpdate(procedureOwner, elapseSeconds, realElapseSeconds);
        
        // 流程更新逻辑
    }
    
    protected override void OnLeave(ProcedureOwner procedureOwner, bool isShutdown)
    {
        base.OnLeave(procedureOwner, isShutdown);
        
        // 流程离开逻辑
        Log.Info("离开自定义流程");
    }
    
    private async UniTaskVoid DoSomethingAsync(ProcedureOwner procedureOwner)
    {
        // 异步操作（禁止使用 Coroutine，必须使用 UniTask）
        await UniTask.Delay(1000);
        
        // 切换到下一个流程
        ChangeState<ProcedureNext>(procedureOwner);
    }
}

注册自定义流程

在流程模块初始化时注册自定义流程：

// 在 ProcedureModule 中注册
ProcedureBase[] procedures = {
    new ProcedureLaunch(),
    new ProcedureSplash(),
    // ... 其他流程
    new ProcedureCustom(),  // 自定义流程
    new ProcedureStartGame(),
};

🔧 API 参考

流程切换

// ProcedureOwner 别名：using ProcedureOwner = TEngine.IFsm<TEngine.IProcedureModule>;

/// <summary>
/// 切换到指定流程。
/// </summary>
/// <typeparam name="T">流程类型。</typeparam>
/// <param name="procedureOwner">流程状态机持有者。</param>
void ChangeState<T>(ProcedureOwner procedureOwner) where T : ProcedureBase;

流程生命周期

// ProcedureOwner 别名：using ProcedureOwner = TEngine.IFsm<TEngine.IProcedureModule>;

/// <summary>
/// 流程进入时调用。
/// </summary>
/// <param name="procedureOwner">流程状态机持有者。</param>
protected override void OnEnter(ProcedureOwner procedureOwner);

/// <summary>
/// 流程更新时调用。
/// </summary>
/// <param name="procedureOwner">流程状态机持有者。</param>
/// <param name="elapseSeconds">逻辑流逝时间。</param>
/// <param name="realElapseSeconds">真实流逝时间。</param>
protected override void OnUpdate(ProcedureOwner procedureOwner, float elapseSeconds, float realElapseSeconds);

/// <summary>
/// 流程离开时调用。
/// </summary>
/// <param name="procedureOwner">流程状态机持有者。</param>
/// <param name="isShutdown">是否是关闭状态机时触发。</param>
protected override void OnLeave(ProcedureOwner procedureOwner, bool isShutdown);

💡 最佳实践

1. 流程节点职责单一

每个流程节点应该只负责一个明确的任务：

// ✅ 推荐：职责单一
public class ProcedureUpdateVersion : ProcedureBase
{
    // 只负责版本更新
}

// ❌ 不推荐：职责过多
public class ProcedureUpdateEverything : ProcedureBase
{
    // 同时负责版本更新、资源更新、配置加载等
}

2. 使用异步操作

对于耗时操作，使用 UniTask 异步方式（禁止使用 async void 或 Coroutine）：

// ✅ 推荐：在 OnEnter 中启动 UniTaskVoid 并 Forget
// using ProcedureOwner = TEngine.IFsm<TEngine.IProcedureModule>;
protected override void OnEnter(ProcedureOwner procedureOwner)
{
    base.OnEnter(procedureOwner);
    UpdateVersionAsync(procedureOwner).Forget();
}

private async UniTaskVoid UpdateVersionAsync(ProcedureOwner procedureOwner)
{
    await DoUpdateAsync();
    ChangeState<ProcedureNext>(procedureOwner);
}

// ❌ 禁止：async void 签名、Coroutine
// public override async void OnEnter(...) { ... }
// StartCoroutine(UpdateVersion());

3. 提供流程进度反馈

对于需要时间的流程，提供进度反馈：

// using ProcedureOwner = TEngine.IFsm<TEngine.IProcedureModule>;
protected override void OnEnter(ProcedureOwner procedureOwner)
{
    base.OnEnter(procedureOwner);
    DownloadWithProgressAsync(procedureOwner).Forget();
}

private async UniTaskVoid DownloadWithProgressAsync(ProcedureOwner procedureOwner)
{
    var downloader = GameModule.Resource.CreateResourceDownloader();
    
    // 显示进度
    while (!downloader.IsDone)
    {
        float progress = downloader.Progress;
        UpdateProgressUI(progress);
        await UniTask.Yield();
    }
    
    ChangeState<ProcedureNext>(procedureOwner);
}

🔗 相关链接

资源模块文档 - 了解资源模块的初始化流程
配置表模块文档 - 了解配置表的加载流程
框架概览 - 了解整体架构设计