NetworkIdentity

class in UnityEngine.Networking

描述

NetworkIdentity 用于标识服务器与客户端之间的网络中的对象。其主数据为 NetworkInstanceId，由服务器分配，在客户端上设置。这一数据在网络通信中使用，用于查找不同计算机上的游戏对象。

NetworkIdentity 用于将对象中的信息与网络同步。只有服务器应该创建具有 NetworkIdentity 的对象实例，否则它们将无法正确连接到系统。

对于具有子组件层级结构的复杂对象，NetworkIdentity 必须位于层级结构的根层中。层级结构的子组件不能具有多个 NetworkIdentity 组件。

NetworkBehaviour 脚本需要游戏对象具有 NetworkIdentity 才能发挥作用。

NetworkIdentity 负责处理对象的 NetworkBehaviours 的污染状态。发现 NetworkBehaviours 被污染时，其会让系统创建一个更新数据包并发送给客户端。

NetworkIdentity 管理的序列化更新流程如下：

* 每个 NetworkBehaviour 都有一个污染掩码。该掩码位于 OnSerialize 内，形式为 syncVarDirtyBits

* NetworkBehaviour 脚本中的每个 SyncVar 都在污染掩码中分配了一个位。

* 更改 SyncVars 的值会导致设置该 SyncVar 在污染掩码中对应的位

* 或者，调用 SetDirtyBit() 可以直接写入污染掩码

* 在服务器更新过程中，检查服务器上的 NetworkIdentity 对象

* 如果 NetworkIdentity 上的任何 NetworkBehaviours 被污染，则为该对象创建一个 UpdateVars 数据包

* 通过在对象上的每个 NetworkBehaviour 上调用 OnSerialize 来填充 UpdateVars 数据包

* 未污染的 NetworkBehaviours 向数据包中对应的污染位写入零

* 被污染的 NetworkBehaviours 会写入其污染掩码，然后写入发生变化的 SyncVars 的值

* 如果 NetworkBehaviour 的 OnSerialize 返回 true，则该 NetworkBehaviour 的污染掩码会被重置，因此其在自己的值变化之前不会再次发送

* UpdateVars 数据包被发送到正在观察对象并且准备好的客户端

在客户端上：

* 接收到对象的 UpdateVars 数据包

* 针对对象上的每个 NetworkBehaviour 脚本调用 OnDeserialize 函数

* 对象上的每个 NetworkBehaviour 脚本都会读取一个污染掩码。

* 如果某个 NetworkBehaviour 的污染掩码为零，则 OnDeserialize 会返回而不再读取

* 如果污染掩码为非零值，则 OnDeserialize 函数会读取与设置的污染位对应的 SyncVars 的值

* 如果存在 SyncVar 挂钩函数，则系统会使用从流中读取的值调用这种函数。

静态变量

clientAuthorityCallback

一种可以填充的回调，以便在对象的客户端权限状态发生更改时得到通知。

变量

assetId	在客户端上生成服务器时用于查找资源的唯一标识符。
clientAuthorityOwner	对该对象拥有权限的客户端。如果没有客户端拥有权限，则此属性为空。
connectionToClient	与此 NetworkIdentity 关联的连接。此属性只对服务器上的玩家对象有效。
connectionToServer	与此 NetworkIdentity 关联的 UConnection。此属性只对本地客户端上的玩家对象有效。
hasAuthority	如果该对象是分布式网络应用程序中对象的权威版本，则返回 true。
isClient	如果作为客户端运行，且该对象由服务器生成，则返回 true。
isLocalPlayer	如果该对象代表本地机器上的玩家，则返回 true。
isServer	如果作为生成对象的服务器运行，则返回 true。
localPlayerAuthority	localPlayerAuthority 意味着“有所有权”的玩家的客户端对其自己的玩家对象拥有权限。
netId	此特定对象实例的唯一标识符，用于跟踪联网的客户端与服务器之间的对象。
observers	可以看到此项目的一组网络连接（玩家）。
playerControllerId	与此游戏对象关联的玩家的 ID。
sceneId	用于场景中的 NetworkIdentity 对象的唯一标识符。
serverOnly	用于让此对象只在游戏作为服务器（或主机）运行时存在的标志。

公共函数

AssignClientAuthority	通过客户端的 NetworkConnection 将对象的控制权分配给客户端。
ForceSceneId	将场景 ID 强制设置为特定值。
RebuildObservers	这会导致重新构建可以看到此对象的玩家组。OnRebuildObservers 回调函数会在每次出现 NetworkBehaviour 时被调用。
RemoveClientAuthority	通过连接删除客户端对对象的所有权。

委托

ClientAuthorityCallback

clientAuthorityCallback 的委托类型。

继承的成员

变量

