GS2-Formation マスターデータリファレンス
{
"version": "2019-09-09",
"moldModels": [
{
"name": "[string]フォームの保存領域モデル名",
"metadata": "[string?]メタデータ",
"initialMaxCapacity": "[int]フォームを保存できる初期キャパシティ",
"maxCapacity": "[int]フォームを保存できる最大キャパシティ",
"formModel": {
"formModelId": "[string]フォームモデルGRN",
"name": "[string]フォームモデル名",
"metadata": "[string?]メタデータ",
"slots": [
{
"name": "[string]スロットモデル名",
"propertyRegex": "[string]プロパティとして設定可能な値の正規表現",
"metadata": "[string?]メタデータ"
}
]
}
}
],
"propertyFormModels": [
{
"name": "[string]プロパティフォームモデル名",
"metadata": "[string?]メタデータ",
"slots": [
{
"name": "[string]スロットモデル名",
"propertyRegex": "[string]プロパティとして設定可能な値の正規表現",
"metadata": "[string?]メタデータ"
}
]
}
]
}
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
version | ✓ | 2019-09-09 | マスターデータのフォーマットバージョン | |||
moldModels | List<MoldModel> | ~ 100 items | 編成の情報を保存する領域 | |||
propertyFormModels | List<PropertyFormModel> | ~ 100 items | プロパティ編成モデル |
FormModel
編成モデル
編成状況を表すエンティティです。
編成できる領域として スロット
を定義できます。
武器・防具 であれば 「右手」「左手」「胴」「腕」のような部位をスロットとし、
パーティであれば「前衛」「中衛」「後衛」のようなポジションをスロットとして表現できます。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
formModelId | string | ✓ | ~ 1024文字 | フォームモデルGRN | ||
name | string | ✓ | ~ 128文字 | フォームモデル名 | ||
metadata | string | ~ 2048文字 | メタデータ | |||
slots | List<SlotModel> | ✓ | 1 ~ 10 items | スロットモデルリスト |
MoldModel
編成の情報を保存する領域
パーティ編成であれば「火属性パーティ」「水属性パーティ」のような形で保存することを想定しています。
保存できる領域の数は制限することができ、個別に拡張することもできます。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
moldModelId | string | ✓ | ~ 1024文字 | フォームの保存領域GRN | ||
name | string | ✓ | ~ 128文字 | フォームの保存領域モデル名 | ||
metadata | string | ~ 2048文字 | メタデータ | |||
initialMaxCapacity | int | ✓ | 1 ~ 2147483646 | フォームを保存できる初期キャパシティ | ||
maxCapacity | int | ✓ | 1 ~ 2147483646 | フォームを保存できる最大キャパシティ | ||
formModel | FormModel | ✓ |
PropertyFormModel
プロパティ編成モデル
編成状況を表すエンティティです。
Mold / Form との違いは、スロット数を定義して、各スロットに編成を記録するのが Mold / Form で、
所有している装備に対してスキルを設定するような、数を事前に決めるのが難しい編成を表現するのに利用するのがプロパティ編成です。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
propertyFormModelId | string | ✓ | ~ 1024文字 | プロパティフォームモデルGRN | ||
name | string | ✓ | ~ 128文字 | プロパティフォームモデル名 | ||
metadata | string | ~ 2048文字 | メタデータ | |||
slots | List<SlotModel> | ✓ | 1 ~ 10 items | スロットモデルリスト |
Slot
スロット
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
name | string | ✓ | ~ 128文字 | スロットモデル名 | ||
propertyId | string | ~ 1024文字 | プロパティID | |||
metadata | string | ~ 1024文字 | メタデータ |
SlotModel
スロットモデル
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
name | string | ✓ | ~ 128文字 | スロットモデル名 | ||
propertyRegex | string | ✓ | “.*” | ~ 512文字 | プロパティとして設定可能な値の正規表現 | |
metadata | string | ~ 512文字 | メタデータ |
SlotWithSignature
署名付きスロット
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
name | string | ✓ | ~ 128文字 | スロットモデル名 | ||
propertyType | enum { “gs2_inventory”, “gs2_simple_inventory”, “gs2_dictionary” } | ✓ | ~ 128文字 | プロパティの種類 | ||
body | string | ~ 1048576文字 | ペイロード | |||
signature | string | ~ 1024文字 | プロパティIDのリソースを所有していることを証明する署名 | |||
metadata | string | ~ 1024文字 | メタデータ |
propertyType に指定する列挙型の定義
定義 | 説明 |
---|---|
gs2_inventory | GS2-Inventory::ItemSet |
gs2_simple_inventory | GS2-Inventory::SimpleItem |
gs2_dictionary | GS2-Dictionary::Entry |
AcquireAction
入手アクション
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 | 入手アクションの実行結果リスト |