NetworkBehaviour

class in UnityEngine.Networking

/

継承:MonoBehaviour

マニュアルに切り替える

説明

スクリプトにネットワーク機能を含めるために継承する必要のある基本クラス

このクラスは MonoBehaviour クラスです。ネットワーク機能をスクリプトで使うには MonoBehaviour を継承する代わりにこのクラスを継承します。そうすることにより、コールバックを受け取ったり、サーバーからクライアントに対し自動的に状態を同期するなど、ネットワークを使った作業を行うことができます。

NetworkBehaviour コンポーネントには、ゲームオブジェクトの NetworkIdentity が必要です。1 つのゲームオブジェクトに複数の NetworkBehaviours を使用することも可能です。階層でサブコンポーネントをもつオブジェクトの場合は、NetworkIdentity と NetworkBehaviour スクリプトはルートオブジェクトに設定されなければなりません。

ネットワークシステムのビルトインコンポーネントのいくつかは、NetworkBehaviour から派生しており、NetworkTransport、NetworkAnimator、NetworkProximityChecker などが含まれます。

変数

connectionToClient NetworkConnection は NetworkIdentity に関連付けられます。これは、サーバー上のプレイヤーオブジェクトのみで有効です。
connectionToServer NetworkConnection は NetworkIdentity に関連付けられます。これは、サーバー上のプレイヤーオブジェクトのみで有効です。
hasAuthorityオブジェクトが、分散ネットワークアプリケーションのオブジェクトの正式バージョンである場合は true を返します。
isClientクライアントで実行され、オブジェクトがサーバーによって生成されている場合は true を返します。
isLocalPlayerオブジェクトがローカルマシンのプレイヤーである場合は true を返します。
isServerアクティブなサーバー上でオブジェクトがアクティブな場合は true を返します。
localPlayerAuthorityこの値は実際は NetworkIdentity に設定され、スクリプトでアクセスするうえで便利変数になります。
netIdオブジェクトのユニークなネットワーク ID
playerControllerIdNetworkBehaviour に関連したプレイヤー ID

Public 関数

ClearAllDirtyBitsSetDirtyBits() によってこのスクリプト上で設定されたすべての dirty bit をすべてクリアします。
GetNetworkChannelこの virtual 関数は、スクリプトの SyncVar を更新するために QoS チャンネルを指定して使用します。
GetNetworkSendIntervalこの virtual 関数は、スクリプトの SyncVar を更新するために一定の間隔で送信するために使用します。
InvokeCommandコマンドを手動で実行します。
InvokeRPCRPC 関数を手動で実行します。
InvokeSyncEventSyncEvent を手動で実行します。
OnCheckObserverオブザーバー(プレイヤー)がこのオブジェクトを見ることができるかどうかを可視化システムが判断するために使用されるコールバックです。
OnDeserializeカスタムのシリアライズデータを受け取るために virtual 関数をオーバーライドします。シリアライズデータを送るための関連関数は OnSerialize()
OnNetworkDestroyサーバーでこのオブジェクトが破棄されたときに、クライアント上で実行されます。
OnRebuildObserversコールバックは、オブジェクトが見えたらオブザーバーを可視化システムによって(再)初期化するために使用します。
OnSerializeカスタムのシリアライズデータを送ることをオーバーライドするための virtual 関数。シリアライズデータを送るための関連関数は OnDeserialize()
OnSetLocalVisibilityホストであるオブジェクトの可視化システムで使用されるコールバック
OnStartAuthorityこれは、コンテキストと NetworkIdentity の NetworkIdentity.localPlayerAuthority 値を元にして、権限のある NetworkBehaviour を実行します。
OnStartClientクライアントがアクティブになるときに、すべての NetworkBehaviour で呼び出されます。
OnStartLocalPlayerローカルプレイヤーのオブジェクトがセットアップされたときに呼び出されます。
OnStartServerこれは NetworkBehaviour オブジェクトがサーバー上でアクティブになるときに呼び出されます。
OnStopAuthorityこれは権限が削除されたとき Behaviour 上で呼び出されます。
PreStartClientGameObject の参照を解決するためにクライアントのオブジェクト上で呼び出される内部メソッド
SetDirtyBitNetworkBehaviour の状態が古く、ネットワーク更新をオブジェクトに送信するときに使用します。

デリゲート

CmdDelegateコマンド機能のデリゲート
EventDelegateイベント機能のデリゲート

継承メンバー

変数

