　さて、今までいろいろとPhotonの同期を取る方法を調べてきました。
　今回は同期を取る方法としてカスタムプロパティを調査しました。
　カスタムプロパティはハッシュテーブル方式でルームとプレイヤーに設定することが出来ます。

　今回のカスタムプロパティがPhotonで同期を取ってみようシリーズの最終回になります。

この記事にはUnity5.4.1f1及びPUN1.75を使用しています。

カスタムプロパティ
ルームのカスタムプロパティ
プレイヤーのカスタムプロパティ
おまけハッシュテーブルのキー

カスタムプロパティ

　Photonで同期する方法はいろいろありました。

doc.photonengine.com

　カスタムプロパティはハッシュテーブルとしてルームとプレイヤーに設定できます。
https://photonengine.jp/pun-api/class_room.html
https://photonengine.jp/pun-api/class_photon_player.html

　カスタムプロパティの一番の魅力は、ルームとプレイヤーという既に用意されたクラスにデータを設定できるという点です。
　設定方法も簡単で、SetCustomProperties()という関数に設定したいハッシュテーブルを渡してあげるだけ。
　変更の受信も簡単です。
　OnJoinedRoom()などのPhotonイベント取得用関数と同じ方式で受信できるため、関数名と引数の型があっていれば、どんなコンポーネントでも取得できます。
　Photonの公式ブログでも使い方が紹介されていました。

blog.photoncloud.jp

　ではルームとプレイヤーに分けて、カスタムプロパティを設定してみましょう。

ルームのカスタムプロパティ

　現在プレイヤーがいるルーム情報はPhotonNetwork.roomのプロパティで取得できます。
　あとはSetCustomProperties()関数に設定した情報を追加したハッシュテーブルを渡してあげればOKです。
https://photonengine.jp/pun-api/class_room.html#ae4096578de6d9a7f93e0748ca7821582

　受信する際の関数はOnPhotonCustomRoomPropertiesChanged()です。

void OnPhotonCustomRoomPropertiesChanged( Hashtable propertiesThatChanged )
　https://photonengine.jp/pun-api/class_photon_1_1_pun_behaviour.html#abf25d63a39ef13cb9a0519e6e7672a2f
　引数のpropertiesThatChangedに設定された情報がハッシュテーブルとして入っています。

　以下がルームのカスタムプロパティの設定のサンプルスクリプトです。
　文字列とプレイヤーのIDを設定しています。

using UnityEngine;
using UnityEngine.UI;

public class DemoObject : MonoBehaviour
{
    [SerializeField]
    private Text    m_strategy  = null;

    private Color[] PLAYER_COLOR    = new Color[] { Color.white, Color.red, Color.green, Color.blue, Color.yellow };

    public void SetRoomStrategy( string i_strategy )
    {
        var properties  = new ExitGames.Client.Photon.Hashtable();
        properties.Add( "Strategy", i_strategy );
        properties.Add( "Sender", PhotonNetwork.player.ID );

        PhotonNetwork.room.SetCustomProperties( properties );
    }

    public void OnPhotonCustomRoomPropertiesChanged( ExitGames.Client.Photon.Hashtable i_propertiesThatChanged )
    {
        {
            object value = null;
            if( i_propertiesThatChanged.TryGetValue( "Strategy", out value ) )
            {
                m_strategy.text     = (string)value;
            }

        }

        {
            object value = null;
            if( i_propertiesThatChanged.TryGetValue( "Sender", out value ) )
            {
                m_strategy.color    = PLAYER_COLOR[ (int)value ];
            }

        }
    }
} // class DemoObject

f:id:urahimono:20160924010250g:plain

プレイヤーのカスタムプロパティ

　自分自身のプレイヤー情報は、PhotonNetwork.playerプロパティから取得できます。
　ルーム同様、SetCustomProperties()関数があるので同じように使えます。
https://photonengine.jp/pun-api/class_photon_player.html#ae318c67498d5eba456be210508784a0e

　受信する際の関数はOnPhotonPlayerPropertiesChanged()です。

void OnPhotonPlayerPropertiesChanged( object[] playerAndUpdatedProps )
　https://photonengine.jp/pun-api/class_photon_1_1_pun_behaviour.html#aaec2f5973228b99c6ad781d5cedadb6f
　引数がobjectの配列で来ているため、パッと見で使い方が分かりにくそうですが、配列に入っている情報は必ず以下の作りになっています。

[0] には影響を受けたPhotonPlayerの情報が入っています。
[1] は変更されたプロパティのハッシュテーブルが入っています。

　そのため必ずキャストして使う必要があります。

　以下がプレイヤーのカスタムプロパティの設定のサンプルスクリプトです。
　プレイヤーのカラーのインデックスを設定しています。

using UnityEngine;
using System.Linq;

public class DemoObject : MonoBehaviour
{
    private Color[] PLAYER_COLOR    = new Color[] { Color.white, Color.red, Color.green, Color.blue, Color.yellow };

    public void SetPlayerColor( int i_colorIndex )
    {
        var properties  = new ExitGames.Client.Photon.Hashtable();
        properties.Add( "Color", i_colorIndex );

        PhotonNetwork.player.SetCustomProperties( properties );
    }

    public void OnPhotonPlayerPropertiesChanged( object[] i_playerAndUpdatedProps )
    {
        var player      = i_playerAndUpdatedProps[ 0 ] as PhotonPlayer;
        var properties  = i_playerAndUpdatedProps[ 1 ] as ExitGames.Client.Photon.Hashtable;


        object colorValue   = null;
        if( properties.TryGetValue( "Color", out colorValue ) )
        {
            int colorIndex  = (int)colorValue;

            // ゲーム上のPlayer用のオブジェクトの中からPhotonViewのIDが変更したPlayerと同じオブジェクトの色を変更する。
            var playerObjects   = GameObject.FindGameObjectsWithTag( "Player" );
            var playerObject    = playerObjects.FirstOrDefault( obj => obj.GetComponent<PhotonView>().ownerId == player.ID );
            playerObject.GetComponent<Renderer>().material.color = PLAYER_COLOR[ colorIndex ];
            return;
        }
    }
} // class DemoObject