ObservedComponentListを利用した、オブジェクト同期データのカスタマイズ

目次

概要▲

オブジェクト同期処理時に、自由に送受信したいデータを追加する

事前設定▲

送受信処理を組み込むためのスクリプトには、MonobitEngine.MonoBehavior の継承が必要です

MonobitView コンポーネントの Observed Component Registration List 項目に
上記で定めたスクリプトを登録しておく必要があります。

オブジェクト同期データの仕組み▲

オブジェクト同期データとして取り扱うことのできるデータの種類

・bool（Boolean）
・byte（Byte）
・char（SByte）
・short（Int16）
・unsingned short（UInt16）
・int（Int32）
・unsigned int（UInt32）
・long（Int64）
・unsigned long（UInt64）
・float（Single）
・double（Double）
・string（String）
・Vector2, Vector3, Vector4
・Quaternion
・MonobitEngine.MonobitPlayer
・上述のデータ型に基づく、任意の長さを持つ配列情報
・上述のデータ型に基づく Hashtable
・上述のデータ型に基づく Dictionary
・上述のデータ型で構成された object（Object）

オブジェクト同期情報は MonobitEngine.MonobitStream クラスで取り扱う

1. オブジェクト固有の任意の情報をシリアライズして、byte[] 型のデータに変換する
2. シリアライズされた byte[] 型のデータを、オブジェクト固有の任意の情報にデシリアライズする

OnMonobitSerializeViewWrite メソッド▲

機能

引数

型	変数名	内容
MonobitEngine.MonobitStream	stream	オブジェクト同期データと同時に送信される、独自情報のパラメータ。 詳しくは MonobitEngine.MonobitStream.Enqueue メソッド をご覧ください。
MonobitEngine.MonobitMessageInfo	info	送信元である自身のプレイヤー情報、および送信元のオブジェクトのMonobitEngine.MonobitViewコンポーネントを提供します。 MonobitEngine.MonobitMessageInfo は以下のパラメータから成り立ちます。 型 変数名 内容 MonobitPlayer sender 送信元である自身のプレイヤー情報を示します。 MonobitEngine.MonobitPlayer は以下のパラメータから成り立ちます。 型 変数名 内容 int ID ルーム内にてユニークで定義される、プレイヤーの識別ID。 string Name プレイヤー名。 bool isHost このプレイヤーがルームホストであるかどうかの識別フラグ。 Hashtable customParameters プレイヤーに設定された任意のカスタムパラメータ。 Hashtable allParameters 上記４つのデータを統合した、プレイヤーに関する全情報。 MonobitView monobitView 送信元/受信先となるオブジェクトのmonobitViewコンポーネント情報を示します。 MonobitEngine.MonobitView は以下のパラメータから成り立ちます。 型 変数名 内容 bool isDontDestroyOnRoom 所有者がルームから退室しても、オブジェクトを削除せずに残すかどうかのフラグ。 bool isInstantiated MonobitNetwork.Instantiate() メソッドを実行して生成したオブジェクトかどうかのフラグ。 bool isChangedSerializeView 受信した情報が、前回このメソッドが呼び出された状態から変化したかどうかのフラグ。 object[] instantiationData sender側から MonobitNetwork.Instantiate() メソッドを実行したとき、 その結果サーバを介して受信した任意のパラメータ情報。 int viewID MonobitView コンポーネントの識別ID。 bool isSceneView あらかじめシーンに設置された、静的なオブジェクトであるかどうかのフラグ。 bool isOwner 自身がオブジェクトの生成者であるかどうかのフラグ。 bool isMine 自身がオブジェクトの所有者であるかどうかのフラグ。 bool Encrypt このメソッドで送受信を行なうデータについて、暗号化を適用するかどうかのフラグ。

戻り値

型	内容
void	-

記述例

// 以下の変数を、オブジェクト同期とともに共有される独自情報とします。
int  intValue = 100;
string strValue = "MonobitEngine";
float[] floatArray = new float[] { 1.0f, 2.5f };
UnityEngine.Vector3 vec3Value = new UnityEngine.Vector3.zero;
 
// オブジェクトの同期データについて独自情報を書き込みます。
public void OnMonobitSerializeViewWrite( MonobitEngine.MonobitStream stream, MonobitEngine.MonobitMessageInfo info )
{
    Debug.Log("OnMonobitSerializeViewWrite");
 
    /*
     * 同期データの書き込み
     */
    stream.Enqueue(intValue);
    stream.Enqueue(strValue);
    stream.Enqueue(floatArray);
    stream.Enqueue(vec3Value);
}

