Version: 2017.3

NetworkIdentity

class in UnityEngine.Networking

/

Inherits from:MonoBehaviour

Switch to Manual

Description

The NetworkIdentity identifies objects across the network, between server and clients. Its primary data is a NetworkInstanceId which is allocated by the server and then set on clients. This is used in network communications to be able to lookup game objects on different machines.

The NetworkIdentity is used to synchronize information in the object with the network. Only the server should create instances of objects which have NetworkIdentity as otherwise they will not be properly connected to the system.

For complex objects with a hierarchy of subcomponents, the NetworkIdentity must be on the root of the hierarchy. It is not supported to have multiple NetworkIdentity components on subcomponents of a hierarchy.

NetworkBehaviour scripts require a NetworkIdentity on the game object to be able to function.

The NetworkIdentity manages the dirty state of the NetworkBehaviours of the object. When it discovers that NetworkBehaviours are dirty, it causes an update packet to be created and sent to clients.

The flow for serialization updates managed by the NetworkIdentity is:

* Each NetworkBehaviour has a dirty mask. This mask is available inside OnSerialize as syncVarDirtyBits

* Each SyncVar in a NetworkBehaviour script is assigned a bit in the dirty mask.

* Changing the value of SyncVars causes the bit for that SyncVar to be set in the dirty mask

* Alternatively, calling SetDirtyBit() writes directly to the dirty mask

* NetworkIdentity objects are checked on the server as part of it’s update loop

* If any NetworkBehaviours on a NetworkIdentity are dirty, then an UpdateVars packet is created for that object

* The UpdateVars packet is populated by calling OnSerialize on each NetworkBehaviour on the object

* NetworkBehaviours that are NOT dirty write a zero to the packet for their dirty bits

* NetworkBehaviours that are dirty write their dirty mask, then the values for the SyncVars that have changed

* If OnSerialize returns true for a NetworkBehaviour, the dirty mask is reset for that NetworkBehaviour, so it will not send again until its value changes.

* The UpdateVars packet is sent to ready clients that are observing the object

On the client:

* an UpdateVars packet is received for an object

* The OnDeserialize function is called for each NetworkBehaviour script on the object

* Each NetworkBehaviour script on the object reads a dirty mask.

* If the dirty mask for a NetworkBehaviour is zero, the OnDeserialize functions returns without reading any more

* If the dirty mask is non-zero value, then the OnDeserialize function reads the values for the SyncVars that correspond to the dirty bits that are set

* If there are SyncVar hook functions, those are invoked with the value read from the stream.

Static Variables

clientAuthorityCallbackA callback that can be populated to be notified when the client-authority state of objects changes.

Variables

assetIdUnique identifier used to find the source assets when server spawns the on clients.
clientAuthorityOwnerThe client that has authority for this object. This will be null if no client has authority.
connectionToClientThe connection associated with this NetworkIdentity. This is only valid for player objects on the server.
connectionToServerThe UConnection associated with this NetworkIdentity. This is only valid for player objects on a local client.
hasAuthorityThis returns true if this object is the authoritative version of the object in the distributed network application.
isClientReturns true if running as a client and this object was spawned by a server.
isLocalPlayerThis returns true if this object is the one that represents the player on the local machine.
isServerReturns true if running as a server, which spawned the object.
localPlayerAuthority localPlayerAuthority means that the client of the "owning" player has authority over their own player object.
netIdUnique identifier for this particular object instance, used for tracking objects between networked clients and the server.
observersThe set of network connections (players) that can see this object.
playerControllerIdThe id of the player associated with this GameObject.
sceneIdA unique identifier for NetworkIdentity objects within a scene.
serverOnlyFlag to make this object only exist when the game is running as a server (or host).

Public Functions

AssignClientAuthorityThis assigns control of an object to a client via the client's NetworkConnection.
ForceSceneIdForce the scene ID to a specific value.
RebuildObserversThis causes the set of players that can see this object to be rebuild. The OnRebuildObservers callback function will be invoked on each NetworkBehaviour.
RemoveClientAuthorityRemoves ownership for an object for a client by its conneciton.

Delegates

ClientAuthorityCallbackThe delegate type for the clientAuthorityCallback.

Inherited members

Variables

