GS2-Inventory マスターデータリファレンス

{
  "version": "2019-02-05",
  "inventoryModels": [
    {
      "name": "[string]インベントリモデル名",
      "metadata": "[string?]メタデータ",
      "initialCapacity": "[int]初期サイズ",
      "maxCapacity": "[int]最大サイズ",
      "protectReferencedItem": "[bool?]参照元が登録されているアイテムセットは削除できなくする",
      "itemModels": [
        {
          "itemModelId": "[string]アイテムモデルGRN",
          "name": "[string]アイテムモデル名",
          "metadata": "[string?]メタデータ",
          "stackingLimit": "[long]スタック可能な最大数量",
          "allowMultipleStacks": "[bool]スタック可能な最大数量を超えた時複数枠にアイテムを保管することを許すか",
          "sortValue": "[int]表示順番"
        }
      ]
    }
  ],
  "simpleInventoryModels": [
    {
      "name": "[string]シンプルインベントリモデル名",
      "metadata": "[string?]メタデータ",
      "simpleItemModels": [
        {
          "itemModelId": "[string]シンプルアイテムモデルGRN",
          "name": "[string]シンプルアイテムモデル名",
          "metadata": "[string?]メタデータ"
        }
      ]
    }
  ],
  "bigInventoryModels": [
    {
      "name": "[string]巨大インベントリモデル名",
      "metadata": "[string?]メタデータ",
      "bigItemModels": [
        {
          "itemModelId": "[string]巨大アイテムモデルGRN",
          "name": "[string]巨大アイテムモデル名",
          "metadata": "[string?]メタデータ"
        }
      ]
    }
  ]
}
有効化条件必須デフォルト値の制限説明
version2019-02-05マスターデータのフォーマットバージョン
inventoryModelsList<InventoryModel>
simpleInventoryModelsList<SimpleInventoryModel>
bigInventoryModelsList<BigInventoryModel>

InventoryModel

インベントリモデル

インベントリはゲームプレイヤーが所有しているアイテムを格納するカバンのようなものです。 インベントリには容量が設定でき、容量を超えては所有できません。

インベントリの容量は拡張することができます。 スタンプシートの報酬に設定ができますので、スタンプシートを使用して報酬を付与できる手段であれば、拡張の方法は問いません。

有効化条件必須デフォルト値の制限説明
inventoryModelIdstring~ 1024文字インベントリモデルGRN
namestring~ 128文字インベントリモデル名
metadatastring~ 128文字メタデータ
initialCapacityint~ 2147483646初期サイズ
maxCapacityint~ 2147483646最大サイズ
protectReferencedItembool?false参照元が登録されているアイテムセットは削除できなくする
itemModelsList<ItemModel>1 ~ 1000 itemsインベントリに格納可能なアイテムモデル一覧

ItemModel

アイテムモデル

アイテムは ポーション×99 のようにインベントリの1容量に対して複数所有できます。 1容量で複数所有している状態を アイテムをスタック する。と呼び、アイテムごとにスタックできる最大数量を指定できます。

スタックできる最大数量に達したとき、新しくインベントリの容量を確保して所有することができるか、入手することが出来なくなるかをアイテムごとに設定できます。

有効化条件必須デフォルト値の制限説明
itemModelIdstring~ 1024文字アイテムモデルGRN
namestring~ 128文字アイテムモデル名
metadatastring~ 128文字メタデータ
stackingLimitlong1 ~ 9223372036854775805スタック可能な最大数量
allowMultipleStacksboolスタック可能な最大数量を超えた時複数枠にアイテムを保管することを許すか
sortValueint~ 2147483646表示順番

SimpleInventoryModel

シンプルインベントリモデル

通常の InventoryModel では、インベントリ内に格納できるアイテムの容量制限ができました。 しかし、シンプルインベントリ ではそのような機能はなく、単純にアイテムの所持数量を保持するのみとなります。

ただし、シンプルインベントリでは、複数のアイテムの増減処理を1回の処理で実行可能なAPIが利用できます。

有効化条件必須デフォルト値の制限説明
inventoryModelIdstring~ 1024文字シンプルインベントリモデルGRN
namestring~ 128文字シンプルインベントリモデル名
metadatastring~ 128文字メタデータ
simpleItemModelsList<SimpleItemModel>1 ~ 1000 itemsインベントリに格納可能なシンプルアイテムモデル一覧

SimpleItemModel

シンプルアイテムモデル

通常の ItemModel では、スタックできる数量の最大値を設定でき、一定数を超える場合は複数のスタックに分けるような実装が可能でした。 しかし、シンプルアイテム ではそのような機能はなく、単純にアイテムの所持数量を保持するのみとなります。

有効化条件必須デフォルト値の制限説明
itemModelIdstring~ 1024文字シンプルアイテムモデルGRN
namestring~ 128文字シンプルアイテムモデル名
metadatastring~ 128文字メタデータ

BigInventoryModel

巨大インベントリモデル

通常の InventoryModel や SimpleInventoryModel では、インベントリに格納できるアイテムの数は 64bit 整数値の範囲に限られました。 インフレ系ゲームでは、もっと広い値の範囲を必要とする場合があります。

巨大インベントリモデルでは、インベントリに格納できるアイテムの数には1024桁の整数値を持たせることができます。

有効化条件必須デフォルト値の制限説明
inventoryModelIdstring~ 1024文字巨大インベントリモデルGRN
namestring~ 128文字巨大インベントリモデル名
metadatastring~ 128文字メタデータ
bigItemModelsList<BigItemModel>1 ~ 1000 itemsインベントリに格納可能な巨大アイテムモデル一覧

BigItemModel

巨大アイテムモデル

通常の ItemModel では、スタックできる数量の最大値を設定でき、一定数を超える場合は複数のスタックに分けるような実装が可能でした。 しかし、巨大アイテム ではそのような機能はなく、単純にアイテムの所持数量を保持するのみとなります。

有効化条件必須デフォルト値の制限説明
itemModelIdstring~ 1024文字巨大アイテムモデルGRN
namestring~ 128文字巨大アイテムモデル名
metadatastring~ 128文字メタデータ

AcquireCount

シンプルアイテムの入手数量

有効化条件必須デフォルト値の制限説明
itemNamestring~ 128文字シンプルアイテムモデルの名前
countlong1 ~ 9223372036854775805入手する量

ConsumeCount

シンプルアイテムの消費数量

有効化条件必須デフォルト値の制限説明
itemNamestring~ 128文字シンプルアイテムモデルの名前
countlong1 ~ 9223372036854775805消費する量

HeldCount

シンプルアイテムの所持数量

有効化条件必須デフォルト値の制限説明
itemNamestring~ 128文字シンプルアイテムモデルの名前
countlong~ 9223372036854775805所持数量