GS2-Inventory API Reference

Inventory management feature

Provides inventory management functionality.

An inventory is similar to a bag that stores items. Its capacity can be configured and later expanded with premium currency or quest rewards.

Items can have expiration dates. Expired items cannot be used, and when no item-set identifier is specified, items with the nearest expiration date are consumed first.

Three inventory types are available.

  • Standard inventories support capacity limits, stacks, expiration dates, and references that prevent equipped or otherwise in-use items from being consumed.
  • Simple inventories omit those features in exchange for increasing or decreasing multiple item types in one request, reducing the number of API calls.
  • Big inventories are intended for resources whose quantity can exceed the range of a 64-bit integer.

Use in your game

Game Engine

Specifications of models and API references for GS2-Inventory SDK for Game Engine

SDK

Specification of models and API references for GS2-Inventory SDK for various programming languages

Configuration and integrations

Deploy/CDK

The template format used when creating stacks with GS2-Deploy, and implementation examples of template output in various languages using CDK

Master Data

Reference for the master data format and the models to be imported

Script

Reference for event triggers that call extended scripts

Transaction Action

Specification of verify/consume/acquire transaction actions

Buff

Describes the fields within models/actions whose parameters can be adjusted when applying buffs with GS2-Buff, and how to configure the scope in which those buffs are applied.