【Unity】NCMBは2024年に終了！ランキングをPlayFabに乗り換える

ランキングを作成する
1. ランキングの表示順番
ランキングにスコアを送信する
1. 注意点もある
ランキング一覧を取得してくる
1. 上位ランキングを取得する場合
2. 自分付近のランキングを取得する方法
  1. 自身の順位だけを知りたい時
これでランキングを実装できる
PlayFab実装が完成できたら
活動内容のPR
終わりに
任意のユーザー名をランキングに追加するエディタ作りました 2023/12/23

ソースコードはこちら

using PlayFab;
using PlayFab.ClientModels;
using UnityEngine;

void SendScore(int score)
{
    PlayFabClientAPI.UpdatePlayerStatistics(
        new UpdatePlayerStatisticsRequest
        {
            Statistics = new List(settings.LinkedClassNames.Count+1)
            {
                new StatisticUpdate{ StatisticName = "HighScore", Value = score,},
                new StatisticUpdate{ StatisticName = "HighScoreMonth", Value = score,}, // 同時に送る場合のみ
            }
        },
        result => Debug.Log("スコア登録に成功！"),
        error => Debug.Log("エラー！")
    );
}

スコアを送信するAPIを実行します。

注意したいのはスコアはint型しか見当たりませんでした。
そのため時間などを保存したい場合はint型で保存、読み込みを表示時に変換処理をかませる必要がありそうです。

NCMBに比べると汎用性が低いのですが、逆にフォーマットが決まっている分、ライトユーザーが複雑に触らなくて良いのはいい感じだと思っています

注意点もある

一般的なゲームの場合、スコアを送信して自分が含まれたランキングを確認するという流れになると思うのですが、実はスコアを送信してすぐにランキングを取得すると値が古いケースがありました。

そのため私の場合はスコアを送信してから数秒待ってから読み込むようにしました。

なにか良い設定がありそうですが、サーバー側は大量のリクエストをさばくのでリクエストごとに処理を待たせているとサーバーが大混雑する可能性もあるので一旦これで良いかなと思っています。

もし起きたとしてももう一度の読み込むと正常な値になっているので

仕方ないかな…

ランキング一覧を取得してくる

ランキングが登録されても見た目に出せないと意味がないので
ここからは登録されているランキングを表示する方法を紹介します。

上位ランキングを取得する場合

上位100位などを取得する方法はこちら

public void LoadRanking(string rankingName, int displayCount)
{
    PlayFabClientAPI.GetLeaderboard(
        new GetLeaderboardRequest
        {
            StatisticName = rankingName,
            MaxResultsCount = displayCount,
        }, 
        result =>
        {
            foreach (var item in result.Leaderboard){
                var rank = item.Position + 1; // 0始まりなので+1
                Debug.Log($"{rank} {item.DisplayName} : {item.StatValue}"); // 例: 1 テッドラボ : 12324378
            }
            Debug.Log("成功！")
        },
        error => Debug.Log("エラー！")
    );
}

引数の説明として

rankingName・・・ランキング名、先程のHighScoreやHighScoreMonthを渡す
displayCount・・・表示件数（取得するランキング数、100なら上位100件）

となります。

ここではDebug.Logで表示しています

自分付近のランキングを取得する方法

例えば上位100位圏外だった場合に自分の近くのユーザーを知りたいですよね。
そういったときは「GetLeaderboardAroundPlayer」を使うことで可能です。

public void LoadRankingAround(string rankingName, int displayCount)
{
    PlayFabClientAPI.GetLeaderboardAroundPlayer(
        new GetLeaderboardAroundPlayerRequest()
        {
            StatisticName = rankingName,
            MaxResultsCount = displayCount + 1, // 自身も含むため+1
        }, 
        result =>
        {
            foreach (var item in result.Leaderboard)
            {
                var rank = item.Position + 1; // 0始まりなので+1
                Debug.Log($"{rank} {item.DisplayName} : {item.StatValue}"); // 例: 1 テッドラボ : 12324378
            }
            Debug.Log("成功！")
        },
        error => Debug.Log("エラー！")
    );
}

注意したいのは「displayCount」は＋１して「MaxResultsCount 」に設定しています。
これは自分を含む数を指定するためです。