【Unity】NCMBで作ったランキングをPlayFabに変更する

unity1weekのランキング機能だけでなく、スマホアプリでもお世話になっていたニフクラのNCMBがサ終となるため、同じような機能を実装できるPlayFabに乗り換えることにしました。面倒くさい…。

2024年4月2日追記・WebGLで全ユーザーでIDが同じになってしまう件について

以下の記事を参照してください。
記事中のコードは修正しました。

【Unity】PlayFab ログイン機能の実装 - アプリ個人開発　まるブログ

1.PlayFabでオンラインランキングを実装

Playfabのチュートリアル！導入とシンプルなログイン【Unity】 | あのゲームの作り方Web版

まず上記の記事を参考に「スタジオ・タイトルとの連携」まで行い、以下のコードを空オブジェクト等にアタッチします。
インポートする必要があるunitypackageは「PlayFabEditorExtensions.unitypackage」「UnitySDK.unitypackage」「UnityPlayFabPaperTrail.unitypackage」の3つです。
またAPI設定もする必要があります。

ランキング機能をつくる！PlayFab+Unity | あのゲームの作り方Web版

※コード中のES3はEasySaveなので、所有していない人は各自PlayerPrefsに変えてください。

using System;
using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using TMPro;
using UnityEngine.UI;
using PlayFab;
using PlayFab.ClientModels;
using UnityEngine.Playables;

public class RankingManager : MonoBehaviour{
    [Header("ランキングウィンドウ")]public Transform rankingWindow;
    [Header("バックパネル")]public GameObject backPanel;
    [Header("送信するランキング名")]public string rankingName;
    [Header("今回のスコア")]public TextMeshProUGUI currentScoreText;
    [Header("ハイスコア")]public TextMeshProUGUI highScoreText;
    [Header("名前入力フィールド")]public TMP_InputField nameInputField;
    [Header("名前入力フィールド未入力時に表示される文字")]public TextMeshProUGUI placeholder;
    private string placeholderText;//入力が一度もされていないときにインプットフィールドに表示される文字 
    [Header("リーダーズボード")]public TMP_Text leaderboardText; 
    [Header("リーダーズボードのスクロールビュー")]public ScrollRect leaderboardScrollView;
    private int currentScore; //今回のスコア(データ)
    private int highScore; //ハイスコア(データ)
    [Header("データ送信時SE")]public AudioClip sendSe;
    [Header("クリック時SE")]public AudioClip clickSe;
    [Header("クローズ時SE")]public AudioClip closeSe;
    [Header("データ送信ボタン")]public Button sendScoreButton;
    [Header("ランキングウィンドウクローズボタン")]public Button closeButton;
    [Header("ランキング読込中に表示する画像")]public GameObject loadingImage;
    [Header("ランキング読込中または読み込み失敗時に表示するテキスト")]public TextMeshProUGUI loadingText;
    [Header("ウィンドウを表示するときのタイムライン")]public PlayableDirector startdirector;
    [Header("ウィンドウを非表示するときのタイムライン")]public PlayableDirector closedirector;
    private int windowDisplayCount;//ランキングウィンドウを表示した回数
    private bool _shouldCreateAccount;//アカウントを作成するか    
    private string _customID;//ログイン時に使うID
    private float delayTime = 2;//遅延時間

    private void OnEnable(){
        //それぞれのボタンにメソッド登録
        sendScoreButton.onClick.AddListener(OnSendScoreButtonClicked);
        closeButton.onClick.AddListener(OnCloseButtonClicked);
        //PlayFabにログインする
        Login();
        //デフォルトメッセージはiOS、Androidの場合とパソコンの場合で変える
if (Application.platform == RuntimePlatform.IPhonePlayer || Application.platform == RuntimePlatform.Android){
            placeholderText = "タップして入力";
        } else {
            placeholderText = "クリックして入力";
        }
        //デフォルトメッセージをインプットフィールドに表示
        placeholder.text = placeholderText;
        //インプットフィールドに名前を表示
        string lastName = ES3.KeyExists("LastName") ? ES3.Load<string>("LastName") : "";
        nameInputField.text = lastName;
        //名前が空でない場合、インプットフィールドのテキストを空にする
        if(lastName != ""){
            placeholder.text = "";
        }
        //ロード時のテキストをランキング読込中…に変更する
        loadingText.text = "ランキング読込中…";
        //バックパネルを非表示にする
        backPanel.SetActive(false);
    }