enabledВключенное Поведение обновляется, выключенное Поведение не обновляется.
isActiveAndEnabledHas the Behaviour had enabled called.
gameObjectИгровой объект к которому прикреплён данный компонент. Компонент всегда прикреплён к игровому объекту.
tagТег данного игрового объекта.
transformThe Transform attached to this GameObject.
runInEditModeAllow a specific instance of a MonoBehaviour to run in edit mode (only available in the editor).
useGUILayoutDisabling this lets you skip the GUI layout phase.
hideFlagsShould the object be hidden, saved with the scene or modifiable by the user?
nameThe name of the object.

Public Functions

BroadcastMessageВызывает метод названный methodName на каждом MonoBehaviour этого game object-а или любого из его потомков.
CompareTagПомечен ли данный игровой объект тегом tag?
GetComponentВозвращает компонент типа type, если он прикреплен к игровому объекту и null, если не прикреплен.
GetComponentInChildrenВозвращает компонент типа type в GameObject или некоторого его потомка через поиск в глубину.
GetComponentInParentВозвращает все компоненты типа type из GameObject'а или из любого его родителя.
GetComponentsВозвращает все компоненты типа type в GameObject.
GetComponentsInChildrenВозвращает все компоненты типа type в GameObject или любому из его потомков.
GetComponentsInParentВозвращает все компоненты типа type в GameObject или любому из его родителей.
SendMessageВызывает метод с названием methodName в каждом MonoBehaviour в этом игровом объекте.
SendMessageUpwardsВызывает метод с именем methodName в каждом MonoBehaviour в этом игровом объекте и в каждом предке поведения.
CancelInvokeОтменяет все вызовы Invoke в этом MonoBehaviour.
InvokeВызывает метод methodName по истечении времени time секунд.
InvokeRepeatingВызывает метод methodName по истечении времени time секунд, затем повторяет вызов каждые repeatRate секунд.
IsInvokingЕсть ли какой то ожидающий вызов methodName?
StartCoroutineЗапуск корутины.
StopAllCoroutinesОстанавливает все корутины запущенные на этом MonoBehaviour.
StopCoroutineОстанавливает все корутины с именем methodName запущенные на этом MonoBehaviour.
GetInstanceIDReturns the instance id of the object.
ToStringReturns the name of the GameObject.

Static Functions

printLogs message to the Unity Console (identical to Debug.Log).
DestroyУдаляет GameObject, Component или Asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadMakes the object target not be destroyed automatically when loading a new scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeReturns a list of all active loaded objects of Type type.
InstantiateClones the object original and returns the clone.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.

Messages

