欢迎来到JFramework介绍

JFramework是基于Unity的游戏框架，封装了一些常用的Unity功能。

1.导入

(1)克隆下来拖进项目进行导入(需要添加AddressableAsset和NewtonsoftJson包)

(2)打开Unity的Package Manager左上角“+”号使用URL方式导入

URL：https://github.com/1176892094/JFramework.git

2.开始

(1)在Inspector面板中找到JFramework模块

(2)在JFramework模块中点击AddressableUpdate

(3)在弹出的面板中点击Create Addressables Settings

(4)再次点击JFramework模块中点击AddressableUpdate

(5)Console打印出AddressableResources即配置成功

(6)找到JFramework的Resources文件夹将GlobalManager放入场景中

(7)点击GlobalManager找到调试管理器，将所有选项勾选

(8)点击运行Unity，没有问题，即配置成功

(9)CurrentProjectPath为当前项目路径

(10)PersistentDataPath中含有游戏的各种存档文件

(11)StreamingAssetPath在Build以后会原封不动的保留

3.功能

Excel To Scripts使用：

(1)等待教程视频

Excel To Asset使用：

(1)等待教程视频

4.注意

(1)所有的Entity都会被加入到GlobalManager的生命周期中

(2)为了更好的管理，请使用Entity来代替MonoBehaviour

(2)请使用OnUpdate来代替Update

5.使用

(1)EventManager（事件管理类）

public class Test1 : MonoBehaviour
{
    private void Awake()
    {
        EventManager.Listen(EventName.OnPlayerDeath, OnPlayerDeath); //侦听事件
    }

    private void Update()
    {
        if (Input.GetKeyDown(KeyCode.Space))
        {
            EventManager.Invoke(EventName.OnPlayerDeath); //发送事件
        }
    }

    private void OnPlayerDeath(params object[] value)
    {
        Debug.Log("玩家死亡"); //触发事件
    }

    private void OnDestroy()
    {
        EventManager.Remove(EventName.OnPlayerDeath, OnPlayerDeath); //移除事件
    }
}

public struct EventName
{
    public const int OnPlayerDeath = 1001; //建议给事件定一个常量
}

(2)AssetManager（资源加载管理类）

public class Test2 : MonoBehaviour
{
    private void Load() //同步加载
    {
        GameObject obj = AssetManager.Load<GameObject>(AssetPath.Player);
        Player player = obj.GetComponent<Player>();
    }

    private void LoadAsync() //异步加载
    {
        AssetManager.LoadAsync<GameObject>(AssetPath.Player, obj =>
        {
            Player player = obj.GetComponent<Player>(); //obj为加载出来的GameObject预制体，可以从obj中获取玩家的组件
        });
    }

    public struct AssetPath
    {
        public const string Player = "Prefabs/Player"; //Player预制的体真实路径是：Assets/AddressableResources/Prefabs/Player
    }
}

public class Player : MonoBehaviour
{
}

(3)JsonManager（找到Unity上方Tools/JFramework/PersistentPath可查看存档数据）

public class Test3 : MonoBehaviour
{
    private void SaveAndLoad1()
    {
        AssetManager.LoadAsync<ScriptableObject>(AssetPath.Data, data =>
        {
            JsonManager.Save(data, data.name); //保存SO文件,名称为"玩家数据"
            JsonManager.Load(data); //读取该SO文件
        });
    }

    private void SaveAndLoad2()
    {
        AssetManager.LoadAsync<ScriptableObject>(AssetPath.Data, data =>
        {
            JsonManager.Encrypt(data, "玩家数据"); //储存数据并加密
            JsonManager.Decrypt(data); //解析加密数据并读取
        });
    }

    private void SaveAndLoad3()
    {
        List<string> bagData = new List<string>();
        JsonManager.Save(bagData, "BagData"); //储存BagData
        bagData = JsonManager.Load<List<string>>("BagData"); //读取BagData
    }
}

public struct AssetPath
{
    public const string Data = "Settings/PlayerData"; //PlayerData真实路径是：Assets/AddressableResources/Settings/Data
}

public class PlayerData : ScriptableObject
{
    public string Name;
}

(4)PoolManager(对象池工具)

public class Test4 : MonoBehaviour
{
    private void Update()
    {
        if (Input.GetKeyDown(KeyCode.Space))
        {
            PoolManager.Pop(AssetPath.Bullet, obj =>
            {
                obj.transform.position = transform.position; //设置生成的子弹位置在自身位置
                TimerManager.Pop(3, () => //创建一个3秒的计时器
                {
                    PoolManager.Push(obj); //将物体放回对象池
                });
            });
        }
    }
}

public struct AssetPath
{
    public const string Bullet = "Prefabs/Bullet"; //Bullet的真实路径是：Assets/AddressableResources/Prefabs/Bullet
}

(5)AudioManager（游戏声音管理）

public class Test5 : MonoBehaviour
{
    private AudioSource audioSource;
    