enabled	启用的 Behaviour 可更新，禁用的 Behaviour 不可更新。
isActiveAndEnabled	已调用启用的 Behaviour。
gameObject	此组件附加到的游戏对象。始终将组件附加到游戏对象。
tag	此游戏对象的标签。
transform	附加到此 GameObject 的 Transform。
runInEditMode	允许 MonoBehaviour 的特定实例在编辑模式下运行（仅可在 Editor 中使用）。
useGUILayout	禁用该属性可跳过 GUI 布局阶段。
hideFlags	该对象应该隐藏、随场景一起保存还是由用户修改？
name	对象的名称。

公共函数

BroadcastMessage	调用此游戏对象或其任何子项中的每个 MonoBehaviour 上名为 methodName 的方法。
CompareTag	此游戏对象是否使用 tag 进行了标记？
GetComponent	如果游戏对象附加了类型为 type 的组件，则将其返回，否则返回 null。
GetComponentInChildren	使用深度首次搜索返回 GameObject 或其任何子项中类型为 type 的组件。
GetComponentInParent	返回 GameObject 或其任何父项中类型为 type 的组件。
GetComponents	返回 GameObject 中类型为 type 的所有组件。
GetComponentsInChildren	返回 GameObject 或其任何子项中类型为 type 的所有组件。
GetComponentsInParent	返回 GameObject 或其任何父项中类型为 type 的所有组件。
SendMessage	调用此游戏对象中的每个 MonoBehaviour 上名为 methodName 的方法。
SendMessageUpwards	调用此游戏对象中的每个 MonoBehaviour 上或此行为的每个父级上名为 methodName 的方法。
CancelInvoke	取消该 MonoBehaviour 上的所有 Invoke 调用。
Invoke	在 time 秒后调用 methodName 方法。
InvokeRepeating	在 time 秒后调用 methodName 方法，然后每 repeatRate 秒调用一次。
IsInvoking	是否有任何待处理的 methodName 调用？
StartCoroutine	启动一个协同程序。
StopAllCoroutines	停止在该行为上运行的所有协同程序。
StopCoroutine	停止在该行为上运行的第一个名为 methodName 的协同程序或存储在 routine 中的协同程序。
GetInstanceID	返回对象的实例 ID。
ToString	返回 GameObject 的名称。

静态函数

print	将消息记录到 Unity 控制台（与 Debug.Log 相同）。
Destroy	删除 GameObject、组件或资源。
DestroyImmediate	立即销毁对象 /obj/。强烈建议您改用 Destroy。
DontDestroyOnLoad	在加载新的 Scene 时，请勿销毁 Object。
FindObjectOfType	返回第一个类型为 type 的已加载的激活对象。
FindObjectsOfType	返回所有类型为 type 的已加载的激活对象的列表。
Instantiate	克隆 original 对象并返回克隆对象。

运算符

bool	该对象是否存在？
operator !=	比较两个对象是否引用不同的对象。
operator ==	比较两个对象引用，判断它们是否引用同一个对象。

消息