AwakeФункция Awake вызывается когда экземпляр скрипта будет загружен.
FixedUpdateЭта функция вызывается с частотой фиксированных кадров (fixed framerate), если MonoBehaviour включен.
LateUpdateLateUpdate вызывается каждый кадр, если Behaviour включен.
OnAnimatorIKОбратный вызов (Callback) для установки IK анимации (инверсной кинематики).
OnAnimatorMoveОбратный вызов для обработки перемещения анимации для модификации смещения корня.
OnApplicationFocusПосылается ко всем игровым объектам когда плейер получает или теряет фокус.
OnApplicationPauseПосылается ко всем игровым объектам когда плейер на паузе.
OnApplicationQuitSent to all game objects before the application is quit.
OnAudioFilterReadIf OnAudioFilterRead is implemented, Unity will insert a custom filter into the audio DSP chain.
OnBecameInvisibleOnBecameInvisible is called when the renderer is no longer visible by any camera.
OnBecameVisibleOnBecameVisible is called when the renderer became visible by any camera.
OnCollisionEnterOnCollisionEnter вызывается, когда этот collider/rigidbody начал соприкосновение с другим rigidbody/collider.
OnCollisionEnter2DПередается когда входящий коллайдер контактирует с коллайдером данного объекта (только 2D физика).
OnCollisionExitOnCollisionExit вызывается, когда collider/rigidbody прекращает контакт с другим rigidbody/collider.
OnCollisionExit2DПередается, когда коллайдер другого объекта перестает соприкасаться с коллайдером этого объекта (только 2D физика).
OnCollisionStayOnCollisionStay вызывается один раз в кадр для каждого collider/rigidbody, который касается другого rigidbody/collider.
OnCollisionStay2DПередается каждый кадр, пока коллайдер другого объекта контактирует с коллайдером данного объекта (только 2D физика).
OnConnectedToServerCalled on the client when you have successfully connected to a server.
OnControllerColliderHitOnControllerColliderHit вызывается тогда, когда контроллер сталкивается с коллайдеров, во время выполнения метода Move.
OnDestroyThis function is called when the MonoBehaviour will be destroyed.
OnDisableThis function is called when the behaviour becomes disabled () or inactive.
OnDisconnectedFromServerCalled on the client when the connection was lost or you disconnected from the server.
OnDrawGizmosImplement OnDrawGizmos if you want to draw gizmos that are also pickable and always drawn.
OnDrawGizmosSelectedImplement OnDrawGizmosSelected to draw a gizmo if the object is selected.
OnEnableThis function is called when the object becomes enabled and active.
OnFailedToConnectCalled on the client when a connection attempt fails for some reason.
OnFailedToConnectToMasterServerCalled on clients or servers when there is a problem connecting to the MasterServer.
OnGUIOnGUI is called for rendering and handling GUI events.
OnJointBreakВызывается при разрушении сустава, прикрепленного к такому же игровому объекту.
OnJointBreak2DCalled when a Joint2D attached to the same game object breaks.
OnMasterServerEventCalled on clients or servers when reporting events from the MasterServer.
OnMouseDownOnMouseDown is called when the user has pressed the mouse button while over the GUIElement or Collider.
OnMouseDragOnMouseDrag is called when the user has clicked on a GUIElement or Collider and is still holding down the mouse.
OnMouseEnterCalled when the mouse enters the GUIElement or Collider.
OnMouseExitCalled when the mouse is not any longer over the GUIElement or Collider.
OnMouseOverCalled every frame while the mouse is over the GUIElement or Collider.
OnMouseUpOnMouseUp is called when the user has released the mouse button.
OnMouseUpAsButtonOnMouseUpAsButton is only called when the mouse is released over the same GUIElement or Collider as it was pressed.
OnNetworkInstantiateCalled on objects which have been network instantiated with Network.Instantiate.
OnParticleCollisionOnControllerColliderHit вызывается тогда, когда контроллер сталкивается с коллайдеров, во время выполнения метода Move.
OnParticleTriggerOnParticleTrigger is called when any particles in a particle system meet the conditions in the trigger module.
OnPlayerConnectedCalled on the server whenever a new player has successfully connected.
OnPlayerDisconnectedCalled on the server whenever a player disconnected from the server.
OnPostRenderOnPostRender is called after a camera finished rendering the scene.
OnPreCullOnPreCull вызывается до того, как камера отсечёт сцену.
OnPreRenderOnPreRender вызывается перед тем, как камера начнёт рендерить сцену.
OnRenderImageOnRenderImage вызывается после того как весь рендеринг для отрисовки изображения завершиться.
OnRenderObjectOnRenderObject вызывается после того, как камера отрендерила сцену.
OnSerializeNetworkViewUsed to customize synchronization of variables in a script watched by a network view.
OnServerInitializedCalled on the server whenever a Network.InitializeServer was invoked and has completed.
OnTransformChildrenChangedThis function is called when the list of children of the transform of the GameObject has changed.
OnTransformParentChangedThis function is called when the parent property of the transform of the GameObject has changed.
OnTriggerEnterOnTriggerEnter вызывается, когда Collider other входит в триггер.
OnTriggerEnter2DПередается, когда другой обьект входит в триггер присоединенный к данному обьекту (только 2D физика).
OnTriggerExitOnTriggerExit вызывается, когда Collider other перестает соприкасаться с триггером.
OnTriggerExit2DПередается когда другой объект покидает триггер, присоединенный к данному объекту(только 2D физика).
OnTriggerStayOnTriggerStay is called once per frame for every Collider other that is touching the trigger.
OnTriggerStay2DПередается каждый кадр, пока другой объект находится в триггере, присоединенном к этому объекту (только 2D физика).
OnValidateЭта функция вызывается когда скрипт загружается или изменяется значение в Инспекторе (Вызывается только в редакторе).
OnWillRenderObjectOnWillRenderObject is called for each camera if the object is visible and not a UI element.
ResetReset to default values.
StartStart is called on the frame when a script is enabled just before any of the Update methods is called the first time.
UpdateUpdate вызывается каждый кадр, если MonoBehaviour включен.