クエストシステム

概要

• クエストを Remote Config に格納します。
• アクティブなクエストのリストを Remote Config から取得し、1 つのクエストをランダムに選択します。
• クエストをプレイヤーに割り当て、データを Cloud Save に格納します。

• 進行の 1 分あたりの速度は制限されます。
• 毎分、プレイヤーはクエスト設定で許可されたアクション数までしか実行できません。

クエストの設定

1. Unity Dashboard に移動します。
2. Products (製品) > Remote Config を選択します。
3. Config (設定) タブを選択します。
4. Add a key (キーの追加) を選択します。
5. キー名として

   QUESTS

   を入力します。
6. 型として JSON を選択します。
7. その値として以下を貼り付けます。

   [  {    "id": 1,    "name": "Chop Trees",    "progress_required": 5,    "progress_per_minute": 1,    "reward": 5  },  {    "id": 2,    "name": "Mine Gold",    "progress_required": 5,    "progress_per_minute": 1,    "reward": 10  }]

8. 設定を公開します。

• id

  : クエストの一意識別子。

• name

  : クエストの名前。

• progress_required

  : クエストを完了するために必要な進行ポイントの数。

• progress_per_minute

  : プレイヤーが 1 分あたりに実行できる進行ポイントの数。

• reward

  : プレイヤーがクエストを完了したときに受け取る報酬。

Cloud Code の設定

QuestSystem

Cloud Save へのアクセスの制限

cloud-save-resource-policy.json

{    "statements": [        {            "Sid": "deny-cloud-save-data-write-access",            "Effect": "Deny",            "Action": ["Write"],            "Principal": "Player",            "Resource": "urn:ugs:cloud-save:/v1/data/projects/*/players/*/items**"        }    ]}

ugs access upsert-project-policy cloud-save-resource-policy.json

クエストサービスの設定

QuestService.cs