    /// <summary>
    /// ランキングウィンドウ表示ボタンクリック
    /// </summary>
    public void OnRankingButtonClicked(){
        ShowLoadingImage(true); // ランキング読み込み前にローディング画像を表示
        //Playfabにログインしていない場合
        if (!PlayFabClientAPI.IsClientLoggedIn()){
            //ログインしていない場合の処理
            Debug.Log("User is not logged in. Logging in...");
            //PlayFabにログインする
            Login();
            return;
        }
        
        // スコア送信ボタンを非活性にする
        sendScoreButton.interactable = false;
        //ランキングウィンドウを表示した回数を初期化
        windowDisplayCount = 0;
        //スクロールビューを一番上に戻す
        leaderboardScrollView.verticalNormalizedPosition = 1;
        
        RefreshLeaderboard(); // リーダーボード情報の読み込みと表示
        
        //SE再生(必要に応じて置き換える)
        SoundManager.i.PlaySe(clickSe);
        //今回のスコアを取得するメソッド、実装はゲームに依存
        currentScore = GameManager.i.GetScore(); 
        //今回のスコア用のテキストの内容を今回のスコアに置き換える
        currentScoreText.text = currentScore.ToString();
        //ハイスコア取得、実装はゲームに依存
        highScore = GameManager.i.GetHighScore();
        //ハイスコア用のテキストの内容をハイスコアに置き換える
        highScoreText.text = highScore.ToString();
        
        StartCoroutine(RefreshLeaderboardWithDelay(delayTime)); // 2秒の遅延を挟む
        
        //ウィンドウを表示させるタイムラインを再生
        startdirector.Play();
    }

    /// <summary>
    /// リーダーボード読み込み
    /// </summary>
    void RefreshLeaderboard(){
        
        windowDisplayCount++;
        
        // リーダーボード読み込み開始時にローディング画像を表示
        ShowLoadingImage(true); 
        var request = new GetLeaderboardRequest {
            //送信するランキング名(Playfabのランキングと名前を合わせる)
            StatisticName = rankingName,
            StartPosition = 0,
            //何位まで表示するか
            MaxResultsCount = 20
        };
        PlayFabClientAPI.GetLeaderboard(request, result => {
            leaderboardText.text = ""; // テキストの初期化
            foreach (var item in result.Leaderboard){
                //○○位；名前；○○点と表示された後に改行が入り、1つの順位となる。
                leaderboardText.text += $"{item.Position + 1}位: {item.DisplayName}: {item.StatValue}点\n";
            }
            // リーダーボード読み込み完了後にローディング画像を非表示
            if(windowDisplayCount>=2){
                ShowLoadingImage(false);
            };
        }, error => {
            Debug.LogError(error.GenerateErrorReport());
            loadingText.text = "ランキング読込失敗";//リーダーボードが読み込めない場合はテキストを変更する
        });
    }
    
    /// <summary>
    /// スコア送信ボタンクリック
    /// </summary>
    public void OnSendScoreButtonClicked(){
        // 送信後はボタンを非活性化(何回も押せないように)
        sendScoreButton.interactable = false; 
        ShowLoadingImage(true); // データ送信中にローディング画像を表示
        //ロード時のテキストをランキング読込中…に変更する
        loadingText.text = "ランキング読込中…";
        // スコア送信時のサウンド(適宜変更する)
        SoundManager.i.PlaySe(sendSe); 
        // 名前が空の場合は「名無し」を使用
        string playerName = string.IsNullOrEmpty(nameInputField.text) ? "名無し" : nameInputField.text;
        ES3.Save<string>("LastName", playerName); // 名前の保存、空の場合「名無し」を保存
        UpdatePlayerDisplayName(playerName); // プレイヤー名の更新処理を追加
        var request = new UpdatePlayerStatisticsRequest {
            //スコアの更新
            Statistics = new List<StatisticUpdate> { new StatisticUpdate { StatisticName = rankingName, Value = currentScore } }
        };
        PlayFabClientAPI.UpdatePlayerStatistics(request, result => {
            //スコア更新処理が完了したら、少し遅延を挟んでからリーダーボードを再読み込みする
            //遅延を挟まないと、データ送信前の状態のリーダーボードがそのまま表示される
            StartCoroutine(RefreshLeaderboardWithDelay(delayTime)); // 2秒の遅延を挟む
        }, error => {
            //スコア更新処理が失敗した場合の処理
            Debug.LogError(error.GenerateErrorReport());
        });
    }
    
    /// <summary>
    /// ローディング画像の表示・非表示を制御するメソッド
    /// </summary>
    /// <param name="show"></param>
    void ShowLoadingImage(bool show) {
        //ランキング読込中に表示する画像
        loadingImage.SetActive(show);
    }
    