Awake	Awake 在加载脚本实例时调用。
FixedUpdate	如果启用了 MonoBehaviour，则每个固定帧率帧调用该函数。
LateUpdate	如果启用了 Behaviour，则每帧调用 LateUpdate。
OnAnimatorIK	用于设置动画 IK（反向运动学）的回调。
OnAnimatorMove	用于处理动画移动以修改根运动的回调。
OnApplicationFocus	当玩家获得或失去焦点时，发送给所有 GameObject。
OnApplicationPause	当应用程序暂停时，发送给所有 GameObject。
OnApplicationQuit	在应用程序退出前，发送给所有游戏对象。
OnAudioFilterRead	如果实现了 OnAudioFilterRead，Unity 将在音频 DSP 链中插入一个自定义滤波器。
OnBecameInvisible	OnBecameInvisible 在渲染器对任何摄像机都不可见时调用。
OnBecameVisible	OnBecameVisible 在渲染器变为对任意摄像机可见时调用。
OnCollisionEnter	当该碰撞体/刚体已开始接触另一个刚体/碰撞体时，调用 OnCollisionEnter。
OnCollisionEnter2D	当传入碰撞体与该对象的碰撞体接触时发送（仅限 2D 物理）。
OnCollisionExit	当该碰撞体/刚体已停止接触另一个刚体/碰撞体时，调用 OnCollisionExit。
OnCollisionExit2D	当另一个对象上的碰撞体停止接触该对象的碰撞体时发送（仅限 2D 物理）。
OnCollisionStay	对应正在接触刚体/碰撞体的每一个碰撞体/刚体，每帧调用一次 :ref::OnCollisionStay。
OnCollisionStay2D	在另一个对象上的碰撞体正在接触该对象的碰撞体时发送每个帧（仅限 2D 物理）。
OnConnectedToServer	成功连接到服务器后在客户端上调用。
OnControllerColliderHit	当该控制器在执行 Move 时撞到碰撞体时调用 OnControllerColliderHit。
OnDestroy	销毁附加的行为将导致游戏或场景收到 OnDestroy。
OnDisable	该函数在行为被禁用时调用。
OnDisconnectedFromServer	当连接丢失或与服务器断开连接时，在客户端上调用。
OnDrawGizmos	如果您想绘制能够选择并且始终绘制的辅助图标，则可以实现 OnDrawGizmos。
OnDrawGizmosSelected	如果选择了对象，则实现 OnDrawGizmosSelected 来绘制辅助图标。
OnEnable	该函数在对象变为启用和激活状态时调用。
OnFailedToConnect	出于某种原因连接尝试失败时，在客户端上调用。
OnFailedToConnectToMasterServer	在连接到 MasterServer 时发生问题的情况下，在客户端或服务器上调用。
OnGUI	系统调用 OnGUI 来渲染和处理 GUI 事件。
OnJointBreak	在附加到相同游戏对象的关节断开时调用。
OnJointBreak2D	在附加到相同游戏对象的 Joint2D 断开时调用。
OnMasterServerEvent	在从 MasterServer 报告事件时，在客户端或服务器上调用。
OnMouseDown	当用户在 GUIElement 或 Collider 上按下鼠标按钮时，将调用 OnMouseDown。
OnMouseDrag	当用户单击 GUIElement 或 Collider 并仍然按住鼠标时，将调用 OnMouseDrag。
OnMouseEnter	当鼠标进入 GUIElement 或 Collider 时调用。
OnMouseExit	当鼠标不再处于 GUIElement 或 Collider 上方时调用。
OnMouseOver	当鼠标悬停在 GUIElement 或 Collider 上时，每帧调用一次。
OnMouseUp	当用户松开鼠标按钮时，将调用 OnMouseUp。
OnMouseUpAsButton	松开鼠标时，仅当鼠标在按下时所在的 GUIElement 或 Collider 上时，才调用 OnMouseUpAsButton。
OnNetworkInstantiate	在已通过 Network.Instantiate 进行网络实例化的对象上调用。
OnParticleCollision	当粒子击中碰撞体时，将调用 OnParticleCollision。
OnParticleSystemStopped	系统中的所有粒子都死亡时，便会调用 OnParticleSystemStopped，然后将不再产生新粒子。在调用 Stop 之后，或者超过非循环系统的 Duration 属性时，将停止产生新粒子。
OnParticleTrigger	当粒子系统中的任何粒子满足触发模块中的条件时，将调用 OnParticleTrigger。
OnPlayerConnected	每当有新玩家成功连接，就在服务器上调用。
OnPlayerDisconnected	每当有玩家与服务器断开连接，就在服务器上调用。
OnPostRender	在摄像机完成场景渲染后，将调用 OnPostRender。
OnPreCull	在摄像机剔除场景前，将调用 OnPreCull。
OnPreRender	在摄像机开始渲染场景前，将调用 OnPreRender。
OnRenderImage	OnRenderImage 在图像的所有渲染操作全部完成后调用。
OnRenderObject	在摄像机渲染场景后，将调用 OnRenderObject。
OnSerializeNetworkView	用于在网络视图监视的脚本中自定义变量同步。
OnServerInitialized	每当调用 Network.InitializeServer 并且完成时，对该服务器调用该函数。
OnTransformChildrenChanged	当 GameObject 的变换的子项列表发生更改时，将调用该函数。
OnTransformParentChanged	当 GameObject 的变换的父属性发生更改时，将调用该函数。
OnTriggerEnter	GameObject 与另一 GameObject 碰撞时，将调用 OnTriggerEnter。
OnTriggerEnter2D	当另一个对象进入附加到该对象的触发碰撞体时发送（仅限 2D 物理）。
OnTriggerExit	当 Collider other 已停止接触该触发器时调用 OnTriggerExit。
OnTriggerExit2D	当另一个对象离开附加到该对象的触发碰撞体时发送（仅限 2D 物理）。
OnTriggerStay	对于接触触发器的每一个 Collider /other/，每次物理更新调用一次 OnTriggerStay。
OnTriggerStay2D	在另一个对象位于附加到该对象的触发碰撞体之内时发送每个帧（仅限 2D 物理）。
OnValidate	加载脚本后或 Inspector 中的值发生更改时，将调用该函数（只能在 Editor 中调用）。
OnWillRenderObject	如果对象可见并且不是 UI 元素，则为每个摄像机调用 OnWillRenderObject。
Reset	重置为默认值。
Start	在首次调用任何 Update 方法之前启用脚本时，在帧上调用 Start。
Update	如果启用了 MonoBehaviour，则每帧调用 Update。

脚本 API

NetworkIdentity

描述

静态变量

变量

公共函数

委托

继承的成员

变量

公共函数

静态函数

运算符

消息