using Microsoft.Extensions.Logging;using Newtonsoft.Json;using Unity.Services.CloudCode.Apis;using Unity.Services.CloudCode.Core;using Unity.Services.CloudCode.Shared;namespace QuestSystem;public interface IQuestService{    List<Quest> GetAvailableQuests(IExecutionContext context, IGameApiClient gameApiClient);}public class QuestService : IQuestService{    private const string QuestKey = "QUESTS";    private readonly ILogger<QuestService> _logger;    public QuestService(ILogger<QuestService> logger)    {        _logger = logger;    }    private DateTime? CacheExpiryTime { get; set; }    // Reminder: cache cannot be guaranteed to be consistent across all requests    private List<Quest>? QuestCache { get; set; }    public List<Quest> GetAvailableQuests(IExecutionContext context, IGameApiClient gameApiClient)    {        if (QuestCache == null || DateTime.Now > CacheExpiryTime)        {            var quests = FetchQuestsFromConfig(context, gameApiClient);            QuestCache = quests;            CacheExpiryTime = DateTime.Now.AddMinutes(5); // data in cache expires after 5 mins        }        return QuestCache;    }    private List<Quest> FetchQuestsFromConfig(IExecutionContext ctx, IGameApiClient gameApiClient)    {        try        {            var result = gameApiClient.RemoteConfigSettings.AssignSettingsGetAsync(ctx, ctx.AccessToken, ctx.ProjectId,                ctx.EnvironmentId, null, new List<string> { "QUESTS" });            var settings = result.Result.Data.Configs.Settings;            return JsonConvert.DeserializeObject<List<Quest>>(settings[QuestKey].ToString());        }        catch (ApiException e)        {            _logger.LogError($"Failed to assign Remote Config settings. Error: {e.Message}");            throw new Exception($"Failed to assign Remote Config settings. Error: {e.Message}");        }    }}

データクラス

DataClasses.cs

DataClasses.cs

using Newtonsoft.Json;namespace QuestSystem;public class Quest{    [JsonProperty("id")]    public int ID { get; set; }    [JsonProperty("name")]    public string? Name { get; set; }    [JsonProperty("reward")]    public int Reward { get; set; }    [JsonProperty("progress_required")]    public int ProgressRequired { get; set; }    [JsonProperty("progress_per_minute")]    public int ProgressPerMinute { get; set; }}public class QuestData{    public QuestData()    {    }    public QuestData(string questName, int reward, int progressLeft, int progressPerMinute, DateTime questStartTime)    {        QuestName = questName;        Reward = reward;        ProgressLeft = progressLeft;        ProgressPerMinute = progressPerMinute;        QuestStartTime = questStartTime;        LastProgressTime = new DateTime();    }    [JsonProperty("quest-name")]    public string? QuestName { get; set; }    [JsonProperty("reward")]    public long Reward { get; set; }    [JsonProperty("progress-left")]    public long ProgressLeft { get; set; }    [JsonProperty("progress-per-minute")]    public long ProgressPerMinute { get; set; }    [JsonProperty("quest-start-time")]    public DateTime QuestStartTime { get; set; }    [JsonProperty("last-progress-time")]    public DateTime LastProgressTime { get; set; }}

依存関係の設定

QuestService

GameApiClient

PushClient

• QuestService

  はクエストを管理してキャッシュします。

• GameApiClient

  Remote Config サービスと Cloud Save サービスを呼び出すために必要です。

• PushClient

  は、プッシュ通知をプレイヤーに送信するために必要です。

ICloudCodeSetup

using Microsoft.Extensions.DependencyInjection;using Unity.Services.CloudCode.Apis;using Unity.Services.CloudCode.Core;namespace QuestSystem;public class CloudCodeSetup : ICloudCodeSetup{    public void Setup(ICloudCodeConfig config)    {        config.Dependencies.AddSingleton<IQuestService, QuestService>();        config.Dependencies.AddSingleton(GameApiClient.Create());        config.Dependencies.AddSingleton(PushClient.Create());    }}

クエストコントローラー

QuestController

using Microsoft.Extensions.Logging;using Newtonsoft.Json;using Unity.Services.CloudCode.Apis;using Unity.Services.CloudCode.Core;using Unity.Services.CloudCode.Shared;using Unity.Services.CloudSave.Model;namespace QuestSystem;public class QuestController{    private const string QuestDataKey = "quest-data";    private const string PlayerHasQuestInProgress = "Player already has a quest in progress!";    private const string PlayerHasNoQuestInProgress = "Player does not have a quest in progress!";    private const string PlayerHasCompletedTheQuest = "Player has already completed their quest!";    private const string PlayerCannotProgress = "Player cannot make quest progress yet!";    private const string PlayerProgressed = "Player made quest progress!";    private const string PlayerHasFinishedTheQuest = "Player has finished the quest!";    private ILogger<QuestController> _logger;    public QuestController(ILogger<QuestController> logger)    {        _logger = logger;    }    [CloudCodeFunction("AssignQuest")]    public async Task<string> AssignQuest(IExecutionContext context, IQuestService questService,        IGameApiClient gameApiClient)    {        var questData = await GetQuestData(context, gameApiClient);        if (questData?.QuestName != null) return PlayerHasQuestInProgress;        var availableQuests = questService.GetAvailableQuests(context, gameApiClient);        var random = new Random();        var index = random.Next(availableQuests.Count);        var quest = availableQuests[index];        questData = new QuestData(quest.Name, quest.Reward, quest.ProgressRequired, quest.ProgressPerMinute,            DateTime.Now);        await SetQuestData(context, gameApiClient, QuestDataKey, JsonConvert.SerializeObject(questData));        return $"Player was assigned quest: {quest.Name}!";    }    [CloudCodeFunction("PerformAction")]    public async Task<string> PerformAction(IExecutionContext context, IGameApiClient gameApiClient, PushClient pushClient)    {        var questData = await GetQuestData(context, gameApiClient);        if (questData?.QuestName == null) return PlayerHasNoQuestInProgress;        if (questData.ProgressLeft == 0) return PlayerHasCompletedTheQuest;        if (DateTime.Now < questData.LastProgressTime.AddSeconds(60 / questData.ProgressPerMinute))            return PlayerCannotProgress;        questData.LastProgressTime = DateTime.Now;        questData.ProgressLeft--;        await SetQuestData(context, gameApiClient, QuestDataKey, JsonConvert.SerializeObject(questData));        if (questData.ProgressLeft <= 0)        {            await HandleQuestCompletion(context, gameApiClient, pushClient);            return PlayerHasFinishedTheQuest;        }        return PlayerProgressed;    }    public async Task HandleQuestCompletion(IExecutionContext context, IGameApiClient gameApiClient, PushClient pushClient)    {        await NotifyPlayer(context, pushClient);        try        {            await gameApiClient.CloudSaveData.DeleteItemAsync(context, context.AccessToken, QuestDataKey,                context.ProjectId, context.PlayerId);        }        catch (ApiException e)        {            _logger.LogError("Failed to delete a quest for player. Error: {Error}",  e.Message);            throw new Exception($"Failed to delete a quest for player. Error. Error: {e.Message}");        }    }    private async Task NotifyPlayer(IExecutionContext context, PushClient pushClient)    {        const string message = "Quest completed!";        const string messageType = "Announcement";        try        {            await pushClient.SendPlayerMessageAsync(context, message, messageType, context.PlayerId);        }        catch (ApiException e)        {            _logger.LogError("Failed to send player message. Error: {Error}",  e.Message);            throw new Exception($"Failed to send player message. Error: {e.Message}");        }    }    private async Task<QuestData?> GetQuestData(IExecutionContext context, IGameApiClient gameApiClient)    {        try        {            var result = await gameApiClient.CloudSaveData.GetItemsAsync(                context, context.AccessToken, context.ProjectId, context.PlayerId,                new List<string> { QuestDataKey });            if (result.Data.Results.Count == 0) return null;            return JsonConvert.DeserializeObject<QuestData>(result.Data.Results.First().Value.ToString());        }        catch (ApiException e)        {            _logger.LogError($"Failed to retrieve data from Cloud Save. Error: {e.Message}");            throw new Exception($"Failed to retrieve data from Cloud Save. Error: {e.Message}");        }    }    private async Task SetQuestData(IExecutionContext context, IGameApiClient gameApiClient, string key,        string value)    {        try        {            await gameApiClient.CloudSaveData                .SetItemAsync(context, context.ServiceToken, context.ProjectId, context.PlayerId,                    new SetItemBody(key, value));        }        catch (ApiException e)        {            _logger.LogError($"Failed to save data in Cloud Save. Error: {e.Message}");            throw new Exception($"Failed to save data in Cloud Save. Error: {e.Message}");        }    }}

クエストのプレイヤーへの割り当て

AssignQuest

• Remote Config サービスからクエストをプレイヤーに割り当てます。
• プレイヤーの

  QuestData

  オブジェクトを作成し、それを Cloud Save に格納します。

クエストの進行

PerformAction

• クールダウンの期限が切れた場合、またはこれがプレイヤーの最初の進行関数呼び出しである場合、プレイヤーには進行ポイントが授与され、Cloud Save 内でそのプレイヤーの

  progress-left

  値が減ります。
• この関数がクールダウン中に呼び出された場合、Cloud Code のレスポンスは

  Player cannot make quest progress yet!

  です。
• 呼び出しが成功した場合、Cloud Code のレスポンスは

  Player made quest progress!

  です。Cloud Save で、Cloud Code はプレイヤーの

  progress-left

  値を減らし、

  last-progress-time

  を更新します。
• 最後の成功した呼び出しで

  progress-left

  がゼロになった場合、Cloud Code は、クエストが完了したことをプレイヤーに通知します。クエストデータは Cloud Save から削除されます。

モジュールの検証

1. Unity Dashboard に移動します。
2. Products (製品) > Player Management (プレイヤー管理) を選択します。
3. Player Management (プレイヤー管理) を選択します。
4. 検索フィールドにプレイヤー ID を入力し、Find Player (プレイヤーを検索) を選択します。
5. Cloud Save > Data (データ) セクションに移動します。

6. quest-data

   キーでクエストの進行を追跡します。