OnMonobitSerializeViewRead メソッド▲

機能

引数

型	変数名	内容
MonobitEngine.MonobitStream	stream	オブジェクト同期データと同時に受信される、独自情報のパラメータ。 詳しくは MonobitEngine.MonobitStream.Dequeue メソッド をご覧ください。
MonobitEngine.MonobitMessageInfo	info	誰が送信したデータか、および送信元のオブジェクトのMonobitEngine.MonobitViewコンポーネントを提供します。 MonobitEngine.MonobitMessageInfo は以下のパラメータから成り立ちます。 型 変数名 内容 MonobitPlayer sender 送信元のプレイヤー情報を示します。 MonobitEngine.MonobitPlayer は以下のパラメータから成り立ちます。 型 変数名 内容 int ID ルーム内にてユニークで定義される、プレイヤーの識別ID。 string Name プレイヤー名。 bool isHost このプレイヤーがルームホストであるかどうかの識別フラグ。 Hashtable customParameters プレイヤーに設定された任意のカスタムパラメータ。 Hashtable allParameters 上記４つのデータを統合した、プレイヤーに関する全情報。 MonobitView monobitView 送信元/受信先となるオブジェクトのmonobitViewコンポーネント情報を示します。 MonobitEngine.MonobitView は以下のパラメータから成り立ちます。 型 変数名 内容 bool isDontDestroyOnRoom 所有者がルームから退室しても、オブジェクトを削除せずに残すかどうかのフラグ。 bool isInstantiated MonobitNetwork.Instantiate() メソッドを実行して生成したオブジェクトかどうかのフラグ。 bool isChangedSerializeView 受信した情報が、前回このメソッドが呼び出された状態から変化したかどうかのフラグ。 object[] instantiationData sender側から MonobitNetwork.Instantiate() メソッドを実行したとき、 その結果サーバを介して受信した任意のパラメータ情報。 int viewID MonobitView コンポーネントの識別ID。 bool isSceneView あらかじめシーンに設置された、静的なオブジェクトであるかどうかのフラグ。 bool isOwner 自身がオブジェクトの生成者であるかどうかのフラグ。 bool isMine 自身がオブジェクトの所有者であるかどうかのフラグ。 bool Encrypt このメソッドで送受信を行なうデータについて、暗号化を適用するかどうかのフラグ。

戻り値

型	内容
void	-

記述例

// 以下の変数を、オブジェクト同期とともに共有される独自情報とします。
int  intValue;
string strValue;
float[] floatArray;
UnityEngine.Vector3 vec3Value;
 
// オブジェクトの同期データについて独自情報を読み込みます。
public void OnMonobitSerializeViewRead( MonobitEngine.MonobitStream stream, MonobitEngine.MonobitMessageInfo info )
{
    Debug.Log("OnMonobitSerializeViewRead");
 
    /*
     * 同期データの読み込み
     */
    intValue = (int)stream.Dequeue();
    strValue = (string)stream.Dequeue();
    floatValue = (float[])stream.Dequeue();
    vec3Value = (UnityEngine.Vector3)stream.Dequeue();
}

OnMonobitSerializeView メソッド▲

機能

引数