    /// <summary>
    /// プレイヤーネーム更新
    /// </summary>
    /// <param name="playerName"></param>
    private void UpdatePlayerDisplayName(string playerName) {
        // 名前が2文字以下の場合、前に半角スペースを追加して3文字にする
        while (playerName.Length < 3) {
            playerName = " " + playerName;
        }
        // プレイヤー名の更新
        var request = new UpdateUserTitleDisplayNameRequest { DisplayName = playerName };
        PlayFabClientAPI.UpdateUserTitleDisplayName(request, result => {
            // プレイヤー名の更新が成功した場合の処理
            Debug.Log("Display name updated successfully.");
        }, error => {
            // プレイヤー名の更新が失敗した場合の処理
            Debug.LogError(error.GenerateErrorReport());
        });
    }
    
    /// <summary>
    /// 指定された遅延後にリーダーボードを再読み込みするコルーチン
    /// </summary>
    /// <param name="delay">遅延時間（秒）</param>
    /// <returns>IEnumerator</returns>
    IEnumerator RefreshLeaderboardWithDelay(float delay){
        yield return new WaitForSeconds(delay); // 指定された秒数待つ
        RefreshLeaderboard(); // リーダーボードの再読み込み
        // ハイスコアの更新チェック
        if(currentScore >= highScore){
            //今回のスコアがハイスコアを越えていたら、
            highScore = currentScore;
            //今回のスコアがハイスコアになる
            highScoreText.text = highScore.ToString();
            //データ送信ボタンを押せるようにする
            sendScoreButton.interactable = true;
        }
    }
    
    /// <summary>
    /// クローズボタン(背景)クリック
    /// </summary>
    public void OnCloseButtonClicked(){
        // クローズボタンの効果音(適宜変更)
        SoundManager.i.PlaySe(closeSe);
        //ランキングウィンドウを表示した回数を初期化
        windowDisplayCount = 0;
        
        //ウィンドウを非表示させるタイムラインを再生
        closedirector.Play();
    }
    
    /// <summary>
    /// Playfabログイン処理
    /// </summary>
    private void Login(){
        _customID = LoadCustomID();
        var request = new LoginWithCustomIDRequest { CustomId = _customID, CreateAccount = _shouldCreateAccount };//補足　既にアカウントが作成されており、CreateAccountがtrueになっていてもエラーにはならない
        PlayFabClientAPI.LoginWithCustomID(request, OnLoginSuccess, OnLoginFailure);
    }
    
    /// <summary>
    /// Playfabログイン成功
    /// </summary>
    /// <param name="result"></param>
    private void OnLoginSuccess(LoginResult result){
        //アカウントを作成しようとしたのに、IDが既に使われていて、出来なかった場合
        if (_shouldCreateAccount == true && result.NewlyCreated == false){
            Debug.LogWarning("CustomId :" +_customID+ "は既に使われています。");
            Login();//ログインしなおし
            return;
        }

        //アカウント新規作成できたらIDを保存
        if (result.NewlyCreated == true){
            SaveCustomID();
            Debug.Log("新規作成成功");
        }
        Debug.Log("ログイン成功!!");
    }

    /// <summary>
    /// Playfabログイン失敗
    /// </summary>
    /// <param name="error"></param>
    //ログイン失敗
    private void OnLoginFailure(PlayFabError error){
        Debug.LogError("PlayFabのログインに失敗\n" + error.GenerateErrorReport());
    }

    private static readonly string CUSTOM_ID_SAVE_KEY = "CUSTOM_ID_SAVE_KEY";

    //カスタムIDを取得
    private string LoadCustomID(){
        // キーが存在するか確認し、存在しない場合はデフォルト値を返す
        string id = ES3.Load<string>(CUSTOM_ID_SAVE_KEY, defaultValue:"");

        //idの中身がnullもしくは空の文字列("")の場合は_shouldCreateAccountはtrueになる。
        _shouldCreateAccount = string.IsNullOrEmpty(id);

        //idの中身がない場合、文字列を新規作成
        if (_shouldCreateAccount==true)
        {
            return GenerateCustomID();//文字列を新規作成
        }
        else
        {
            return id;//セーブされた文字列を返す
        }
    }

    //IDの保存
    private void SaveCustomID(){
        //EasySave3でIDをセーブデータに保存
        ES3.Save<string>(CUSTOM_ID_SAVE_KEY, _customID);
    }
    
    //カスタムIDを生成する
    //ユニークな文字列をGuidを使用し生成
    //https://docs.microsoft.com/ja-jp/dotnet/api/system.guid.tostring?redirectedfrom=MSDN&view=netframework-4.8#System_Guid_ToString_System_String_
    private string GenerateCustomID(){
        //Guidの構造体生成
        Guid guid = Guid.NewGuid();               
        return guid.ToString("N");//書式指定子はNを指定
    }
}

スクリプト中のコメントで大体説明していますが、変数は以下の画像のように設定します。

オンラインランキングボタンをクリックしたときにOnRankingButtonClicked()が実行され、RankingWindowがStartdirectorのタイムラインによって、上から移動してきます。backPanelをクリックすると、上に移動します。

