GS2-Quest マスターデータリファレンス
{
"version": "2019-05-14",
"groups": [
{
"name": "[string]クエストグループ名",
"metadata": "[string?]メタデータ",
"quests": [
{
"questModelId": "[string]クエストモデルGRN",
"name": "[string]クエストモデル名",
"metadata": "[string?]メタデータ",
"contents": [
{
"metadata": "[string?]メタデータ",
"completeAcquireActions": [
{
"action": "[string]入手アクションで実行するアクションの種類",
"request": "[string]リクエストのJSON"
}
],
"weight": "[int]抽選する重み"
}
],
"challengePeriodEventId": "[string?]クエストに挑戦可能な期間を設定した GS2-Schedule イベントGRN",
"firstCompleteAcquireActions": [
{
"action": "[string]入手アクションで実行するアクションの種類",
"request": "[string]リクエストのJSON"
}
],
"verifyActions": [
{
"action": "[string]検証アクションで実行するアクションの種類",
"request": "[string]リクエストのJSON"
}
],
"consumeActions": [
{
"action": "[string]消費アクションで実行するアクションの種類",
"request": "[string]リクエストのJSON"
}
],
"failedAcquireActions": [
{
"action": "[string]入手アクションで実行するアクションの種類",
"request": "[string]リクエストのJSON"
}
],
"premiseQuestNames": [
"[string]クエストモデル名"
]
}
],
"challengePeriodEventId": "[string?]クエストに挑戦可能な期間を設定した GS2-Schedule イベントGRN"
}
]
}
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
version | ✓ | 2019-05-14 | マスターデータのフォーマットバージョン | |||
groups | List<QuestGroupModel> | ~ 10 items | クエストグループモデル |
Contents
コンテンツ
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
metadata | string | ~ 256文字 | メタデータ | |||
completeAcquireActions | List<AcquireAction> | [] | ~ 10 items | クエストクリア時の報酬 | ||
weight | int | ✓ | 1 | 1 ~ 2147483646 | 抽選する重み |
Reward
報酬
QuestGroupModel
クエストグループモデル
クエストグループは複数のクエストをグルーピングするためのエンティティで、クエストの進行はグループ内で同時に1つしか実行できません。
つまり、並列でクエストを進行できるようにする必要がある場合はグループを分ける必要があります。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
questGroupModelId | string | ✓ | ~ 1024文字 | クエストグループGRN | ||
name | string | ✓ | ~ 128文字 | クエストグループ名 | ||
metadata | string | ~ 1024文字 | メタデータ | |||
quests | List<QuestModel> | ~ 1000 items | グループに属するクエスト | |||
challengePeriodEventId | string | ~ 1024文字 | クエストに挑戦可能な期間を設定した GS2-Schedule イベントGRN |
QuestModel
クエストモデル
クエストはインゲームの開始に必要な対価とクリアしたときに得られる報酬を保持するエンティティです。
クリアしたときに得られる報酬は複数のバリエーションを用意でき、クエスト開始時に抽選することができます。
例えば、クエストのクリアフラグ管理は同じコンテンツだが、レアモンスターの出現有無で2種類のコンテンツを用意することができます。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
questModelId | string | ✓ | ~ 1024文字 | クエストモデルGRN | ||
name | string | ✓ | ~ 128文字 | クエストモデル名 | ||
metadata | string | ~ 1024文字 | メタデータ | |||
contents | List<Contents> | ✓ | 1 ~ 10 items | クエストの内容 | ||
challengePeriodEventId | string | ~ 1024文字 | クエストに挑戦可能な期間を設定した GS2-Schedule イベントGRN | |||
firstCompleteAcquireActions | List<AcquireAction> | [] | ~ 10 items | 初回クリア入手アクションリスト | ||
verifyActions | List<VerifyAction> | [] | ~ 10 items | クエストの参加条件検証アクションリスト | ||
consumeActions | List<ConsumeAction> | [] | ~ 10 items | クエストの参加料 | ||
failedAcquireActions | List<AcquireAction> | [] | ~ 100 items | クエスト失敗時の報酬 | ||
premiseQuestNames | List<string> | [] | ~ 10 items | クエストに挑戦するためにクリアしておく必要のあるクエスト名 |
AcquireAction
入手アクション
ConsumeAction
消費アクション
VerifyAction
検証アクション
VerifyActionResult
検証アクションの実行結果
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
action | enum { } | ✓ | ~ 128文字 | 検証アクションで実行するアクションの種類 | ||
verifyRequest | string | ✓ | ~ 1048576文字 | リクエストのJSON | ||
statusCode | int | ~ 999 | ステータスコード | |||
verifyResult | string | ~ 1048576文字 | 結果内容 |
action に指定する列挙型の定義
定義 | 説明 |
---|
ConsumeActionResult
消費アクションの実行結果
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
action | enum { } | ✓ | ~ 128文字 | 消費アクションで実行するアクションの種類 | ||
consumeRequest | string | ✓ | ~ 1048576文字 | リクエストのJSON | ||
statusCode | int | ~ 999 | ステータスコード | |||
consumeResult | string | ~ 1048576文字 | 結果内容 |
action に指定する列挙型の定義
定義 | 説明 |
---|
AcquireActionResult
入手アクションの実行結果
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
action | enum { } | ✓ | ~ 128文字 | 入手アクションで実行するアクションの種類 | ||
acquireRequest | string | ✓ | ~ 1048576文字 | リクエストのJSON | ||
statusCode | int | ~ 999 | ステータスコード | |||
acquireResult | string | ~ 1048576文字 | 結果内容 |
action に指定する列挙型の定義
定義 | 説明 |
---|
TransactionResult
トランザクション実行結果
サーバーサイドでのトランザクションの自動実行機能を利用して実行されたトランザクションの実行結果
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
transactionId | string | ✓ | 36 ~ 36文字 | トランザクションID | ||
verifyResults | List<VerifyActionResult> | ~ 10 items | 検証アクションの実行結果リスト | |||
consumeResults | List<ConsumeActionResult> | ~ 10 items | 消費アクションの実行結果リスト | |||
acquireResults | List<AcquireActionResult> | ~ 100 items | 入手アクションの実行結果リスト |