Master Data Reference of GS2-Inventory

{
  "version": "2019-02-05",
  "inventoryModels": [
    {
      "name": "[string]Inventory Model Name",
      "metadata": "[string?]metadata",
      "initialCapacity": "[int]Initial Capacity",
      "maxCapacity": "[int]Maximum Capacity",
      "protectReferencedItem": "[bool?]Item Sets with registered references cannot be deleted",
      "itemModels": [
        {
          "itemModelId": "[string]Item Model GRN",
          "name": "[string]Item Model Name",
          "metadata": "[string?]metadata",
          "stackingLimit": "[long]Maximum stackable quantity",
          "allowMultipleStacks": "[bool]Allow items to be stored in multiple slots when the maximum stackable quantity is exceeded?",
          "sortValue": "[int]Display order"
        }
      ]
    }
  ],
  "simpleInventoryModels": [
    {
      "name": "[string]Simple Inventory Model Name",
      "metadata": "[string?]metadata",
      "simpleItemModels": [
        {
          "itemModelId": "[string]Simple Item Model GRN",
          "name": "[string]Simple Item Model Name",
          "metadata": "[string?]metadata"
        }
      ]
    }
  ],
  "bigInventoryModels": [
    {
      "name": "[string]Big Inventory Model Name",
      "metadata": "[string?]metadata",
      "bigItemModels": [
        {
          "itemModelId": "[string]Big Item Model GRN",
          "name": "[string]Big Item Model Name",
          "metadata": "[string?]metadata"
        }
      ]
    }
  ]
}

InventoryModel

Inventory Model

Inventory is like a bag that stores items owned by game players. Inventory can have a set capacity and cannot be owned beyond its capacity.

ItemModel

Item Model

Multiple items can be owned for one capacity of inventory, such as potions x 99. Multiple items owned in one capacity are stacked items. The maximum number of items that can be stacked can be specified for each item.

When the maximum stackable quantity is reached, you can set for each item whether you can reserve a new inventory capacity and own it, or whether it will no longer be available.

SimpleInventoryModel

Simple Inventory Model

In a normal InventoryModel, you could limit the amount of items that could be stored in your inventory. Simple Inventory, however, has no such functionality and simply stores the number of items in the inventory.

However, the Simple Inventory provides an API that can increase or decrease the number of items in a single process.

SimpleItemModel

Simple ItemModel

In the normal ItemModel, it is possible to set the maximum number of items that can be stacked, and if the number exceeds a certain number, it can be implemented to divide the items into multiple stacks. However, SimpleItem does not have such a function and simply stores the number of items in the possession of the item.

BigInventoryModel

Big Inventory model

In the normal InventoryModel and SimpleInventoryModel, the number of items that can be stored in the inventory is limited to the range of 64bit integer values. In inflationary games, you may need a wider range of values.

In the Big Inventory Model, the number of items that can be stored in the inventory can have an integer value of 1024 digits.

BigItemModel

Big ItemModel

In the normal ItemModel, it is possible to set the maximum number of items that can be stacked, and if the number exceeds a certain number, it can be implemented to divide the items into multiple stacks. However, BigItem does not have such a function and simply stores the number of items in the possession of the item.

AcquireCount

Quantity of simple items obtained

ConsumeCount

Consumption quantity of simple items

HeldCount

Quantity of simple items in possession