Version: 2017.1

NetworkManager

class in UnityEngine.Networking

/

継承:MonoBehaviour

マニュアルに切り替える

説明

NetworkManager は、ネットワークを管理する HLAPI 向けの便利なクラスです。

シンプルなネットワークアプリケーションに関して、NetworkManager は、HLAPI を制御するために利用できます。これはシーンを管理するためにクライアントやサーバーを開始や停止をするための簡単な方法を提供します。さらに、ユーザーコードはネットワークイベント用にハンドラを実装するために使用することができる仮想関数を持っています。NetworkManager は、同時に1人のクライアントを処理します。下記の例では、最小限のネットワーク設定を示しています。

using UnityEngine;
using UnityEngine.Networking;

public class Manager : NetworkManager { public override void OnServerConnect(NetworkConnection conn) { Debug.Log("OnPlayerConnected"); } }

Static 変数

networkSceneName現在のネットワークシーン名
singletonNetworkManager のシングルトンオブジェクト

変数

autoCreatePlayer接続時や、シーンの変更時に自動でプレイヤーオブジェクトを作成するかどうかを制御するフラグ
channelsネットワークトランスポート層で使用する Quality-of-Service(QoS)チャンネル
clientNetworkManager で使用されている現在の NetworkClient
clientLoadedSceneクライアントがサーバーに接続するときに新しいシーンを読み込んだ場合は、true を返します。
connectionConfig使用するカスタムネットワーク設定
customConfigカスタムネットワーク設定を有効にするフラグ
dontDestroyOnLoadシーンが変更するときに NetworkManager オブジェクトが破棄されるかどうかを制御するフラグ
globalConfig使用するトランスポート層のグローバル設定
isNetworkActiveNetworkServer や NetworkClient がアクティブである場合、true です。
logLevelネットワークに関するログをユーザーに表示するためのログレベル
matches参加できるマッチのリスト
matchHostマッチメイキングサーバーのホスト名
matchInfoStartServer() や StartClient() が呼び出されたときに使用する MachInfo のインスタンス
matchMakerUMatch のマッチメーカーオブジェクト
matchName現在のマッチの名前
matchPortマッチメイキングサーバーのポート
matchSize現在のマッチで可能な最大接続数
maxConnectionsサポートする同時ネットワーク接続の最大数
maxDelay接続のパケットを送信する前にかける最大ディレイ
migrationManagerNetworkManager で使用されるマイグレーションマネージャー
networkAddress現在使用しているネットワークアドレス
networkPort現在使用しているネットワークのポート
numPlayersサーバー上にあるすべてのコネクション間でアクティブなプレイヤーオブジェクトの数
offlineSceneオフライン時に切り替えるシーン
onlineSceneオンライン時に切り替えるシーン
packetLossPercentageクライアントでパケットの入出力でドロップするパケットの割合
playerPrefabサーバー上でプレイヤーオブジェクトを作成するときに使用されるデフォルトのプレハブ
playerSpawnMethodNetworkManager で使用される、プレイヤーを生成する方法
runInBackground(アプリを最小化などして)バックグラウンドでアプリを起動し続けているときに、プログラムが実行するかどうか
scriptCRCCheckサーバーとクライアント間でスクリプトの CRC チェックを行うためのフラグ
secureTunnelEndpointnetworkAddress と networkPort 設定の代わりに EndPoint オブジェクトを指定することができます(Xbox One のようなプラットフォームで必要です)。
serverBindAddressサーバーにバインドされる IP アドレス
serverBindToIP特定の IP アドレスにバインドされているかどうかをサーバーに伝えるためのフラグ
simulatedLatencyクライアントのパケットの入力/出力するときのディレイ(ミリ秒)
spawnPrefabsオブジェクト生成システムに登録されているプレハブのリスト
startPositions現在のシーンで、プレイヤーの開始位置として登録されているリスト
useSimulatorこの NetworkManager で起動したクライアントを、レイテンシとパケットロスをシミュレートするかどうかのフラグ
useWebSocketsこれにより、NetworkServer は通常のトランスポート層接続の代わりに、WebSockets 接続に備えて待機します。

Public 関数