型	変数名	内容
MonobitEngine.MonobitStream	stream	オブジェクト同期データと同時に送受信される、独自情報のパラメータ。 OnMonobitSerializeView メソッドでは以下の機能を利用して制御する必要があります。 ・ stream.isWriting プロパティ がtrue の場合に送信処理を、falseの場合に受信処理を実行します。 ・ stream.isReading プロパティ がtrue の場合に受信処理を、falseの場合に送信処理を実行します。 　　　※ 上記双方のプロパティは、いずれか一方が true であれば他方が必ず false を示します。 ・ 送信処理の際には stream.Enqueue メソッド をコールし、オブジェクト同期データを送信します。 ・ 受信処理の際には stream.Dequeue メソッド をコールし、オブジェクト同期データを受信します。
MonobitEngine.MonobitMessageInfo	info	誰が送信したデータか、および送信元のオブジェクトのMonobitEngine.MonobitViewコンポーネントを提供します。 MonobitEngine.MonobitMessageInfo は以下のパラメータから成り立ちます。 型 変数名 内容 MonobitPlayer sender このメソッドにおける stream.isReading が true である場合のみ、送信元のプレイヤー情報を示します。 stream.isReading が false の場合、sender は自身のプレイヤー情報を示します。 MonobitEngine.MonobitPlayer は以下のパラメータから成り立ちます。 型 変数名 内容 int ID ルーム内にてユニークで定義される、プレイヤーの識別ID。 string Name プレイヤー名。 bool isHost このプレイヤーがルームホストであるかどうかの識別フラグ。 Hashtable customParameters プレイヤーに設定された任意のカスタムパラメータ。 Hashtable allParameters 上記４つのデータを統合した、プレイヤーに関する全情報。 MonobitView monobitView 送信元/受信先となるオブジェクトのmonobitViewコンポーネント情報を示します。 MonobitEngine.MonobitView は以下のパラメータから成り立ちます。 型 変数名 内容 bool isDontDestroyOnRoom 所有者がルームから退室しても、オブジェクトを削除せずに残すかどうかのフラグ。 bool isInstantiated MonobitNetwork.Instantiate() メソッドを実行して生成したオブジェクトかどうかのフラグ。 bool isChangedSerializeView 受信した情報が、前回このメソッドが呼び出された状態から変化したかどうかのフラグ。 object[] instantiationData sender側から MonobitNetwork.Instantiate() メソッドを実行したとき、 その結果サーバを介して受信した任意のパラメータ情報。 int viewID MonobitView コンポーネントの識別ID。 bool isSceneView あらかじめシーンに設置された、静的なオブジェクトであるかどうかのフラグ。 bool isOwner 自身がオブジェクトの生成者であるかどうかのフラグ。 bool isMine 自身がオブジェクトの所有者であるかどうかのフラグ。 bool Encrypt このメソッドで送受信を行なうデータについて、暗号化を適用するかどうかのフラグ。

戻り値

型	内容
void	-

記述例

// 以下の変数を、オブジェクト同期とともに共有される独自情報とします。
int  intValue = 100;
string strValue = "MonobitEngine";
float[] floatArray = new float[] { 1.0f, 2.5f };
UnityEngine.Vector3 vec3Value = new UnityEngine.Vector3.zero;
 
// オブジェクトの同期データについて独自情報を読み書きします。
public void OnMonobitSerializeView( MonobitEngine.MonobitStream stream, MonobitEngine.MonobitMessageInfo info )
{
    Debug.Log("OnMonobitSerializeView");
 
    if( stream.isWriting )
    {
        /*
         * 同期データの書き込み
         */
        stream.Enqueue(intValue);
        stream.Enqueue(strValue);
        stream.Enqueue(floatArray);
        stream.Enqueue(vec3Value);
    }
    else
    {
        /*
         * 同期データの読み込み
         */
        intValue = (int)stream.Dequeue();
        strValue = (string)stream.Dequeue();
        floatValue = (float[])stream.Dequeue();
        vec3Value = (UnityEngine.Vector3)stream.Dequeue();
     }
}

MonobitEngine.MonobitStream.isWriting プロパティ▲

機能

入出力型

型	内容
bool	現在オブジェクトデータの送信処理を行なっている最中かどうかのフラグです。 このフラグが true の場合には送信処理中、false の場合には受信処理中です。

記述例

// OnMonobitSerializeView のコールバック処理内で実行します。
public void OnMonobitSerializeView( MonobitEngine.MonobitStream stream, MonobitEngine.MonobitMessageInfo info )
{
    // MonobitStream.isWriting のフラグに応じて、処理を分岐させます
    if( stream.isWriting )
    {
        /*
         * ここに同期データの送信処理を記述します。
         */
    }
    else
    {
        /*
         * ここに同期データの受信処理を記述します。
         */
     }
}

MonobitEngine.MonobitStream.isReading プロパティ▲

機能

入出力型

型	内容
bool	現在オブジェクトデータの受信処理を行なっている最中かどうかのフラグです。 このフラグが true の場合には受信処理中、false の場合には送信処理中です。

記述例

