Unity中PlayFab客户端库C#快速入门指南

创作时间:

作者:

@小白创作中心

Unity中PlayFab客户端库C#快速入门指南

引用

来源

https://learn.microsoft.com/zh-cn/gaming/playfab/sdks/unity3d/quickstart

快速入门：Unity 中的 PlayFab 客户端库 C#

本快速入门指南将帮助你在Unity引擎中进行首次PlayFab API调用。通过本文，你将学习如何安装PlayFab SDK、设置游戏配置，并完成第一个API调用。

要求

在开始之前，请确保满足以下要求：

一个PlayFab开发者帐户。
已安装的Unity编辑器（支持版本5.3及以上）。
一个Unity项目（全新项目、教程项目或现有项目）。
PlayFab Unity SDK。

下载并安装 PlayFab SDK

推荐使用PlayFab编辑器扩展包来简化SDK的安装过程。以下是具体步骤：

下载PlayFab Unity编辑器扩展资产包。
打开你的Unity项目。
导航到下载文件的位置，双击PlayFabEditorExtensions.UnityPackage文件，打开Unity编辑器中的"导入Unity包"对话框。
选择"导入"以将PlayFab Unity编辑器扩展导入项目。

导入完成后，PlayFab Unity编辑器扩展面板应自动打开。如果面板未打开，可以通过选择"窗口" > "PlayFab" > "编辑器扩展"来手动打开。

登录后，扩展将显示SDK安装对话框。选择"安装PlayFab SDK"以自动将SDK导入项目或升级当前安装的版本。

设置游戏设置

在进行API调用之前，需要在PlayFab游戏设置中指定Title。以下是具体步骤：

在编辑器扩展中选择"设置我的游戏"。
选择"Studio"条目以打开工作室下拉菜单，选择包含要连接到的标题的工作室。
选择"标题ID"条目，打开与所选工作室关联的标题的下拉菜单。

开发人员密钥将自动设置为游戏的默认密钥。有关开发者密钥的详细信息，请参阅密钥管理。

注意：可以通过扩展来自定义用于向PlayFab发出请求的HTTP传输。建议的默认值为Unity Web请求。存在其他选项来提供与旧引擎版本或特定于游戏的HTTP实现的兼容性。

进行首次 API 调用

本指南将提供进行首次PlayFab API调用的最小步骤。此示例不提供任何GUI或屏幕上的反馈，确认信息将显示在控制台日志中。

如果Unity项目还没有脚本文件夹（HDRP和LWRP/URP模板默认具有一个），请右键单击"项目"面板中的"资产"文件夹，然后选择"创建" > "文件夹"。
在"资产"窗口中，将文件夹命名为"脚本"。
右键单击"脚本"文件夹，然后选择"创建" > "C#脚本"。
将脚本命名为PlayFabLogin。
双击文件以在代码编辑器中打开它。
将PlayFabLogin.cs的内容替换为以下代码，并保存文件：

using PlayFab;
using PlayFab.ClientModels;
using UnityEngine;

public class PlayFabLogin : MonoBehaviour
{
    public void Start()
    {
        if (string.IsNullOrEmpty(PlayFabSettings.staticSettings.TitleId))
        {
            /*
            请将下面的titleId替换为你在PlayFab Game Manager中获取的titleId。
            如果你已经在Editor Extensions中设置了该值，可以跳过这一步。
            */
            PlayFabSettings.staticSettings.TitleId = "42";
        }
        var request = new LoginWithCustomIDRequest { CustomId = "GettingStartedGuide", CreateAccount = true };
        PlayFabClientAPI.LoginWithCustomID(request, OnLoginSuccess, OnLoginFailure);
    }

    private void OnLoginSuccess(LoginResult result)
    {
        Debug.Log("恭喜，你成功完成了第一次API调用！");
    }

    private void OnLoginFailure(PlayFabError error)
    {
        Debug.LogWarning("第一次API调用出现错误。");
        Debug.LogError("以下是调试信息：");
        Debug.LogError(error.GenerateErrorReport());
    }
}