UnityMirror学习笔记(2)：使用SyncVar进行数据同步

Cake_C

已于 2022-02-27 17:08:51 修改

阅读量7.4k

点赞数 13

分类专栏： Unity学习笔记文章标签：学习 c# 开发语言

于 2022-02-27 15:41:12 首次发布

本文链接：https://blog.csdn.net/Cake_C/article/details/123165160

版权

Unity学习笔记专栏收录该内容

20 篇文章

订阅专栏

Mirror是一个简单高效的开源的Unity多人游戏网络框架。
在这里按照油管dalao的教学流程，与官方文档学习常用的API及操作。

https://mirror-networking.gitbook.io/docs

API

Mirror提供了一个特性SyncVar来进行数据同步，
它的核心逻辑就是，当服务器的场景中的一个SyncVar的值发生变化时，就同步给其它所有客户端。

基本的用法是在需要进行同步的变量前编辑特性标签：

[SyncVar]
Color colorNeededToSynchronize;

其中经常定义hook参数，
当数据发生变化时，就自动调用一个自定义的函数MySetColor函数，
注意这个函数只会在客户端调用（当然主机也运行了一个客户端）
而MySetColor的声明如下，提供了新旧值的访问，
注意新旧值的类型与监听的数值的类型一致：

[SyncVar(hook = nameof(MySetColor))]
void MySetColor(Color oldColor, Color newColor)

在编写代码的时候要注意，使用此特性标注的变量，只应该在服务器上对此变量进行更改
而通过hook在客户端作用此更改

使用

接下来用一个例子展示此API：
为上一节写的Cube添加一个控制脚本。
注意脚本继承自NetworkBehaviour，命名空间using Mirror;
以便获取到Mirror的API：

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using Mirror;

public class PlayerController : NetworkBehaviour
{
    [SyncVar(hook = nameof(ColorChanged))]
    Color PlayerColor = Color.white;

    Rigidbody rb;
    MaterialPropertyBlock prop;

    void ColorChanged(Color oldColor, Color newColor){
        Debug.Log("Color Changed");
        prop.SetColor("_Color" ,newColor);
        GetComponent<Renderer>().SetPropertyBlock(prop);
    }

    private void Start() {
        rb = GetComponent<Rigidbody>();
        prop = new MaterialPropertyBlock();
        GetComponent<Renderer>().GetPropertyBlock(prop);
    }

    float duringTimer = 0f;
    private void Update() {
        rb.velocity = new Vector3(0,0,0);
        if(isServer){
            if(duringTimer < 2f){
                duringTimer+=Time.deltaTime;
            }else{
                duringTimer = 0f;
                PlayerColor = PlayerColor==Color.white?Color.black:Color.white;
            }
        }
    }
}

这一段代码的功能就是，每隔2秒改变一次玩家的颜色。
尤其注意代码中一个API isServer，
这说明下面这段代码只会在服务器上运行，而客户端是不会运行的，

    if(isServer){
        if(duringTimer < 2f){
            duringTimer+=Time.deltaTime;
        }else{
            duringTimer = 0f;
            PlayerColor = PlayerColor==Color.white?Color.black:Color.white;
        }
    }

整体的逻辑就是：

服务器上的每一个主角物体，
每两秒改变一次PlayerColor的值，
然后服务器通过SyncVar将改变前后的值发送给每一个客户端，
接下来每一个客户端对应的物体调用hook函数也就是ColorChanged(Color oldColor, Color newColor)函数，
将值改变带来的效果作用到自己的场景中。