    private void Sound()
    {
        AudioManager.PlaySound(AudioPath.BGMusic); //播放背景音乐
        AudioManager.StopSound(); //停止背景音乐
        AudioManager.SetSound(0); //改变背景音乐大小为0
    }

    private void Audio()
    {
        AudioManager.PlayAudio(AudioPath.BTClick); //播放该音效
        AudioManager.PlayAudio(AudioPath.BTClick, audio =>
        {
            audioSource = audio; //播放并获取该音效
        });
        AudioManager.StopAudio(audioSource); //停止该音效
        AudioManager.SetAudio(0); //改变游戏音效大小为0
    }
}

public struct AudioPath
{
    public const string BGMusic = "Audio/BGMusic"; //BGMusic的真实路径是：Assets/Resources/Audio/BGMusic
    public const string BTClick = "Audio/BTClick"; //BTClick的真实路径是：Assets/Resources/Audio/BTClick
}

(6)UIManager（面板数据请在Resources文件夹中找到名称为UIPanelData的Json文件）

public class Test7: MonoBehaviour
{
    private void ShowPanel()
    {
        UIManager.ShowPanel<LoginPanel>(); //加载LoginPanel(可以重复加载，但只有一个实例)
        UIManager.ShowPanel<LoginPanel>();//设置层级
        UIManager.ShowPanel<LoginPanel>(panel =>
        {
            panel.SetUsername("JINYIJIE");//设置属性
            panel.SetPassword("123456");//设置属性
        });
    }
    
    private void HidePanel()
    {
        UIManager.HidePanel<LoginPanel>(); //隐藏LoginPane
    }

    private void GetPanel()
    {
        LoginPanel panel = UIManager.GetPanel<LoginPanel>();//得到面板
        panel.SetUsername("JINYIJIE");//设置属性
        panel.SetPassword("123456");//设置属性
    }

    private void GetLayer()
    {
        UIManager.GetLayer(UILayerType.Layer1);//得到层级
        Transform common = UIManager.GetLayer(UILayerType.Layer2);
    }

    private void Clear()
    {
        UIManager.Clear();//清除并销毁所有面板
    }
}

public struct UIPanelPath
{
    public const string LoginPanel = "UI/LoginPanel";//LoginPanel的真实路径是：Assets/AddressableResources/UI/LoginPanel
}

public class LoginPanel : UIPanel //需要管理的UI都要继承BasePanel
{
    private string username;
    private string password;
    public void SetUsername(string username) => this.username = username;
    public void SetPassword(string password) => this.password = password;
}

(7)SceneManager(场景加载管理)

public class Test8 : MonoBehaviour
{
    private void Awake()
    {
        SceneManager.OnLoadScene += LoadProgress;
    }

    private void LoadScene()
    {
        SceneManager.LoadScene("SceneName");
    }

    private void LoadSceneAsync()
    {
        SceneManager.LoadSceneAsync("SceneName", () =>
        {
            //异步加载完成后执行的方法
        });
    }

    private void LoadProgress(float progress) //获取异步加载进度
    {
        Debug.Log(progress); //获取当前加载进度
    }

    private void OnDestroy()
    {
        SceneManager.OnLoadScene -= LoadProgress;
    }
}

(8)TimerManager(自定义计时器工具)

public class Test9 : MonoBehaviour
{
    private ITimer timer;

    private void Start()
    {
        timer = TimerManager.Pop(5, () =>
        {
            Debug.Log("不循环/间隔5秒的计时器完成");
        });

        TimerManager.Pop(5, () =>
        {
            Debug.Log("不循环/间隔5秒的不受TimeScale影响的计时器完成");
        }).Unscale();

        int count = 0;
        TimerManager.Pop(1, () =>
        {
            Debug.Log("循环5次/间隔1秒的计时器完成");
        }).Unscale().SetLoop(5, () =>
        {
            count++;
            Debug.Log("第" + count + "次循环完成");
        });
    }

    private void Update()
    {
        if (Input.GetKeyDown(KeyCode.Q)) timer.Stop();  //启动计时器，从剩余时间开始
        if (Input.GetKeyDown(KeyCode.E)) timer.Play();  //暂停计时器，从当前时间停止
    }
}

(9)StateMachine(有限状态机)

public class Enemy : Entity //敌人继承实体
{
    public EnemyMachine machine; //敌人状态机
    public Animator animator; //敌人动画组件

    private void Start()
    {
        machine.Enable(); //启动敌人状态机
    }

    protected override void OnUpdate()
    {
        machine.OnUpdate(); //更新敌人状态机
    }
}

public class EnemyMachine : StateMachine<Enemy> //设置状态机的所有者
{
    protected override void Start()
    {
        AddState<EnemyIdle>(); //状态机增加Idle状态
        AddState<EnemyWalk>(); //状态机增加Walk状态
    }

    public void Enable()
    {
        ChangeState<EnemyIdle>(); //启动后切换到Idle状态
    }
}