GetStartPositionこれは、シーン内の NetworkStartPosition オブジェクトに基づいて生成位置を求めます。
IsClientConnectedNetworkManager がクライアントを持ち、サーバーと接続しているかチェックします。
OnClientConnectサーバーに接続したときクライアント上で呼び出されます。
OnClientDisconnectサーバーが切断されたときにクライアント上で呼び出されます。
OnClientErrorネットワークエラーが発生したときにクライアント上で呼び出されます。
OnClientNotReadyサーバーがまだ準備完了していないということを伝えるためにクライアント上で呼び出されます。
OnClientSceneChangedサーバーによってシーンの読み込みが初期化され、シーンの読み込みが完了したときにクライアント上で呼び出されます。
OnDestroyMatch NetworkMatch.DestroyMatch のリクエストがサーバー上で処理されるときに発生するコールバック
OnDropConnection NetworkMatch.DropConnection のマッチリクエストがサーバー上で処理されるときに発生するコールバック
OnMatchCreate NetworkMatch.CreateMatch のリクエストがサーバー上で処理されるときに発生するコールバック
OnMatchJoined NetworkMatch.JoinMatch のリクエストがサーバー上で処理されるときに発生するコールバック
OnMatchList NetworkMatch.ListMatches のリクエストがサーバー上で処理されるときに発生するコールバック
OnServerAddPlayerClientScene.AddPlayer によってクライアントで新しいプレイヤーが追加されたときにサーバー上で呼び出されます。
OnServerConnect新しいクライアントが接続に成功したときサーバー上で呼び出されます。
OnServerDisconnectクライアントの接続が失われたか切断されたときにサーバー上で呼び出されます。
OnServerErrorクライアント接続のネットワークエラーが発生したときサーバー上で呼び出されます。
OnServerReadyクラインアントの準備が整ったときサーバー上で呼び出されます。
OnServerRemovePlayerクライアントがプレイヤーを削除するときサーバー上で呼び出されます。
OnServerSceneChangedServerChangeScene() のサーバーで読み込みが開始された場合、シーンが完全に読み込まれたときサーバー上で呼び出されます。
OnSetMatchAttributes[[NetworkMatch.SetMatchAttributes] のリクエストがサーバー上で処理されるときに発生するコールバック
OnStartClientクライアントが起動したときに呼び出されるコールバックです。
OnStartHostこのコールバックは、ホストが起動されたときに実行されます。
OnStartServerホストが起動したのを含む、サーバーが起動したときに呼び出されるコールバックです。
OnStopClientクライアントが停止したときに呼び出されるコールバックです。
OnStopHostホストが停止したときに呼び出されるコールバックです。
OnStopServerホストが停止したのを含む、サーバーが停止したときに呼び出されるコールバックです。
ServerChangeScenenetworkSceneName を設定していれば、サーバー上でシーンの切り替えが行われます。
SetMatchHostマッチメーカーのアドレスを設定します。
SetupMigrationManagerこの NetworkManager と連携する NetworkMigrationManager オブジェクトを設定します。
StartClientこれは、ネットワーククライアントを起動します。すなわち、接続するためのアドレスとして networkAddress や networkPort のプロパティーを使用します。
StartHostネットワークに接続された「ホスト」(同じアプリケーションのクライアント/サーバー)を起動します。
StartMatchMakerNetworkManager のマッチメーカーを起動します。
StartServer新しいサーバーを起動します。
StopClientManager を使用しているクライアントを停止します。
StopHostこれは、Manager を使用しているクライアントとサーバー両方を停止します。
StopMatchMakerNetworkManager が使用しているマッチメーカーを停止します。
StopServerManager を使用しているサーバーを停止します。
UseExternalClientStartClient() を利用する代わりに NetworkManager で外部用に作成されたクライアントオブジェクトを使用できるようになります。

Static 関数

RegisterStartPositionプレイヤー生成位置としてゲームオブジェクトの Transform(遷移)を登録します。
ShutdownNetworkManager を完全にシャットダウンして、シングルトンを破壊します。
UnRegisterStartPositionプレイヤー生成位置としてゲームオブジェクトの Transform(遷移)を登録解除します。

継承メンバー

変数

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 のレイアウトフェーズをスキップすることができます
hideFlagsオブジェクトは非表示、シーンに保存、ユーザーが編集可能、などを設定する。
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 を返します
ToStringゲームオブジェクトの名前を返します

Static 関数

printUnity コンソールにログを出力します (Debug.Log と同じです)
Destroyゲームオブジェクトやコンポーネント、アセットを削除します
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoad新しいシーンを読み込んでもオブジェクトが自動で破壊されないように設定します
FindObjectOfTypeタイプ type から最初に見つけたアクティブのオブジェクトを返します
FindObjectsOfTypeタイプから見つけたすべてのアクティブのオブジェクト配列を返します
Instantiateoriginal のオブジェクトをクローンします

Operator

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

メッセージ

Awakeスクリプトのインスタンスがロードされたときに呼び出されます
FixedUpdateMonoBehaviour が有効の場合、この関数は毎回、固定フレームレートで呼び出されます。
LateUpdate Behaviour が有効の場合、LateUpdate は毎フレーム呼びだされます
OnAnimatorIKアニメーション IK (インバースキネマティクス)をセットアップするときのコールバック
OnAnimatorMoveルートモーションを修正するアニメーション動作を処理するコールバック
OnApplicationFocusプレイヤーがフォーカスを取得、または、失ったときに、すべてのゲームオブジェクトに送信されます。
OnApplicationPauseプレイヤーが一時停止したときにすべてのゲームオブジェクトに送信されます
OnApplicationQuitアプリケーションが終了する前にすべてのゲームオブジェクトで呼び出されます
OnAudioFilterReadOnAudioFilterRead が実装されている場合、Unity は DSP チェーンにカスタムフィルターを挿入します。
OnBecameInvisibleOnBecameInvisible はレンダラーがカメラから見えなくなったときに呼び出されます
OnBecameVisibleOnBecameVisible はレンダラーが任意のカメラから見えるようになると呼び出されます
OnCollisionEnterこの collider/rigidbody は他の collider/rigidbody に触れたときに OnCollisionEnter は呼び出されます。
OnCollisionEnter2Dオブジェクトのコライダーが別のコライダーに衝突したときに呼び出されます(2D 物理挙動のみ)
OnCollisionExitこの collider/rigidbody が他の collider/rigidbody と触れ合うのをやめたときに OnCollisionExit は呼び出されます。
OnCollisionExit2Dオブジェクトのコライダーと別のオブジェクトコライダーが衝突から離れた瞬間に呼び出されます(2D 物理挙動のみ)
OnCollisionStayOnCollisionStay は rigidbody/collider が他の rigidbody/collider に触れている間毎フレーム 1 度だけ呼び出されます。
OnCollisionStay2Dオブジェクトのコライダーと別のオブジェクトのコライダーが衝突している間、毎フレーム呼び出され続けます(2D 物理挙動のみ)
OnConnectedToServerサーバーとの接続に成功したときにクライアント上で呼び出されます
OnControllerColliderHitOnControllerColliderHit はキャラクターコントローラーが移動中にコライダーに衝突した際に、呼び出されます。
OnDestroyこの関数は MonoBehaviour が破棄されるときに呼び出されます
OnDisableこの関数は Behaviour が無効/非アクティブになったときに呼び出されます
OnDisconnectedFromServerサーバーとの接続が失われたか切断されたときにクライアント上で呼び出されます
OnDrawGizmos選択可能にしたり、常に描画したいギズモを描画するには OnDrawGizmos を使用します
OnDrawGizmosSelectedオブジェクトが選択されている場合は、ギズモを描画するために OnDrawGizmosSelected を実装します。
OnEnableこの関数はオブジェクトが有効/アクティブになったときに呼び出されます
OnFailedToConnect接続試行がなんらかの理由で失敗したときにクライアント上で呼び出されます
OnFailedToConnectToMasterServerMasterServer への接続に問題がある場合に、クライアントまたはサーバーで呼び出されます
OnGUIOnGUI はレンダリングと GUI イベントのハンドリングのために呼び出されます
OnJointBreakゲームオブジェクトに対するジョイントが外れたとき呼び出されます
OnJointBreak2Dゲームオブジェクトにアタッチした Joint2D が壊れたときに呼び出されます。
OnMasterServerEventMasterServer からイベントを報告してくるときにクライアントやサーバー上で呼び出されます。
OnMouseDownOnMouseDown は GUIElement または Collider 上でユーザーがマウスボタンをクリックしたときに呼び出されます
OnMouseDragOnMouseDrag はユーザーが GUIElement または Collider をマウスでクリックし、ドラッグしている間呼び出されます。
OnMouseEnterOnMouseEnter は GUIElement または Collider 上にマウスが乗ったときに呼び出されます
OnMouseExitOnMouseExit は GUIElement または Collider 上からマウス離れたときに呼び出されます
OnMouseOverOnMouseOver は GUIElement または Collider 上にマウスがあり続ける限り毎フレーム呼び出され続けます
OnMouseUpOnMouseUp はユーザーがマウスボタンを離したときに呼び出されます
OnMouseUpAsButtonOnMouseUpAsButton はマウスを押した時と同じ GUIElement や Collider 上でマウスを離した時のみに呼び出されます。
OnNetworkInstantiateNetwork.Instantiate でインスタンス化されたオブジェクトに対して呼び出されます
OnParticleCollisionパーティクルがコライダーにヒットしたときに OnParticleCollision が呼び出されます
OnParticleTriggerOnParticleTrigger は、パーティクルシステムのパーティクルが Triggers モジュールの条件を満たすときに呼び出されます。
OnPlayerConnected新しいプレイヤーが接続に成功したときにサーバー上で呼び出されます
OnPlayerDisconnectedプレイヤーがサーバーから接続が切断されるたびにサーバー上で呼び出されます
OnPostRenderOnPostRender はカメラがシーンのレンダリングを完了した後に呼び出されます
OnPreCullOnPreCull はカメラがシーンのカリングを行う直前に呼び出されます。
OnPreRenderOnPreRender はカメラがシーンのレンダリングを開始する前に呼び出されます。
OnRenderImageOnRenderImage はすべてのレンダリングが RenderImage へと完了したときに呼び出されます。
OnRenderObjectOnRenderObject はカメラがシーンをレンダリングした後に呼び出されます。
OnSerializeNetworkViewネットワークビューによって監視されるスクリプトの変数の同期をカスタマイズするために使用します
OnServerInitializedNetwork.InitializeServer が実行され完了したときにサーバー上で呼び出されます
OnTransformChildrenChangedこの関数は GameObject の Transform のすべての子の中で変更があったときに呼び出されます
OnTransformParentChangedこの関数は GameObject の Transform の parent プロパティーに変更があったときに呼び出されます
OnTriggerEnter Collider が他のトリガーイベントに侵入したときに OnTriggerEnter が呼び出されます。
OnTriggerEnter2Dオブジェクトにアタッチしたトリガーの中に別のオブジェクトが入ったときに呼び出されます。(2D 物理挙動のみ)
OnTriggerExit Collider が other のトリガーに触れるのをやめたときに OnTriggerExit は呼び出されます。
OnTriggerExit2Dトリガー状態のオブジェクトのコライダーと別のオブジェクトのコライダーが衝突から離れた瞬間に、呼び出されます。(2D 物理挙動のみ)
OnTriggerStayOnTriggerStay は Collider が他のトリガーと当たり続けている毎フレーム呼び出されます
OnTriggerStay2Dトリガー状態のオブジェクトのコライダーと別のオブジェクトのコライダー衝突している間、毎フレーム呼び出され続けます。(2D 物理挙動のみ)
OnValidateこの関数はスクリプトがロードされた時やインスペクターの値が変更されたときに呼び出されます(この呼出はエディター上のみ)
OnWillRenderObjectOnWillRenderObject はカメラからオブジェクトが可視状態の場合、各カメラごとに一回呼び出されます。
Resetデフォルト値にリセットします
StartStart はスクリプトが有効で、Update メソッドが最初に呼び出される前のフレームで呼び出されます
UpdateUpdate は MonoBehaviour が有効の場合に、毎フレーム呼び出されます