Version: 2018.2

NetworkIdentity

class in UnityEngine.Networking

/

継承:MonoBehaviour

マニュアルに切り替える

説明

NetworkIdentity はサーバーとクライアント間のネットワークをまたいでオブジェクトを識別します。その主要なデータは、サーバーによって配置され、それからクライアント上で設定される NetworkInstanceId です。これは、ネットワーク通信において、異なるマシンでゲームオブジェクトを見つけるために使用されます。

NetworkIdentity は、オブジェクトの情報をネットワークと同期するのに使用されます。サーバーだけが NetworkIdentity コンポーネントを持ったオブジェクトのインスタンスを作成しなければなりません。そうでないと、インスタンスがシステムと正しく接続されません。

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 スクリプトが正常に機能するためには、ゲームオブジェクト上に NetworkIdentity を必要とします。

NetworkIdentity はオブジェクトの NetworkBehaviours のダーティな状態を管理します。NetworkBehaviours がダーティであるのを見つけると、更新パケットを作成しクライアントに送信します。

NetworkIdentity に管理されるシリアライズの更新のフローは以下のとおりです。

* 各 NetworkBehaviour がダーティマスクを持つ。このマスクは OnSerialize の中で syncVarDirtyBits として使用可能。

* NetworkBehaviour スクリプト内のそれぞれの SyncVar にダーティマスクの中のビットが一つアサインされる。

* SyncVar の値が変更されると、その SyncVar 用のビットがダーティマスク内に設定される。

* または、SetDirtyBit() の呼び出しによって直接ダーティマスクに記述される。

* NetworkIdentity オブジェクトが、更新のループの一部としてサーバー上で検証される。

* NetworkIdentity の NetworkBehaviour にダーティなものがある場合、UpdateVars パケットがそのオブジェクト用に作成される。

* UpdateVars パケットが OnSerialize の呼び出しによってオブジェクトの各 NetworkBehaviour に追加される。

* ダーティでない NetworkBehaviour が、そのダーティビットのパケットに 0 を記述する。

* ダーティな NetworkBehaviour がそのダーティマスクを記述し、その後、変更された SyncVars の値を記述する。

* 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.

* UpdateVars パケットが、オブジェクトを観測しているクライアントで準備の整ったものに送信される。

クライアント上での流れ:

* UpdateVars パケットがオブジェクト用に受け取られる。

* OnDeserialize 関数がオブジェクトの各 NetworkBehaviour スクリプト用に呼び出される。

* オブジェクトの各 NetworkBehaviour スクリプトがダーティマスクを一つ読む。

* NetworkBehaviour のダーティマスクが 0 だと OnDeserialize 関数は、それ以上読み込むことなくリターンします。

* ダーティマスクが 0 以外の値だと、OnDeserialize 関数は、設定されたダーティビットに対応する SyncVar 用の値を読み出します。

* SyncVar フック関数がある場合、それはストリームから読み出された値によって実行されます。

Static 変数

clientAuthorityCallbackオブジェクトのクライアント権限の状態が変更したとき、通知されるように設定することができるコールバック

変数

assetIdサーバーに接続されているすべてのクライアント上にゲームオブジェクトが生成されるときソースアセット(source asset)を見つけるために使う一意の識別子
clientAuthorityOwnerこのオブジェクトの権限を持っているクライアント。クライアントが権限を持たない場合は null になります。
connectionToClientこの NetworkIdentity に関連付けられた接続。これはサーバー上のプレイヤーオブジェクトのみ有効です。
connectionToServerこの NetworkIdentity に関連付けられた UConnection。これはローカルクライアント上のプレイヤーオブジェクトのみを有効にします。
hasAuthorityオブジェクトが、分散ネットワークアプリケーションのオブジェクトの正式バージョンである場合は true を返します。
isClientクライアントで実行され、オブジェクトがサーバーによって生成されている場合は true を返します。
isLocalPlayerオブジェクトがローカルプレイヤーである場合は true
isServerサーバー上で生成されたオブジェクトがサーバー上で実行している場合、True を返します。
localPlayerAuthority localPlayerAuthority とは、「所有権」(owning)を有するプレイヤーのクライアントが自分のゲームのプレーヤーオブジェクトに対する権限を有することを意味します。
netIdこの特殊なオブジェクトのインスタンスに関するユニークな識別子は、ネットワーク接続されたクライアントやサーバー間のオブジェクトを追跡するために使われます。
observersこのオブジェクトを見ることができるネットワークコネクション(プレイヤー)の設定
playerControllerIdオブジェクトに関連付けられたプレイヤーの ID 番号
sceneIdシーン内で NetworkIdentity オブジェクトのユニークな識別子です。
serverOnlyゲームがサーバー(またはホスト)として実行しているとき、このオブジェクトだけをシーンに存在させるためのフラグです。

Public 関数

AssignClientAuthorityクライアントの NetworkConnection を通じてクライアントにオブジェクトのコントロールを割り当てられます。
ForceSceneIdシーン ID に特定の値を強制的に設定します。
RebuildObserversこのコンポーネントをアタッチしているオブジェクトをリビルドすることをプレイヤーに通知することができます。OnRebuildObserver のコールバック関数は NetworkBehaviour ごとに実行されます。
RemoveClientAuthorityその接続でクライアントのオブジェクトの所有権を削除します。

