从OW技术分享ECS到Unity提供ECS插件,我看了两三篇关于ECS的文章,但是始终不明白这到底是个啥,最近有幸换了2019版本的unity,准备借机学习一下这个ECS。这个文章也将是我一边学一边照着其他文章(视频)敲出来的,为了方便以后自己如果真的用到了可以拿出来快速回顾一下。
首先,我使用的unity版本为2019.3.4f1,我查了网上很多版本的关于ECS的文章,大部分都是基于2018版本写的,那个时候使用ECS插件还需要一份官方提供的XML文件,但是现在网站已经挂掉了,下载不到了。
还好我在瞎逛github的时候,找到了一个好多星星的插件:Entitas-CSharp,然后发现这个插件已经做成了压缩包,而且有一些教学视频,我就准备通过这个插件入手,从零开始浅浅的接触一下ECS,这里我下载的是1.13.0版本的插件。
插件的全部内容就在上面了,没有实际的代码,没有示例场景,啥都没有,只有纯插件,还好git上有相关的讲解视频。
首先,我们需要先初始化一下插件,在工具栏中会出现一个tools页签,选择preferences可以弹出一个具体的设置界面。
这里正常来说点击auto import插件就会自动帮你设置成默认的设置,但是如果你的C#Project不在默认位置的话可能会出现问题,所以要确认一下csproj的位置,然后就可以生成对应的代码了。这个代码在每次修改ECS代码或者新增代码的时候都需要重新生成。工具中有提供生成代码的快捷键,而且视频中有介绍如何使用指令生成代码或是在你的IDE中集成生成代码的功能(视频中使用的rider,我也不确定其他IDE可不可以,我只是来学学ECS,快捷生成代码还是以后再学习吧)
然后!!我们就可以来编写一些简单的ECS代码了
1.编写第一段Entity,Component代码
接下来,我们就要开始编写第一段ECS代码了。首先新建一个C#脚本(我是跟着视频做的,新建了一个HealthComponent脚本),然后填充第一个属性,就像下面这样:
第一个脚本就已经写好了,接下来回到Unity,运行一下刚才tools工具栏下的generator生成相关代码:
public partial class GameEntity {
public HealthComponent health { get { return (HealthComponent)GetComponent(GameComponentsLookup.Health); } }
public bool hasHealth { get { return HasComponent(GameComponentsLookup.Health); } }
public void AddHealth(float newValue) {
var index = GameComponentsLookup.Health;
var component = (HealthComponent)CreateComponent(index, typeof(HealthComponent));
component.value = newValue;
AddComponent(index, component);
}
public void ReplaceHealth(float newValue) {
var index = GameComponentsLookup.Health;
var component = (HealthComponent)CreateComponent(index, typeof(HealthComponent));
component.value = newValue;
ReplaceComponent(index, component);
}
public void RemoveHealth() {
RemoveComponent(GameComponentsLookup.Health);
}
}
可以看到生成的HealthComponent脚本中包含了三个函数:AddHealth,ReplaceHealth,RemoveHealth。后面关于实体的操作应该也是通过这三个函数进行的。
下面我们就可以使用代码创建实体了,首先我们需要先创建一个Contexts对象,然后通过这个对象进行创建Entity,创建出来的Entity可以拥有我们之前编写的组件(component):
using System.Collections;
using System.Collections.Generic;
using UnityEngine;
public class GameController : MonoBehaviour
{
// Start is called before the first frame update
void Start()
{
var context = new Contexts();
var e = context.game.CreateEntity();
//给实体赋予组件功能
e.AddHealth(100);
}
}
进行到这里,我们的第一段代码就已经写完了,在一个空场景中挂上这个GameController组件后运行游戏就可以在场景中看到这样的结构:
这就表示我们拥有一个实体,这个实体有一个组件列表,其中有一个组件名字叫Health,其中Health的值是100。这和我们刚才的代码完全吻合!
这里我们可以发现实体被分为两大类,分别是:game和input,这个是在上面的jenny设置面板中设置的:
在contexts中我们可以查看这个模块中有多少实体,包括正在使用的和被回收放在池子中的实体(Reusable entities),当实体被回收时会自动放入回收池中供下次使用:
2.编写第一段System代码
上面我们已经写了ECS中的EC模块,接下来再写一段S模块的代码,今天就可以打完收工了!和Component类似,我们需要再新建一个脚本来编写System:
using Entitas;
public sealed class LogHealthSystem : IExecuteSystem
{
readonly IGroup<GameEntity> _entities;
public LogHealthSystem(Contexts contexts) {
_entities = contexts.game.GetGroup(GameMatcher.Health);
}
public void Execute()
{
foreach (var e in _entities)
{
UnityEngine.Debug.Log(e.health.value);
}
}
}
这个System的作用是把health的值打印出来,首先这个类继承自IExecuteSystem,那么需要实现Execute接口,也就是这个System的具体执行操作。然后我们可以通过函数的构造函数拿到Context(感觉这个Context是一个管理类,其中包括了game和input两个大类一样的)。然后可以通过GetGroup函数可以拿到有对应组件的实体列表。然后我们就可以在excute函数执行我们想要做的事情了。
此外,之前在GameController中获取context是通过实例化一个新的context,除此之外还可以通过Contexts.sharedInstance拿到全局通用的Contexts。接下来我们在这里创建一个新的System,并把刚才的context传入构造函数并执行。
void Start()
{
var context = Contexts.sharedInstance;
var e = context.game.CreateEntity();
e.AddHealth(100);
var system = new LogHealthSystem(context);
system.Execute();
}
这样我们就可以在自己想要执行System的时候调用对应System的excute就可以执行对应的系统。
3.更多的System系统
1.反应式System
如果你不想通过执行某个函数来调用一个系统,而是希望当实体的组件内的值变化时调用一个系统,我们可以使用一种反应式的System实现:
using Entitas;
using System.Collections.Generic;
public sealed class LogHealthSystem : ReactiveSystem<GameEntity>
{
public LogHealthSystem(Contexts contexts) : base(contexts.game) { }
protected override void Execute(List<GameEntity> entities)
{
foreach (var e in entities)
{
UnityEngine.Debug.Log(e.health.value);
}
}
protected override bool Filter(GameEntity entity)
{
return true;
}
protected override ICollector<GameEntity> GetTrigger(IContext<GameEntity> context)
{
return context.CreateCollector(GameMatcher.Health);
}
}
和刚才的System差不多,不过这里是通过GetTrigger获取你想要关心的组件。遗憾的是,这种反应式的组件还是没法做到自行反应,我们还是需要在update函数中执行调用函数才能达到我们想要的效果:
public class GameController : MonoBehaviour
{
LogHealthSystem system;
// Start is called before the first frame update
void Start()
{
var context = Contexts.sharedInstance;
var e = context.game.CreateEntity();
e.AddHealth(100);
system = new LogHealthSystem(context);
}
private void Update()
{
system.Execute();
}
}
2.初始化式System
这个就不用说太多废话了,就是可以用来初始化或者初始化某些实体的System:
using Entitas;
public sealed class CreatePlayerSystem : IInitializeSystem
{
readonly Contexts _contexts;
public CreatePlayerSystem(Contexts contexts) {
_contexts = contexts;
}
public void Initialize()
{
var e = _contexts.game.CreateEntity();
e.AddHealth(100);
}
}
调用起来和其他的System一样,在GameController里实例化一个系统,然后调用初始化函数:
public class GameController : MonoBehaviour
{
LogHealthSystem system;
CreatePlayerSystem createPlayerSystem;
// Start is called before the first frame update
void Start()
{
var context = Contexts.sharedInstance;
system = new LogHealthSystem(context);
createPlayerSystem = new CreatePlayerSystem(context);
createPlayerSystem.Initialize();
}
private void Update()
{
system.Execute();
}
}
3.System的根节点
说白了就是一个所有System的集合:
public sealed class SystemRoot : Feature
{
public SystemRoot(Contexts contexts) {
Add(new CreatePlayerSystem(contexts));
Add(new LogHealthSystem(contexts));
}
}
但是直接调用这个集合的初始化或者执行函数,其中的所有系统都可以执行对应函数,所以还是很方便的:
public class GameController : MonoBehaviour
{
SystemRoot _systems;
void Start()
{
_systems = new SystemRoot(Contexts.sharedInstance);
_systems.Initialize();
}
private void Update()
{
_systems.Execute();
}
}