なお、RankingPanelはオプションパネルの子オブジェクトかつ非アクティブにはならない設計なので、OnEnableはオプションパネルがアクティブになったときに実行されます。

Playfabは送信できる名前は3文字以上と決まっているのですが、実は文字の前にスペースを足すと1文字や2文字の名前でも送信及び表示できます。なのでRankingManagerの以下の部分で成形してデータを送信しています。

        // 名前が2文字以下の場合、前に半角スペースを追加して3文字にする
        while (playerName.Length < 3) {
            playerName = " " + playerName;
        }

Playfabが1文字の名前を受け取っている

スコア、ハイスコアの取得方法や、音声の再生方法は各自違うと思うので、書き換えてください。
複数回同じ処理がされていたり、コルーチンによる遅延がありますが、これがないと、自分の環境では表示される内容がおかしくなることがありました。問題が起きなければ省いても大丈夫だと思います。

こんな感じのランキングが作れます。

2.スクロールビューについて

いつも悩んでいるスクロールビューですが、今回は表示するTextMeshProの大きさが変わってくる可能性(例えばランキング20位まで表示を50位までにするとか)があるので苦労しました。

amustall

↑の記事を見て気づいたのですが、Contentだけでなく、子オブジェクトにも、Content Size Fitterをつけるのは盲点でした。ScrollView、Content、Leaderboardを以下のように設定すればOKです。ViewPortはいじらないでください。

移動タイプを固定に、水平のチェックを外す

Content Size FitterとVertical Layout Groupをアタッチする。

Content Size FitterとTextMeshPro－Text(UI)をアタッチする。

3.以前のスコアを残すためにランキングにデータを追加する

また今までNCMBでプレーヤーが残してくれたハイスコアをなるべく残していこうという試みもあり、これも自分の要求にマッチしました。とんでもないスコアを残してくれたプレーヤーがいるので、なるべくスコアは残したいのです。

【Unity】PlayFabでランキングを追加するエディタ拡張 | TedLab - テッドラボ【Unity】PlayFabでランキングを追加するエディタ拡張

テッドラボさんの記事の内容をそのまま実行すればOKです。
CustomIDは、登録するごとにClearしましょう。そのまま登録するとUserNameを変えていても上書きされてしまい、前のデータは消えてしまいます。

名前の前にスペースを入れれば、2文字以下の登録もできる

今回のように過去のデータを残すこと以外にも、ランキングの賑やかしにも使えますし、ちゃんとオンラインランキングが動いているかというデバッグのためにも使えます。

4.今後について

素人が作ったものですので、もしかしたら不具合があるかもしれません。またPlayFabはfloat型を扱っていないため、最速タイムランキング等だとまた別の処理が必要になってくると思います。そのうち、追記したり、アセットとして配布するかも。

追記.NCMBで作ったランキングをPlayFabに変更したときのXCodeでのビルドエラーについて

ncmbのファイルが少しでも残っているとXcodeでビルドエラーになります。Androidビルドではエラーにならないので、かなり悩みました。

その他の参考記事

【Unity】NCMBは2024年に終了！ランキングをPlayFabに乗り換える | TedLab - テッドラボ - Part 3【Unity】NCMBは2024年に終了！ランキングをPlayFabに乗り換える

【Unity】Azure PlayFabでランキング機能を実装する【mBaaS】 | 都会のエレキベア

PlayFabのログインを少しパワーアップさせる[Unity] | あのゲームの作り方Web版

ランキング機能をつくる！PlayFab+Unity | あのゲームの作り方Web版

【Unity】ランキング機能の実装方法！PlayFabの導入

Unity+PlayFabでユーザ名の更新とランキングの実装【Unity】【PlayFab】 - (:3[kanのメモ帳]

UnityでのPlayFabの導入とログイン処理とユーザごとのカスタムID生成【Unity】【PlayFab】 - (:3[kanのメモ帳]

【PlayFab】ランキングの機能の使い方【プライズテーブルも解説】｜PlayFabマスターへの道

Unity+PlayFabでランキング機能を作る（1） - Unity勉強中！あこがれだったプログラマーに今からなろう！

Unity+PlayFabでランキング機能を作る（2） - Unity勉強中！あこがれだったプログラマーに今からなろう！

【PlayFab】ログイン処理のベストプラクティスとは｜PlayFabマスターへの道

[Unity] ContentSizeFitterを使ってコンテンツサイズによって可変なUI要素を作る - Qiita

Unityでテキスト表示

こんな事例もあるそうです…。エラー時には確認してみてください。

【Unity】PlayFab ログイン機能の実装 - アプリ個人開発　まるブログ

【Unity】PlayFabを使っていて意図せず「ローカルネットワーク上のデバイスの検索及び接続を求めています」通知がiOSで出た時の対処方法 | くものす