【Unity】PlayFabでランキングを追加するエディタ拡張

先日お伝えしたPlayFabでランキングを実装する方法をお伝えしましたが、自身でも実装していてサイト側でランキングを追加できないことがあったので、それをUnityエディタ拡張を自作してランキングを登録できるようにしたのでそのツールを共有したいと思います。

前回の記事
ランキングに任意にスコアを登録できない
鳥フライトのスコアを登録したい
作ったエディタ拡張
スクリプト内容
使い方
1. 既存のランキングのスコアを変更できる
終わりに
活動内容のPR

前回の記事

NCMBが終わるのでPlayFabに移行する方法をお伝えした記事となります。

PlayFabでランキングを作って表示する方法をざっくり紹介しました

鳥フライトのスコアを登録したい

前提としてランキングを実装したのはこちらのアプリです。

鳥フライト公式サイト

ゲームアプリ「鳥フライト」の公式サイトです。

ただ、さすがに全ランキングを残すことが難しかったので
下記の条件でスコアをPlayFabの方に移植できないかと考えていました。

12/11より前
ネームド（名前付き）
1万点以上

伝説の鳥「レジェンド」とつけて登録することにしました！

ツイートはこちら

現ランキング（NCMB版）で遊んでくれていた方は
下記条件で「レジェンド」として登録してみます👨‍🔧

・12/11より前
・ネームド
・1万点以上 pic.twitter.com/LiN6j5YDui

— Tadapy@ゲーム制作 (@tadapy88) December 12, 2023

作ったエディタ拡張

さきほどお伝えした通り、PlayFabでは登録する機能がなかったのでUnityのエディタ拡張として作成することにしました。

私はこれを使って問題なく登録できました！

ダウンロードはこちら

PlayFabスコア送信用のUnityエディタ拡張

unitypackageのインストールはこちら

Unityプラグイン(unitypackage)のインストール方法

今回はダウンロードしたUnityプラグイン(unitypackageファイル)をインストールする際に必要な手順を紹介したいと思います。

スクリプト内容

using UnityEditor;
using UnityEngine;
using PlayFab;
using PlayFab.ClientModels;
using System.Collections.Generic;
using System.Text;

namespace TedLab.Editor
{
	public class PlayFabEditor : EditorWindow
	{
		private const string EditorPrefix = "TedLab_PlayFabEditor_";
		private const string KeyCustomId = EditorPrefix + "CustomId";
		private const string KeyRankingName = EditorPrefix + "RankingName";
		private const string KeyDisplayUserName = EditorPrefix + "DisplayUserName";
		private const string KeyScore = EditorPrefix + "Score";

		private bool _busy = false;
		private string _customId = "";
		private string _rankingName = "";
		private string _displayUserName = "";
		private int _score = 0;

		[MenuItem("TedLab/PlayFab Editor")]
		private static void OpenWindow()
		{
			var window = GetWindow();
			window.titleContent = new GUIContent("PlayFab Editor");
			window.Show();
		}

        private void OnEnable()
        {
			// 読み込み
			_customId = EditorPrefs.GetString(KeyCustomId, "");
			_rankingName = EditorPrefs.GetString(KeyRankingName, "");
			_displayUserName = EditorPrefs.GetString(KeyDisplayUserName, "");
			_score = EditorPrefs.GetInt(KeyScore, 0);
		}

		private void OnDisable()
        {
			// 保存
			EditorPrefs.SetString(KeyCustomId, _customId);
			EditorPrefs.SetString(KeyRankingName, _rankingName);
			EditorPrefs.SetString(KeyDisplayUserName, _displayUserName);
			EditorPrefs.SetInt(KeyScore, _score);
		}

        private void OnGUI()
		{
			if (_busy)
			{
				GUILayout.Label("Processing...", EditorStyles.boldLabel);
				return;
			}

			GUILayout.Label("Settings", EditorStyles.boldLabel);

			// アカウントID
			using (new EditorGUILayout.HorizontalScope())
			{
				GUILayout.Label("CustomID(空なら自動作成)");
				_customId = EditorGUILayout.TextField(_customId);
				if (GUILayout.Button("Clear", GUILayout.Width(50f)))
				{
					_customId = "";
				}
			}

			// ユーザー名
			using (new EditorGUILayout.HorizontalScope())
			{
				GUILayout.Label("UserName");
				_displayUserName = EditorGUILayout.TextField(_displayUserName);
			}

			// ランキング名
			using (new EditorGUILayout.HorizontalScope())
			{
				GUILayout.Label("RankingName");
				_rankingName = EditorGUILayout.TextField(_rankingName);
			}

			// スコア値
			using (new EditorGUILayout.HorizontalScope())
			{
				GUILayout.Label("Score");
				_score = int.Parse(EditorGUILayout.TextField(_score.ToString()));
			}

			// 反映
			if (GUILayout.Button("Send", GUILayout.Width(50f)))
			{
				if(string.IsNullOrEmpty(_customId))
                {
					_customId = GenerateCustomId();
				}

				if (!string.IsNullOrEmpty(_customId) && !string.IsNullOrEmpty(_rankingName) && !string.IsNullOrEmpty(_displayUserName))
				{
					// ログイン
					PlayFabClientAPI.LoginWithCustomID(
						new LoginWithCustomIDRequest
						{
							TitleId = PlayFabSettings.TitleId,
							CustomId = _customId,
							CreateAccount = true,
						},
						result =>
						{
							// ユーザー名設定
							PlayFabClientAPI.UpdateUserTitleDisplayName(
								new UpdateUserTitleDisplayNameRequest
								{
									DisplayName = _displayUserName
								},
								result =>
								{
									// スコア反映
									PlayFabClientAPI.UpdatePlayerStatistics(
										new UpdatePlayerStatisticsRequest
										{
											Statistics = new List
											{
												new StatisticUpdate
												{
													StatisticName = _rankingName,
													Value = _score,
												}
											}
										},
										result =>
										{
											Debug.Log("Sucess!");
											_busy = false;
										},
										EndBusyError
									);
								},
								EndBusyError
							);
						},
						EndBusyError
					);

				}
			}
		}
		private void EndBusyError(PlayFabError error)
        {
			Debug.LogWarning("EndBusyError : " + error.ErrorMessage);
			_busy = false;
        }


		// カスタムIDの生成
		private const int CustomIdMaxnum = 32;
		private static readonly string CustomIdCharacters = "0123456789abcdefghijklmnopqrstuvwxyz";
		private static string GenerateCustomId()
		{
			var stringBuilder = new StringBuilder(CustomIdMaxnum);
			var random = new System.Random();
			for (var i=0; i<CustomIdMaxnum; i++)
			{
				stringBuilder.Append(CustomIdCharacters[random.Next(CustomIdCharacters.Length)]);
			}
			return stringBuilder.ToString();
		}
	}
}