デリゲート

ClientAuthorityCallbackClientAuthorityCallback のデリゲート型

継承メンバー

変数

enabled有効であれば更新され、無効であれば更新されません。
isActiveAndEnabledBehaviour が有効かどうか
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).
useGUILayoutこれを無効にすると、GUI のレイアウトフェーズをスキップすることができます
hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameオブジェクト名

Public 関数

BroadcastMessageゲームオブジェクトまたは子オブジェクトにあるすべての MonoBehaviour を継承したクラスにある methodName 名のメソッドを呼び出します。
CompareTagこのゲームオブジェクトは tag とタグ付けされているかどうか
GetComponentゲームオブジェクトに type がアタッチされている場合は type のタイプを使用してコンポーネントを返します。ない場合は null です
GetComponentInChildren GameObject や深さ優先探索を活用して、親子関係にある子オブジェクトから type のタイプのコンポーネントを取得します。
GetComponentInParent GameObject や深さ優先探索を活用して、親子関係にある親オブジェクトから type のタイプのコンポーネントを取得します。
GetComponents GameObject から type のタイプのコンポーネントを「すべて」取得します。
GetComponentsInChildren GameObject や深さ優先探索を活用して、親子関係にある子オブジェクトから type のタイプのコンポーネントを「すべて」取得します。
GetComponentsInParent GameObject や深さ優先探索を活用して、親子関係にある親オブジェクトから type のタイプのコンポーネントを「すべて」取得します。
SendMessageゲームオブジェクトにアタッチされているすべての MonoBehaviour にある methodName と名付けたメソッドを呼び出します
SendMessageUpwardsゲームオブジェクトと親(の親、さらに親 ... )にアタッチされているすべての MonoBehaviour にある methodName と名付けたメソッドを呼び出します
CancelInvokeすべての Invoke をキャンセルします
Invoke設定した時間(単位は秒)にメソッドを呼び出します
InvokeRepeating設定した時間(単位は秒)にメソッドを呼び出し、repeatRate 秒ごとにリピートします
IsInvokingメソッドの呼出が保留中かどうか
StartCoroutineコルーチンを開始します
StopAllCoroutinesBehaviour 上で実行されているコルーチンをすべて停止します
StopCoroutineこの Behaviour 上で実行されている methodName という名のコルーチン、または routine として保持されているコルーチンをすべて停止します
GetInstanceIDオブジェクトのインスタンス ID を返します
ToStringReturns the name of the GameObject.

Static 関数

printUnity コンソールにログを出力します (Debug.Log と同じです)
Destroyゲームオブジェクトやコンポーネント、アセットを削除します
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindObjectOfTypeタイプ type から最初に見つけたアクティブのオブジェクトを返します
FindObjectsOfTypeタイプから見つけたすべてのアクティブのオブジェクト配列を返します
Instantiateoriginal のオブジェクトをクローンします

Operator

boolオブジェクトが存在するかどうか
operator !=二つのオブジェクトが異なるオブジェクトを参照しているか比較します
operator ==2つのオブジェクト参照が同じオブジェクトを参照しているか比較します。

メッセージ

