目录
前言：
上一篇中已经成功引入了框架，并且创建了游戏入口GameEntry。本篇的主要内容为创建游戏的启动流程ProcedureLaunch，场景转换流程ProcedureChangeScene(本来要写菜单流程但是最后发现篇幅太大。。。。）
（再次强调，本系列笔记偏实践，主要记录使用过程，对于具体的框架讲解可以搜到很多大佬的教程，同时也非常建议自行阅读源码，可以学到很多。）
如果看过StarForce可以看到它里面做了很多的流程，比如版本检测、资源检测、更新、预加载、场景切换、初始化资源等。而我这里就不全部模仿了。
在这次的案例中，我先只写几个必要的流程，先能跑起来再说。
ProcedureBase
首先在写流程之前，先实现一个基类ProdecureBase（实际上框架中已经有一个同名类了），对框架中的ProcedureBase进行进一步解耦。从StarForce的代码中可以看到这么做的一个具体作用：
//------------------------------------------------------------
// Game Framework
// Copyright © 2013-2021 Jiang Yin. All rights reserved.
// Homepage: https://gameframework.cn/
// Feedback: mailto:ellan@gameframework.cn
//------------------------------------------------------------
namespace StarForce
{
public abstract class ProcedureBase : GameFramework.Procedure.ProcedureBase
{
// 获取流程是否使用原生对话框
// 在一些特殊的流程（如游戏逻辑对话框资源更新完成前的流程）中，可以考虑调用原生对话框进行消息提示行为
public abstract bool UseNativeDialog
{
get;
}
}
}
于是咱也整一个：
namespace ShadowU
{
/// <summary>
/// 流程抽象类
/// </summary>
public abstract class ProcedureBase : GameFramework.Procedure.ProcedureBase
{
public abstract bool UseNativeDialog
{
get;
}
}
}
启动流程ProcedureLaunch
目前先不搞配置加载啥的（有的话在这个流程Enter里写上），一开始只是很简单的打开主菜单，所以运行第一帧直接跳到菜单流程ProcedureMenu：
using GameFramework.Fsm;
namespace ShadowU
{
public class ProcedureLaunch : ProcedureBase
{
public override bool UseNativeDialog
{
get
{
return true;
}
}
protected override void OnUpdate(IFsm<GameFramework.Procedure.IProcedureManager> procedureOwner, float elapseSeconds, float realElapseSeconds)
{
base.OnUpdate(procedureOwner, elapseSeconds, realElapseSeconds);
//一帧后直接转到菜单流程
ChangeState<ProcedureMenu>(procedureOwner);
}
}
}
最后别忘了设置一下启动流程（先保存代码）：
场景转换流程ProcedureChangeScene
下一步我们需要把菜单展现给玩家，但是我们目前只有一个启动场景，加载菜单的话需要加载一个菜单场景并且加载UI预制体。
所以在写菜单流程之前，需要先写一下场景切换流程。
切换场景需要用到场景名，StarForce中配置了场景名和场景ID的配置表（流程之间传递的实际上是场景名对应的ID）。获取场景ID的方式就是通过GameEntry.Config来获取配置表中对应场景名的ID（配置表应该是交给策划填写）。
所以我也来用一用GameEntry.Config。
首先创建默认配置表：
然后我这里直接在ProcedureLaunch里面预加载资源（规范点应该创建个预加载流程）。
首先在这个流程里写一个加载配置的函数：
（注：这里的AssetUtility类我直接从StarForce搬过来了,实际上就是把文件转换为路径用的。）
然后关于m_LoadedFlag字典的用处看完了整个代码和注释就知道了：
//ProcedureLaunch
using GameFramework.Fsm;
using GameFramework.Event;
using UnityGameFramework.Runtime;
using System.Collections.Generic;
namespace ShadowU
{
public class ProcedureLaunch : ProcedureBase
{
private Dictionary<string, bool> m_LoadedFlag = new Dictionary<string, bool>();//用来标记是否已经加载
public override bool UseNativeDialog
{
get
{
return true;
}
}
protected override void OnEnter(IFsm<GameFramework.Procedure.IProcedureManager> procedureOwner)
{
base.OnEnter(procedureOwner);
//注册事件
GameEntry.Event.Subscribe(LoadConfigSuccessEventArgs.EventId, OnLoadConfigSuccess);
GameEntry.Event.Subscribe(LoadConfigFailureEventArgs.EventId, OnLoadConfigFailure);
m_LoadedFlag.Clear();
//预加载配置
PreloadResources();
}
protected override void OnLeave(IFsm<GameFramework.Procedure.IProcedureManager> procedureOwner, bool isShutdown)
{
base.OnLeave(procedureOwner, isShutdown);
//注销事件
GameEntry.Event.Unsubscribe(LoadConfigSuccessEventArgs.EventId, OnLoadConfigSuccess);
GameEntry.Event.Unsubscribe(LoadConfigFailureEventArgs.EventId, OnLoadConfigFailure);
}
protected override void OnUpdate(IFsm<GameFramework.Procedure.IProcedureManager> procedureOwner, float elapseSeconds, float realElapseSeconds)
{
base.OnUpdate(procedureOwner, elapseSeconds, realElapseSeconds);
foreach(KeyValuePair<string,bool> loadedFlag in m_LoadedFlag)
{
if (!loadedFlag.Value)
{
return;//说明有资源没有加载成功
}
}
//通过加载的配置表来设置下一个转换场景的ID
procedureOwner.SetData<VarInt32>("NextSceneId",GameEntry.Config.GetInt("Scene.Menu"));
//一帧后直接转到菜单流程
ChangeState<ProcedureChangeScene>(procedureOwner);
}
private void PreloadResources()
{
LoadConfig("DefaultConfig");
}
private void LoadConfig(string configName)
{
string configAssetName = AssetUtility.GetConfigAsset(configName, false);
m_LoadedFlag.Add(configAssetName, false);
GameEntry.Config.ReadData(configAssetName, this);
}
private void OnLoadConfigSuccess(object sender, GameEventArgs e)
{
LoadConfigSuccessEventArgs ne = (LoadConfigSuccessEventArgs)e;
if (ne.UserData != this)
{
return;
}
m_LoadedFlag[ne.ConfigAssetName] = true; //资源加载成功了则设置一下标记为true
Log.Info("Load config '{0}' OK.", ne.ConfigAssetName);
}
private void OnLoadConfigFailure(object sender, GameEventArgs e)
{
LoadConfigFailureEventArgs ne = (LoadConfigFailureEventArgs)e;
if (ne.UserData != this)
{
return;
}
Log.Error("Can not load config '{0}' from '{1}' with error message '{2}'.", ne.ConfigAssetName, ne.ConfigAssetName, ne.ErrorMessage);
}
}
}
此外别忘了在场景中设置一下：
然后下面就可以开始写ProcedureChangeScene的逻辑了
主要要实现的逻辑如下：
监听场景加载成功、失败、进行中、加载场景依赖资源事件
1、停止所有声音（咱这里暂时不写，先玩一波静音游戏好叭）
2、隐藏所有实体
3、卸载所有场景
4、还原游戏速度
5、根据NextSceneId从Scene配置表搜出场景资源文件名，获取场景相对路径。使用GameEntry.Scene.LoadScene(AssetUtility.GetSceneAsset(drScene.AssetName), Constant.AssetPriority.SceneAsset, this);同步加载追加场景。其中drScene是从Scene配置表根据id找出的DRScene对象， AssetName是资源名。
直接看代码吧结合注释应该能理解。
但是，代码里面
首先要先写一个DRScene(场景数据表行类）。但是我打开了StarForce的这个类的定义我发现它的这个好像是某个工具自动生成的：
那这个是用什么生成的呢？
细心点的话就会发现StarForce里的这个：
（或者烟雨大佬的博客也提到过这个）
咱能力有限，就先不复刻（抄）这个生成工具了。
先直接写DRScene类。
一个数据表行类要完成的也是重写基类的这些东西：
然后就仿造StarForce开写（抄）呗。
然后代码中又用到一个没写过的类DataTableExtensions.cs,里面是一些通用的方法啥的，看看就懂了，直接复制过来用吧。。。。
然后其中又用到一个没写过的类Constant，没事，里面保存的是一些常量啥的，直接复刻（抄）过来。。。
然后稍微调整一下DRScene内容，就复刻（抄）完啦：
然后别忘了补上数据表:
（注：这里数据表的创建方式是先在Excel里面输入数据然后导出为记事本文件。然后！再把记事本另存为，改编码为UTF-8,否则Unity的Inspector里面会乱码.)
(仿照StarForce写的，然后把音乐相关删了）
最后，在ProcedureLaunch里面读取一下数据表：
（小总结：数据表使用流程：创建txt，编写对应的数据表行类，Load数据表，使用数据表）
（都快忘了要干啥来着）
下面继续写ProcedureChangeScene的逻辑！
通过阅读StarForce源码可以知道，开头我们列举的ProcedureChangeScene需要实现的逻辑可以放在OnEnter里面实现掉，然后OnUpdate里面实现状态机的状态切换。最终的代码如下（其中需要一个主游戏的流程ProcedureMain）(主要就看看OnEnter和OnUpdate里面的代码)：
//ProcedureChangeScene.cs
using GameFramework.Fsm;
using GameFramework.Event;
using GameFramework.DataTable;
using UnityGameFramework.Runtime;
using UnityEngine;
namespace ShadowU
{
public class ProcedureChangeScene : ProcedureBase
{
private const int MenuSceneId = 1; //菜单场景的ID
private bool m_ChangeToMenu = false; //是否转换为菜单
private bool m_IsChangeSceneComplete = false; //转换场景是否结束
public override bool UseNativeDialog
{
get
{
return true;
}
}
protected override void OnEnter(IFsm<GameFramework.Procedure.IProcedureManager> procedureOwner)
{
base.OnEnter(procedureOwner);
m_IsChangeSceneComplete = false; //如果为true的话 则在update中会切换流程
//注册事件
GameEntry.Event.Subscribe(LoadSceneSuccessEventArgs.EventId,OnLoadSceneSuccess);
GameEntry.Event.Subscribe(LoadSceneFailureEventArgs.EventId, OnLoadSceneFailure);
GameEntry.Event.Subscribe(LoadSceneUpdateEventArgs.EventId, OnLoadSceneUpdate);
GameEntry.Event.Subscribe(LoadSceneDependencyAssetEventArgs.EventId, OnLoadSceneDependencyAsset);
//隐藏所有实体
GameEntry.Entity.HideAllLoadingEntities();
GameEntry.Entity.HideAllLoadedEntities();
//卸载所有场景
string[] loadedSceneAssetNames = GameEntry.Scene.GetLoadedSceneAssetNames();
foreach (string sn in loadedSceneAssetNames)
GameEntry.Scene.UnloadScene(sn);
//还原游戏速度
GameEntry.Base.ResetNormalGameSpeed();
//获取下一个场景的ID
int sceneId = procedureOwner.GetData<VarInt32>("NextSceneId");
m_ChangeToMenu = sceneId == MenuSceneId; //判断是否是转到菜单
IDataTable<DRScene> dtScene = GameEntry.DataTable.GetDataTable<DRScene>();
DRScene drScene = dtScene.GetDataRow(sceneId); //获取数据表行
if(drScene == null)
{
Log.Warning("Can not load scene '{0}' from data table.", sceneId.ToString());
return;
}
GameEntry.Scene.LoadScene(AssetUtility.GetSceneAsset(drScene.AssetName),Constant.AssetPriority.SceneAsset,this);
}
protected override void OnLeave(IFsm<GameFramework.Procedure.IProcedureManager> procedureOwner, bool isShutdown)
{
base.OnLeave(procedureOwner, isShutdown);
GameEntry.Event.Unsubscribe(LoadSceneSuccessEventArgs.EventId, OnLoadSceneSuccess);
GameEntry.Event.Unsubscribe(LoadSceneFailureEventArgs.EventId, OnLoadSceneFailure);
GameEntry.Event.Unsubscribe(LoadSceneUpdateEventArgs.EventId, OnLoadSceneUpdate);
GameEntry.Event.Unsubscribe(LoadSceneDependencyAssetEventArgs.EventId, OnLoadSceneDependencyAsset);
}
protected override void OnUpdate(IFsm<GameFramework.Procedure.IProcedureManager> procedureOwner, float elapseSeconds, float realElapseSeconds)
{
base.OnUpdate(procedureOwner, elapseSeconds, realElapseSeconds);
if (!m_IsChangeSceneComplete)
{
return; //还没完成场景切换
}
if (m_ChangeToMenu)
{
ChangeState<ProcedureMenu>(procedureOwner); //菜单
}else
{
ChangeState<ProcedureMain>(procedureOwner); //游戏运行流程
}
}
private void OnLoadSceneSuccess(object sender,GameEventArgs e)
{
LoadSceneSuccessEventArgs ne = (LoadSceneSuccessEventArgs)e;
if(ne.UserData != this)
{
return;
}
Log.Info("Load scene '{0}' OK.", ne.SceneAssetName);
m_IsChangeSceneComplete = true;
}
private void OnLoadSceneFailure(object sender, GameEventArgs e)
{
LoadSceneFailureEventArgs ne = (LoadSceneFailureEventArgs)e;
if (ne.UserData != this)
{
return;
}
Log.Error("Load scene '{0}' failure, error message '{1}'.", ne.SceneAssetName, ne.ErrorMessage);
}
private void OnLoadSceneUpdate(object sender, GameEventArgs e)
{
LoadSceneUpdateEventArgs ne = (LoadSceneUpdateEventArgs)e;
if (ne.UserData != this)
{
return;
}
Log.Info("Load scene '{0}' update, progress '{1}'.", ne.SceneAssetName, ne.Progress.ToString("P2"));
}
private void OnLoadSceneDependencyAsset(object sender, GameEventArgs e)
{
LoadSceneDependencyAssetEventArgs ne = (LoadSceneDependencyAssetEventArgs)e;
if (ne.UserData != this)
{
return;
}
Log.Info("Load scene '{0}' dependency asset '{1}', count '{2}/{3}'.", ne.SceneAssetName, ne.DependencyAssetName, ne.LoadedCount.ToString(), ne.TotalCount.ToString());
}
}
}
然后运行！
按照剧本应该要报错了，啊确实出了问题：
尴尬，抄都不会抄了我。。。。
于是去改一下：
顺便把场景加到build settings里面：
然后测试运行：
搞定！
下面开始写菜单流程！
2023/6/28
感谢各位大佬反映出这篇博客的错误！！！
上面的步骤有个疏漏：在LoadDataTable(string dataTableName)中，通过
m_LoadedFlag.Add(dataTableAssetName, false);添加了一个加载标记，此时需要写一个和
类似的回调函数，并且注册在LoadDataTableSuccessEvent事件中，用来在数据表加载成功后设置标记为true。否则的话会一直卡在update()里面。
补充下面这些代码在ProcedureLaunch.cs里面:
private void OnLoadDataTableSuccess(object sender, GameEventArgs e)
{
LoadDataTableSuccessEventArgs ne = (LoadDataTableSuccessEventArgs)e;
if (ne.UserData != this)
{
return;
}
m_LoadedFlag[ne.DataTableAssetName] = true;
Log.Info("Load data table '{0}' OK.", ne.DataTableAssetName);
}
private void OnLoadDataTableFailure(object sender, GameEventArgs e)
{
LoadDataTableFailureEventArgs ne = (LoadDataTableFailureEventArgs)e;
if (ne.UserData != this)
{
return;
}
Log.Error("Can not load data table '{0}' from '{1}' with error message '{2}'.", ne.DataTableAssetName, ne.DataTableAssetName, ne.ErrorMessage);
}
2057
扫一扫
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