public class EnemyIdle : State<Enemy> //设置状态的所有者
{
    protected override void OnAwake()
    {
        //创建状态时调用
    }

    protected override void OnEnter()
    {
        owner.animator.SetBool("Idle", true); //播放Idle动画
        owner.machine.ChangeState<EnemyWalk>(3); //3秒后切换到Walk动画
    }

    protected override void OnUpdate() //状态更新
    {
    }

    protected override void OnExit()
    {
        owner.animator.SetBool("Idle", false); //停止Idle动画
    }
}

public class EnemyWalk : State<Enemy> //设置状态的所有者
{
    protected override void OnEnter()
    {
        owner.animator.SetBool("Walk", true); //播放Walk动画
        owner.machine.ChangeState<EnemyIdle>(3); //3秒后切换到Idle动画
    }

    protected override void OnUpdate()
    {
    }

    protected override void OnExit()
    {
        owner.animator.SetBool("Walk", false); //停止Walk动画
    }
}

(10)Entity/Controller(EC实体控制器分离)

 public class Player : EntitySpecial //玩家继承实体
{
    public BuffController buffCtrl => Get<BuffController>(); //效果控制器
    public SkillController skillCtrl => Get<SkillController>(); //技能控制器
    public AttributeController attrCtrl => Get<AttributeController>(); //属性控制器
}

public class SkillController : Controller<Player> //设置控制器的所有者
{
    private AttributeController attrCtrl => owner.attrCtrl;

    protected override void Start() //初始化方法
    {
    }
}

public class AttributeController : Controller<Player> //设置控制器的所有者
{
    private SkillController skillCtrl => owner.skillCtrl;
    private BuffController buffCtrl => owner.buffCtrl;

    protected override void Start() //初始化方法
    {
    }
}

public class BuffController : Controller<Player> //设置控制器的所有者
{
    private AttributeController attrCtrl => owner.attrCtrl;
    private SkillController skillCtrl => owner.skillCtrl;

    protected override void Start() //初始化方法
    {
    }
}

(11)AStarManager(基于JobSystem的A星寻路)

 public class Pathfinding : MonoBehaviour
{
    public int mapW;
    public int mapH;

    private void Start()
    {
        var map = new bool[mapW, mapH];
        for (int i = 0; i < mapW; i++)
        {
            for (int j = 0; j < mapH; j++)
            {
                map[i, j] = Random.Range(0, 100) > 20; //设置大于20为可行走区域
            }
        }

        AStarManager.InitMap(map); //初始化可行走的地图
    }

    private void Update()
    {
        if (Input.GetMouseButtonDown(0)) //按下鼠标
        {
            //起点位置
            var start = new AStarNode(0, 0);
            //鼠标点击位置
            var position = Camera.main.ScreenToWorldPoint(Input.mousePosition);
            //终点位置
            var end = new AStarNode((int)position.x, (int)position.y);
            //返回节点列表
            var nodeList = AStarManager.FindPath(start, end);
            StartCoroutine(MoveToNextNode(nodeList));
        }
    }

    private IEnumerator MoveToNextNode(List<AStarNode> nodeList)
    {
        var nodeIndex = 0;
        while (nodeIndex < nodeList.Count)
        {
            var nextNode = nodeList[nodeIndex];
            var position = new Vector3(nextNode.x, nextNode.y);
            while (transform.position != position)// 移动到下一个节点
            {
                transform.position = Vector3.MoveTowards(transform.position, position, Time.deltaTime);
                yield return null;
            }

            nodeIndex++;
        }
    }
}

(12)AwaitExtensions(异步拓展)

  private async void Start()
    {
        await new WaitForSeconds(1);//等待一秒
        await new WaitForSecondsRealtime(1);//等待1秒，不受timeScale影响
        await new WaitForUpdate();//在Update最后一帧执行
        await new WaitForFixedUpdate();//在FixedUpdate最后一帧执行
        await new WaitForEndOfFrame();//等待这一帧结束
        await new WaitWhile(WaitTime);//等待WaitTime结果，不会挂起异步
        await new WaitUntil(WaitTime);//等待WaitTime结果，false不会执行后面语句
        await SceneManager.LoadSceneAsync("SceneName");
        await Resources.LoadAsync("ResourcesName");
        AsyncOperation asyncOperation = new AsyncOperation();
        await asyncOperation;//等待异步操作
        ResourceRequest request = new ResourceRequest();
        await request;//等待资源请求
        AssetBundleRequest bundleRequest = new AssetBundleRequest();
        await bundleRequest;//等待AB包请求
        AssetBundleCreateRequest bundleCreateRequest = new AssetBundleCreateRequest();
        await bundleCreateRequest;//等待AB包创建请求
    }
    
    private bool WaitTime()
    {
        return true;
    }

th7903 / jframework Goto Github PK

jframework's Introduction

欢迎来到JFramework介绍

jframework's People

Contributors

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent