GS2-Inventory Buff Reference

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

Note

See BuffEntryModel for more information on the buff entry model.

Model

Target model types available for buff application

Gs2Inventory:Inventory

Inventory

Target fields for buff application

currentInventoryMaxCapacity

	Type	Condition	Required	Default	Value Limits	Description
currentInventoryMaxCapacity	int		✓		1 ~ 2147483646	Maximum Capacity The current maximum number of inventory slots available to this user. Initialized from the inventory model’s initialCapacity and can be expanded up to the model’s maxCapacity through acquire actions or direct API calls.

Example Master Data

rate specifies the multiplier applied to the target field.

"targetModel": {
    "targetModelName": "Gs2Inventory:Inventory",
    "targetFieldName": "currentInventoryMaxCapacity",
    "conditionGrns": [
    ],
    "rate": 1.0
}

Buff Application Condition Model

Gs2Inventory:InventoryModel

Inventory Model

Example Master Data

"conditionGrns": [
    {
        "targetModelName": "Gs2Inventory:InventoryModel",
        "targetGrn": "grn:gs2:any:any:inventory:{namespaceName}:model:{inventoryName}"
    }
]

Action

Types of actions that can apply buffs

Gs2Inventory:AcquireItemSetByUserId

Acquire Item Sets by specifying the user ID

Adds items to the user’s inventory. If an existing item set has room (below the stacking limit), items are added to it; otherwise, a new item set is created if multiple stacks are allowed. An optional expiresAt can set an expiration time for newly created item sets. Items with an expiration time already in the past are treated as empty. When createNewItemSet is true, a new item set is always created even if existing sets have room. If the total quantity exceeds the inventory capacity, the overflow count is returned, and overflow items may be forwarded to GS2-Inbox depending on the namespace configuration.

Target fields for buff application

acquireCount

ItemSet - Item Set

	Type	Condition	Required	Default	Value Limits	Description
acquireCount	long		✓		1 ~ 9223372036854775805	Acquisition quantity

Example Master Data

"targetAction": {
    "targetActionName": "Gs2Inventory:AcquireItemSetByUserId",
    "targetFieldName": "acquireCount",
    "conditionGrns": [
    ],
    "rate": 1.0
}

Buff Application Condition Model

Gs2Inventory:InventoryModel

Inventory Model

Example Master Data

"conditionGrns": [
    {
        "targetModelName": "Gs2Inventory:InventoryModel",
        "targetGrn": "grn:gs2:{region}:{ownerId}:inventory:{namespaceName}:model:{inventoryName}"
    }
]

Gs2Inventory:ItemModel

Item Model

Example Master Data

"conditionGrns": [
    {
        "targetModelName": "Gs2Inventory:ItemModel",
        "targetGrn": "grn:gs2:{region}:{ownerId}:inventory:{namespaceName}:model:{inventoryName}:item:{itemName}"
    }
]

Gs2Inventory:ConsumeItemSet

Consume Item Sets

Reduces the quantity of the specified item in the requesting user’s inventory. If itemSetName is specified, consumption targets that specific stack only. Without it, items are consumed across all stacks of that item type. When an item set’s count reaches zero, it is automatically deleted. Returns an Insufficient error if the user does not have enough items to consume the requested amount.

Target fields for buff application

consumeCount

ItemSet - Item Set

	Type	Condition	Required	Default	Value Limits	Description
consumeCount	long		✓		1 ~ 9223372036854775805	Consumption quantity

Example Master Data

"targetAction": {
    "targetActionName": "Gs2Inventory:ConsumeItemSet",
    "targetFieldName": "consumeCount",
    "conditionGrns": [
    ],
    "rate": 1.0
}

Buff Application Condition Model

Gs2Inventory:InventoryModel

Inventory Model

Example Master Data

"conditionGrns": [
    {
        "targetModelName": "Gs2Inventory:InventoryModel",
        "targetGrn": "grn:gs2:{region}:{ownerId}:inventory:{namespaceName}:model:{inventoryName}"
    }
]

Gs2Inventory:ItemModel

Item Model

Example Master Data

"conditionGrns": [
    {
        "targetModelName": "Gs2Inventory:ItemModel",
        "targetGrn": "grn:gs2:{region}:{ownerId}:inventory:{namespaceName}:model:{inventoryName}:item:{itemName}"
    }
]

Gs2Inventory:ConsumeItemSetByUserId

Consume Item Sets by specifying the user ID

Reduces the quantity of the specified item in the given user’s inventory. If itemSetName is specified, consumption targets that specific stack only. Without it, items are consumed across all stacks of that item type. When an item set’s count reaches zero, it is automatically deleted. Returns an Insufficient error if the user does not have enough items.

Target fields for buff application

consumeCount

ItemSet - Item Set

	Type	Condition	Required	Default	Value Limits	Description
consumeCount	long		✓		1 ~ 9223372036854775805	Consumption quantity

Example Master Data

"targetAction": {
    "targetActionName": "Gs2Inventory:ConsumeItemSetByUserId",
    "targetFieldName": "consumeCount",
    "conditionGrns": [
    ],
    "rate": 1.0
}

Buff Application Condition Model

Gs2Inventory:InventoryModel

Inventory Model

Example Master Data

"conditionGrns": [
    {
        "targetModelName": "Gs2Inventory:InventoryModel",
        "targetGrn": "grn:gs2:{region}:{ownerId}:inventory:{namespaceName}:model:{inventoryName}"
    }
]

Gs2Inventory:ItemModel

Item Model

Example Master Data

"conditionGrns": [
    {
        "targetModelName": "Gs2Inventory:ItemModel",
        "targetGrn": "grn:gs2:{region}:{ownerId}:inventory:{namespaceName}:model:{inventoryName}:item:{itemName}"
    }
]

Gs2Inventory:AcquireSimpleItemsByUserId

Acquire Simple Items by specifying a user ID

Adds items to the user’s simple inventory using a batch of acquire counts. Multiple items can be acquired in a single atomic operation — the acquireCounts array specifies the item name and quantity for each item to acquire. Unlike regular item sets, simple items have no capacity limits, stacking limits, or expiration.

Target fields for buff application

acquireCounts

SimpleItem - Simple Item

	Type	Condition	Required	Default	Value Limits	Description
acquireCounts	List<AcquireCount>		✓		1 ~ 100 items	List of acquisition quantities for Simple Items

Example Master Data

"targetAction": {
    "targetActionName": "Gs2Inventory:AcquireSimpleItemsByUserId",
    "targetFieldName": "acquireCounts",
    "conditionGrns": [
    ],
    "rate": 1.0
}

Buff Application Condition Model

Gs2Inventory:SimpleInventoryModel

Simple Inventory Model

Example Master Data

"conditionGrns": [
    {
        "targetModelName": "Gs2Inventory:SimpleInventoryModel",
        "targetGrn": "grn:gs2:{region}:{ownerId}:inventory:{namespaceName}:simple:model:{inventoryName}"
    }
]

Gs2Inventory:SimpleItemModel

Simple Item Model

Example Master Data

"conditionGrns": [
    {
        "targetModelName": "Gs2Inventory:SimpleItemModel",
        "targetGrn": "grn:gs2:{region}:{ownerId}:inventory:{namespaceName}:simple:model:{inventoryName}:item:{itemName}"
    }
]

Gs2Inventory:ConsumeSimpleItems

Consume Simple Items

Reduces the quantity of items in the requesting user’s simple inventory using a batch of consume counts. Multiple items can be consumed in a single atomic operation — if any item has insufficient quantity, the entire operation fails. Returns an Insufficient error if the user does not have enough of any specified item.

Target fields for buff application

consumeCounts

SimpleItem - Simple Item

	Type	Condition	Required	Default	Value Limits	Description
consumeCounts	List<ConsumeCount>		✓		1 ~ 100 items	List of consumption quantities of Simple Items

Example Master Data

"targetAction": {
    "targetActionName": "Gs2Inventory:ConsumeSimpleItems",
    "targetFieldName": "consumeCounts",
    "conditionGrns": [
    ],
    "rate": 1.0
}

Buff Application Condition Model

Gs2Inventory:SimpleInventoryModel

Simple Inventory Model

Example Master Data

"conditionGrns": [
    {
        "targetModelName": "Gs2Inventory:SimpleInventoryModel",
        "targetGrn": "grn:gs2:{region}:{ownerId}:inventory:{namespaceName}:simple:model:{inventoryName}"
    }
]

Gs2Inventory:SimpleItemModel

Simple Item Model

Example Master Data

"conditionGrns": [
    {
        "targetModelName": "Gs2Inventory:SimpleItemModel",
        "targetGrn": "grn:gs2:{region}:{ownerId}:inventory:{namespaceName}:simple:model:{inventoryName}:item:{itemName}"
    }
]

Gs2Inventory:ConsumeSimpleItemsByUserId

Consume Simple Items by specifying a user ID

Reduces the quantity of items in the specified user’s simple inventory using a batch of consume counts. Multiple items can be consumed in a single atomic operation — if any item has insufficient quantity, the entire operation fails.

Target fields for buff application

consumeCounts

SimpleItem - Simple Item

	Type	Condition	Required	Default	Value Limits	Description
consumeCounts	List<ConsumeCount>		✓		1 ~ 100 items	List of consumption quantities of Simple Items

Example Master Data

"targetAction": {
    "targetActionName": "Gs2Inventory:ConsumeSimpleItemsByUserId",
    "targetFieldName": "consumeCounts",
    "conditionGrns": [
    ],
    "rate": 1.0
}

Buff Application Condition Model

Gs2Inventory:SimpleInventoryModel

Simple Inventory Model

Example Master Data

"conditionGrns": [
    {
        "targetModelName": "Gs2Inventory:SimpleInventoryModel",
        "targetGrn": "grn:gs2:{region}:{ownerId}:inventory:{namespaceName}:simple:model:{inventoryName}"
    }
]

Gs2Inventory:SimpleItemModel

Simple Item Model

Example Master Data

"conditionGrns": [
    {
        "targetModelName": "Gs2Inventory:SimpleItemModel",
        "targetGrn": "grn:gs2:{region}:{ownerId}:inventory:{namespaceName}:simple:model:{inventoryName}:item:{itemName}"
    }
]

Gs2Inventory:AcquireBigItemByUserId

Acquire Big Item by specifying a user ID

Adds the specified quantity to the user’s big item count using arbitrary-precision arithmetic. The acquireCount must be a valid integer string up to 1024 digits; an invalid format will result in an error. If the item does not yet exist, it will be automatically created. A GS2-Script can be configured to execute custom logic when big items are acquired via the namespace settings.

Target fields for buff application

acquireCount

BigItem - Big Item

	Type	Condition	Required	Default	Value Limits	Description
acquireCount	string		✓		~ 1024 chars	Acquisition quantity for a Big Item Integer value strings up to 1024 digits

Example Master Data

"targetAction": {
    "targetActionName": "Gs2Inventory:AcquireBigItemByUserId",
    "targetFieldName": "acquireCount",
    "conditionGrns": [
    ],
    "rate": 1.0
}

Buff Application Condition Model

Gs2Inventory:BigInventoryModel

Big Inventory Model

Example Master Data

"conditionGrns": [
    {
        "targetModelName": "Gs2Inventory:BigInventoryModel",
        "targetGrn": "grn:gs2:{region}:{ownerId}:inventory:{namespaceName}:big:model:{inventoryName}"
    }
]

Gs2Inventory:BigItemModel

Big Item Model

Example Master Data

"conditionGrns": [
    {
        "targetModelName": "Gs2Inventory:BigItemModel",
        "targetGrn": "grn:gs2:{region}:{ownerId}:inventory:{namespaceName}:big:model:{inventoryName}:item:{itemName}"
    }
]

Gs2Inventory:ConsumeBigItem

Consume Big Items

Subtracts the specified quantity from the requesting user’s big item count using arbitrary-precision arithmetic. The consumeCount must be a valid integer string up to 1024 digits. If the current count is insufficient, an Insufficient error is returned and no deduction is made. A GS2-Script can be configured to execute custom logic when big items are consumed via the namespace settings.

Target fields for buff application

consumeCount

BigItem - Big Item

	Type	Condition	Required	Default	Value Limits	Description
consumeCount	string		✓		~ 1024 chars	Consumption quantity of a Big Item Integer value strings up to 1024 digits

Example Master Data

"targetAction": {
    "targetActionName": "Gs2Inventory:ConsumeBigItem",
    "targetFieldName": "consumeCount",
    "conditionGrns": [
    ],
    "rate": 1.0
}

Buff Application Condition Model

Gs2Inventory:BigInventoryModel

Big Inventory Model

Example Master Data

"conditionGrns": [
    {
        "targetModelName": "Gs2Inventory:BigInventoryModel",
        "targetGrn": "grn:gs2:{region}:{ownerId}:inventory:{namespaceName}:big:model:{inventoryName}"
    }
]

Gs2Inventory:BigItemModel

Big Item Model

Example Master Data

"conditionGrns": [
    {
        "targetModelName": "Gs2Inventory:BigItemModel",
        "targetGrn": "grn:gs2:{region}:{ownerId}:inventory:{namespaceName}:big:model:{inventoryName}:item:{itemName}"
    }
]

Gs2Inventory:ConsumeBigItemByUserId

Consume Big Items by specifying a user ID

Subtracts the specified quantity from the specified user’s big item count using arbitrary-precision arithmetic. The consumeCount must be a valid integer string up to 1024 digits. If the current count is insufficient, an Insufficient error is returned and no deduction is made. A GS2-Script can be configured to execute custom logic when big items are consumed via the namespace settings.

Target fields for buff application

consumeCount

BigItem - Big Item

	Type	Condition	Required	Default	Value Limits	Description
consumeCount	string		✓		~ 1024 chars	Consumption quantity of a Big Item Integer value strings up to 1024 digits

Example Master Data

"targetAction": {
    "targetActionName": "Gs2Inventory:ConsumeBigItemByUserId",
    "targetFieldName": "consumeCount",
    "conditionGrns": [
    ],
    "rate": 1.0
}

Buff Application Condition Model

Gs2Inventory:BigInventoryModel

Big Inventory Model

Example Master Data

"conditionGrns": [
    {
        "targetModelName": "Gs2Inventory:BigInventoryModel",
        "targetGrn": "grn:gs2:{region}:{ownerId}:inventory:{namespaceName}:big:model:{inventoryName}"
    }
]

Gs2Inventory:BigItemModel

Big Item Model

Example Master Data

"conditionGrns": [
    {
        "targetModelName": "Gs2Inventory:BigItemModel",
        "targetGrn": "grn:gs2:{region}:{ownerId}:inventory:{namespaceName}:big:model:{inventoryName}:item:{itemName}"
    }
]