// OnMonobitSerializeView のコールバック処理内で実行します。
public void OnMonobitSerializeView( MonobitEngine.MonobitStream stream, MonobitEngine.MonobitMessageInfo info )
{
    // MonobitStream.isReading のフラグに応じて、処理を分岐させます
    if( stream.isReading )
    {
        /*
         * ここに同期データの受信処理を記述します。
         */
    }
    else
    {
        /*
         * ここに同期データの送信処理を記述します。
         */
     }
}

MonobitEngine.MonobitStream.Enqueue メソッド▲

機能

引数

型	変数名	内容
object	obj	オブジェクト同期データとして利用される任意の情報を指定します。 ここで指定できる obj の対象、すなわち送信可能なデータの種類は、以下のデータ型に限定されます。 ・bool（Boolean） ・byte（Byte） ・char（SByte） ・short（Int16） ・unsingned short（UInt16） ・int（Int32） ・unsigned int（UInt32） ・long（Int64） ・unsigned long（UInt64） ・float（Single） ・double（Double） ・string（String） ・Vector2, Vector3, Vector4 ・Quaternion ・MonobitEngine.MonobitPlayer ・上述のデータ型に基づく、任意の長さを持つ配列情報 ・上述のデータ型に基づく Hashtable ・上述のデータ型に基づく Dictionary ・上述のデータ型で構成された object（Object） 　　上記に示したデータ型以外では、同期データとして取り扱えません。ご注意ください。

戻り値

型	内容
void	-

記述例

// 以下の変数を、オブジェクト同期とともに共有される独自情報とします。
int  intValue = 100;
string strValue = "MonobitEngine";
float[] floatArray = new float[] { 1.0f, 2.5f };
UnityEngine.Vector3 vec3Value = new UnityEngine.Vector3.zero;
 
// MonobitEngine.MonobitStream の同期データのシリアライズは下記のコールバックメソッドだけに限定されます。
//    ・ OnMonobitSerializeViewWrite メソッド
//    ・ OnMonobitSerializeView メソッド
// ここでは OnMonobitSerializeViewWrite メソッド を例に挙げます
public void OnMonobitSerializeViewWrite( MonobitEngine.MonobitStream stream, MonobitEngine.MonobitMessageInfo info )
{
    // MonobitEngine.MonobitStream.Enqueue メソッドを用い、
    // オブジェクトの同期データについて独自情報を登録しシリアライズします。
    stream.Enqueue(intValue);
    stream.Enqueue(strValue);
    stream.Enqueue(floatArray);
    stream.Enqueue(vec3Value);
}

MonobitEngine.MonobitStream.Dequeue メソッド▲

機能

引数

型	変数名	内容
-	-	-

戻り値

型

内容

object

オブジェクト同期データとして利用される任意の情報を取得します。 ここで取得できるデータはobject型に限定されるため、取得する場合には以下のデータ型への明示的なcastが必要です。 ・bool（Boolean） ・byte（Byte） ・char（SByte） ・short（Int16） ・unsingned short（UInt16） ・int（Int32） ・unsigned int（UInt32） ・long（Int64） ・unsigned long（UInt64） ・float（Single） ・double（Double） ・string（String） ・Vector2, Vector3, Vector4 ・Quaternion ・MonobitEngine.MonobitPlayer ・上述のデータ型に基づく、任意の長さを持つ配列情報 ・上述のデータ型に基づく Hashtable ・上述のデータ型に基づく Dictionary ・上述のデータ型で構成された object（Object）

記述例

// 以下の変数を、オブジェクト同期とともに共有される独自情報とします。
int  intValue;
string strValue;
float[] floatArray;
UnityEngine.Vector3 vec3Value;
 
// MonobitEngine.MonobitStream の同期データのシリアライズは下記のコールバックメソッドだけに限定されます。
//    ・ OnMonobitSerializeViewRead メソッド
//    ・ OnMonobitSerializeView メソッド
// ここでは OnMonobitSerializeViewRead メソッド を例に挙げます
public void OnMonobitSerializeViewRead( MonobitEngine.MonobitStream stream, MonobitEngine.MonobitMessageInfo info )
{
    Debug.Log("OnMonobitSerializeViewWrite");
 
    // MonobitEngine.MonobitStream.Dequeue メソッドを用い、
    // オブジェクトの同期データについて独自情報をデシリアライズして取得します。
    intValue = (int)stream.Dequeue();
    strValue = (string)stream.Dequeue();
    floatValue = (float[])stream.Dequeue();
    vec3Value = (UnityEngine.Vector3)stream.Dequeue();
}