enabled有効であれば更新され、無効であれば更新されません。
isActiveAndEnabledBehaviour が有効かどうか
gameObjectThe game object this component is attached to. A component is always attached to a game object.
tagThe tag of this game object.
transformThe Transform attached to this GameObject (null if there is none attached).
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 関数

BroadcastMessageCalls the method named methodName on every MonoBehaviour in this game object or any of its children.
CompareTagIs this game object tagged with tag ?
GetComponentゲームオブジェクトに type がアタッチされている場合は type のタイプを使用してコンポーネントを返します。ない場合は null です
GetComponentInChildren GameObject や深さ優先探索を活用して、親子関係にある子オブジェクトから type のタイプのコンポーネントを取得します。
GetComponentInParentReturns the component of Type type in the GameObject or any of its parents.
GetComponentsReturns all components of Type type in the GameObject.
GetComponentsInChildrenReturns all components of Type type in the GameObject or any of its children.
GetComponentsInParentReturns all components of Type type in the GameObject or any of its parents.
SendMessageCalls the method named methodName on every MonoBehaviour in this game object.
SendMessageUpwardsCalls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.
CancelInvokeすべての Invoke をキャンセルします
Invoke設定した時間(単位は秒)にメソッドを呼び出します
InvokeRepeating設定した時間(単位は秒)にメソッドを呼び出し、repeatRate 秒ごとにリピートします
IsInvokingメソッドの呼出が保留中かどうか
StartCoroutineコルーチンを開始します
StopAllCoroutinesStops all coroutines running on this behaviour.
StopCoroutineStops the first coroutine named methodName, or the coroutine stored in routine running on this behaviour.
GetInstanceIDReturns the instance id of the object.
ToStringReturns the name of the game object.

Static 関数

printLogs message to the Unity Console (identical to Debug.Log).
Destroyゲームオブジェクトやコンポーネント、アセットを削除します
DestroyImmediateDestroys the object obj immediately.
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.
InstantiateReturns a copy of the object original.

Operator

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.

メッセージ

AwakeAwake is called when the script instance is being loaded.
FixedUpdateThis function is called every fixed framerate frame, if the MonoBehaviour is enabled.
LateUpdateLateUpdate is called every frame, if the Behaviour is enabled.
OnAnimatorIKCallback for setting up animation IK (inverse kinematics).
OnAnimatorMoveCallback for processing animation movements for modifying root motion.
OnApplicationFocusSent to all GameObjects when the player gets or loses focus.
OnApplicationPauseSent to all GameObjects when the application pauses.
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 is called when this collider/rigidbody has begun touching another rigidbody/collider.
OnCollisionEnter2DSent when an incoming collider makes contact with this object's collider (2D physics only).
OnCollisionExitOnCollisionExit is called when this collider/rigidbody has stopped touching another rigidbody/collider.
OnCollisionExit2DSent when a collider on another object stops touching this object's collider (2D physics only).
OnCollisionStayOnCollisionStay is called once per frame for every collider/rigidbody that is touching rigidbody/collider.
OnCollisionStay2DSent each frame where a collider on another object is touching this object's collider (2D physics only).
OnConnectedToServerCalled on the client when you have successfully connected to a server.
OnControllerColliderHitOnControllerColliderHit is called when the controller hits a collider while performing a 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.
OnJointBreakCalled when a joint attached to the same game object broke.
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.
OnParticleCollisionOnParticleCollision is called when a particle hits a Collider.
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 is called before a camera culls the scene.
OnPreRenderOnPreRender is called before a camera starts rendering the scene.
OnRenderImageOnRenderImage is called after all rendering is complete to render image.
OnRenderObjectOnRenderObject is called after camera has rendered the scene.
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 is called when the Collider other enters the trigger.
OnTriggerEnter2DSent when another object enters a trigger collider attached to this object (2D physics only).
OnTriggerExitOnTriggerExit is called when the Collider other has stopped touching the trigger.
OnTriggerExit2DSent when another object leaves a trigger collider attached to this object (2D physics only).
OnTriggerStayOnTriggerStay is called once per frame for every Collider other that is touching the trigger.
OnTriggerStay2DSent each frame where another object is within a trigger collider attached to this object (2D physics only).
OnValidateThis function is called when the script is loaded or a value is changed in the inspector (Called in the editor only).
OnWillRenderObjectOnWillRenderObject is called for each camera if the object is visible.
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 is called every frame, if the MonoBehaviour is enabled.