Awakeスクリプトのインスタンスがロードされたときに呼び出されます
FixedUpdateMonoBehaviour が有効の場合、この関数は毎回、固定フレームレートで呼び出されます。
LateUpdate Behaviour が有効の場合、LateUpdate は毎フレーム呼びだされます
OnAnimatorIKアニメーション IK (インバースキネマティクス)をセットアップするときのコールバック
OnAnimatorMoveルートモーションを修正するアニメーション動作を処理するコールバック
OnApplicationFocusプレイヤーがフォーカスを取得、または、失ったときに、すべてのゲームオブジェクトに送信されます。
OnApplicationPauseプレイヤーが一時停止したときにすべてのゲームオブジェクトに送信されます
OnApplicationQuitSent to all game objects before the application quits.
OnAudioFilterReadOnAudioFilterRead が実装されている場合、Unity は DSP チェーンにカスタムフィルターを挿入します。
OnBecameInvisibleOnBecameInvisible はレンダラーがカメラから見えなくなったときに呼び出されます
OnBecameVisibleOnBecameVisible はレンダラーが任意のカメラから見えるようになると呼び出されます
OnCollisionEnterこの collider/rigidbody は他の collider/rigidbody に触れたときに OnCollisionEnter は呼び出されます。
OnCollisionEnter2Dオブジェクトのコライダーが別のコライダーに衝突したときに呼び出されます(2D 物理挙動のみ)
OnCollisionExitこの collider/rigidbody が他の collider/rigidbody と触れ合うのをやめたときに OnCollisionExit は呼び出されます。
OnCollisionExit2Dオブジェクトのコライダーと別のオブジェクトコライダーが衝突から離れた瞬間に呼び出されます(2D 物理挙動のみ)
OnCollisionStay:ref::OnCollisionStay is called once per frame for every collider/rigidbody that is touching rigidbody/collider.
OnCollisionStay2Dオブジェクトのコライダーと別のオブジェクトのコライダーが衝突している間、毎フレーム呼び出され続けます(2D 物理挙動のみ)
OnConnectedToServerサーバーとの接続に成功したときにクライアント上で呼び出されます
OnControllerColliderHitOnControllerColliderHit はキャラクターコントローラーが移動中にコライダーに衝突した際に、呼び出されます。
OnDestroyDestroying the attached Behaviour will result in the game or Scene receiving OnDestroy.
OnDisableThis function is called when the behaviour becomes disabled.
OnDisconnectedFromServerサーバーとの接続が失われたか切断されたときにクライアント上で呼び出されます
OnDrawGizmos選択可能にしたり、常に描画したいギズモを描画するには OnDrawGizmos を使用します
OnDrawGizmosSelectedオブジェクトが選択されている場合は、ギズモを描画するために OnDrawGizmosSelected を実装します。
OnEnableこの関数はオブジェクトが有効/アクティブになったときに呼び出されます
OnFailedToConnect接続試行がなんらかの理由で失敗したときにクライアント上で呼び出されます
OnFailedToConnectToMasterServerMasterServer への接続に問題がある場合に、クライアントまたはサーバーで呼び出されます
OnGUIOnGUI はレンダリングと GUI イベントのハンドリングのために呼び出されます
OnJointBreakゲームオブジェクトに対するジョイントが外れたとき呼び出されます
OnJointBreak2Dゲームオブジェクトにアタッチした Joint2D が壊れたときに呼び出されます。
OnMasterServerEventMasterServer からイベントを報告してくるときにクライアントやサーバー上で呼び出されます。
OnMouseDown OnMouseDown is called when the user has pressed the mouse button while over the GUIElement or Collider.
OnMouseDragOnMouseDrag はユーザーが GUIElement または Collider をマウスでクリックし、ドラッグしている間呼び出されます。
OnMouseEnterOnMouseEnter は GUIElement または Collider 上にマウスが乗ったときに呼び出されます
OnMouseExitOnMouseExit は GUIElement または Collider 上からマウス離れたときに呼び出されます
OnMouseOverOnMouseOver は GUIElement または Collider 上にマウスがあり続ける限り毎フレーム呼び出され続けます
OnMouseUpOnMouseUp はユーザーがマウスボタンを離したときに呼び出されます
OnMouseUpAsButtonOnMouseUpAsButton はマウスを押した時と同じ GUIElement や Collider 上でマウスを離した時のみに呼び出されます。
OnNetworkInstantiateNetwork.Instantiate でインスタンス化されたオブジェクトに対して呼び出されます
OnParticleCollisionパーティクルがコライダーにヒットしたときに OnParticleCollision が呼び出されます
OnParticleSystemStoppedOnParticleSystemStopped is called when all particles in the system have died, and no new particles will be born. New particles cease to be created either after Stop is called, or when the duration property of a non-looping system has been exceeded.
OnParticleTriggerOnParticleTrigger は、パーティクルシステムのパーティクルが Triggers モジュールの条件を満たすときに呼び出されます。
OnPlayerConnected新しいプレイヤーが接続に成功したときにサーバー上で呼び出されます
OnPlayerDisconnectedプレイヤーがサーバーから接続が切断されるたびにサーバー上で呼び出されます
OnPostRenderOnPostRender is called after a camera finished rendering the Scene.
OnPreCullOnPreCull is called before a camera culls the Scene.
OnPreRenderOnPreRender is called before a camera starts rendering the Scene.
OnRenderImageOnRenderImage はすべてのレンダリングが RenderImage へと完了したときに呼び出されます。
OnRenderObjectOnRenderObject is called after camera has rendered the Scene.
OnSerializeNetworkViewネットワークビューによって監視されるスクリプトの変数の同期をカスタマイズするために使用します
OnServerInitializedNetwork.InitializeServer が実行され完了したときにサーバー上で呼び出されます
OnTransformChildrenChangedこの関数は GameObject の Transform のすべての子の中で変更があったときに呼び出されます
OnTransformParentChangedこの関数は GameObject の Transform の parent プロパティーに変更があったときに呼び出されます
OnTriggerEnter OnTriggerEnter is called when the GameObject collides with another GameObject.
OnTriggerEnter2Dオブジェクトにアタッチしたトリガーの中に別のオブジェクトが入ったときに呼び出されます。(2D 物理挙動のみ)
OnTriggerExit Collider が other のトリガーに触れるのをやめたときに OnTriggerExit は呼び出されます。
OnTriggerExit2Dトリガー状態のオブジェクトのコライダーと別のオブジェクトのコライダーが衝突から離れた瞬間に、呼び出されます。(2D 物理挙動のみ)
OnTriggerStayOnTriggerStay is called once per physics update 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.
Resetデフォルト値にリセットします
StartStart is called on the frame when a script is enabled just before any of the Update methods are called the first time.
UpdateUpdate は MonoBehaviour が有効の場合に、毎フレーム呼び出されます
Copyright © 2023 Unity Technologies
优美缔软件(上海)有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961