Mirror是一个简单高效的开源的Unity多人游戏网络框架。 官方文档链接: https://mirror-networking.gitbook.io/docs
从客户端发送指令由服务器调用
API
Mirror提供了一个特性Command 来进行从客户端到服务器的远程控制指令, 它的核心逻辑就是,当客户端 的脚本调用此特性修饰的函数时, 服务端 的对应的对象 执行此函数。 这意味着函数中的代码不会在客户端执行。
基本的用法是在需要进行远程调用的函数前编辑特性标签:
[Command]
void cmdRemoteFunction(){}
此方法是可以传参的,只要参数支持(可自动序列化与反序列化)。当然自定义的数据类型也可以通过自定义序列化与反序列化方式作为参数传递,这以后再学
使用
接下来用一个例子展示此API:
修改上一节写的Cube的控制脚本,使得每按一次空格,就会将自己的颜色改变: 这里为了更好地看到自己的Cube,所有用了Cinemachine 的一些控制,可以随便删除。
using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using Mirror;
using Cinemachine;
public class PlayerController : NetworkBehaviour
{
[SyncVar(hook = nameof(ColorChanged))]
Color PlayerColor = Color.white;
[Command]
void CmdChangeColor(Color color){
PlayerColor = color;
}
Rigidbody rb;
MaterialPropertyBlock prop;
CinemachineVirtualCamera cv;
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);
if(isLocalPlayer){
cv = GameObject.FindGameObjectWithTag("VCAM").GetComponent<CinemachineVirtualCamera>();
cv.Follow = this.transform;
cv.LookAt = this.transform;
}
}
private void Update() {
if(!isLocalPlayer) return;
if(Input.GetKeyDown(KeyCode.Space)){
CmdChangeColor(PlayerColor == Color.white?Color.black:Color.white);
}
}
}
测试
如图,一个做主机一个做客户端, 当在其中一个客户端按下空格键,大家都能看到对应的角色颜色变了。
注意点
这里隐含一个条件,那就是只有属于自己的角色,向服务器传送执行方法指令,服务器才会执行对应的角色脚本。 否则上例中,按下空格,两个方块的颜色都会改变。 我们可以通过修改Command 的requiresAuthority 参数,实现这个“否则”: [Command(requiresAuthority = false)]
从服务器发送指令由客户端调用
API
Mirror提供了一个特性ClientRpc 来进行从服务器向客户端的远程控制指令, 它的核心逻辑就是,当服务器 的脚本调用此特性修饰的函数时, 客户端 的对应的对象 执行此函数。 这意味着函数中的代码不会在服务器执行。
基本的用法是在需要在客户端执行的方法前编辑特性标签:
[ClientRpc]
void RpcRemoteFunction(){}
从服务器发送指令由指定的客户端调用
上面的Rpc会发送给所有客户端的对应对象执行, 有的时候需要发送给指定的客户端的对应对象执行。
一个简单的例子,
玩家A打了玩家B一下,玩家B的模型上,
跳出了自己掉的血的数量的文字UI,
但是我们不希望玩家A看到这个文字UI的显示,
那么就只可以通过只发送给玩家B的客户端上的B实体,
显示扣血文字的指令实现。
API
[TargetRpc]
void TargetRemoteDamaged(NetworkConnection target, int damage){}
//第一个参数可忽略,默认发给自己,也就是调用此方法的客户端实体
在上面那个例子中,当A打到B时, 显然可以获取到挂载在B对象上的NetworkIdentity , 可以通过此获取到B客户端与服务器的连接的通道NetworkIdentity.connectionToClient 。 将其作为参数TargetRpc 的第一个参数由服务器执行,即可只发送给B客户端。
当然不携带此参数,就默认发给自己。
实例
上面那个例子我也是看官方文档才理解这种做法的必要性的, 所有实例也就拿官方文档解释一下八:
public class Player : NetworkBehaviour
{
public int health;
[Command]
void CmdMagic(GameObject target, int damage)
{
target.GetComponent<Player>().health -= damage;
NetworkIdentity opponentIdentity = target.GetComponent<NetworkIdentity>();
TargetDoMagic(opponentIdentity.connectionToClient, damage);
}
[TargetRpc]
public void TargetDoMagic(NetworkConnection target, int damage)
{
// This will appear on the opponent's client, not the attacking player's
Debug.Log($"Magic Damage = {damage}");
}
// Heal thyself
[Command]
public void CmdHealMe()
{
health += 10;
TargetHealed(10);
}
[TargetRpc]
public void TargetHealed(int amount)
{
// No NetworkConnection parameter, so it goes to owner
Debug.Log($"Health increased by {amount}");
}
}
这里就是如果伤害到对方,就让对方的客户端知道自己受伤了掉了一些血,而其它客户端不知道 如果自己回血,那就只有自己知道自己回血了,比如看到绿色粒子动画效果,别人看不到。
最后的注意
[Command] 函数由客户端对象调用,内容由服务器对象执行, [ClientRpc] 和[TargetRpc] 函数都是由服务器对象调用,内容被客户端对象执行。 这里一定不能搞混,保持清醒!
|