Documentation index for AI agents

GS2-Showcase API Reference

Product sales feature

Provide in-game store functionality.

Set a price and a reward for the products to be sold. Multiple resources can be set for both compensation and rewards.

A system called “Sales Item Group” is used to implement mechanisms such as step gachas and first-time-only discounts. Sales Item Group are a mechanism to group together multiple Sales Items by prioritizing each Sales Item, so that the Sales Items that meet the requirements for purchase and have the highest priority are displayed.

On a standard showcase, all of the specified DisplayItems are placed. There are two types of DisplayItem: “SalesItem” and “SalesItemGroup.”

  • A SalesItem can be configured with the cost required to purchase it and the reward obtained when purchased.
  • A SalesItemGroup is a mechanism in which the SalesItem being sold changes depending on the number of purchases.

On a random showcase, a specified number of DisplayItems are randomly drawn from those specified in master data and placed.

The drawing result is stored per player as RandomShowcaseStatus, and stock is consumed at the time of purchase. When the redraw interval is reached, the displayed contents are updated on the next access.

By integrating with GS2-Buff, you can dynamically adjust the acquireActions, verifyActions, and consumeActions of DisplayItem and RandomDisplayItemModel, and for randomly displayed items stock can be overwritten as well. Rewards, required costs, and stock counts can be changed flexibly in line with events and campaigns.


GS2-Showcase SDK for Game Engine API Reference

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

GS2-Showcase SDK API Reference

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

GS2-Showcase Script Trigger Reference

Reference for event triggers that call extended scripts

GS2-Showcase Deploy/CDK Reference

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

GS2-Showcase Master Data Reference

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

GS2-Showcase Transaction Actions

Specification of verify/consume/acquire transaction actions

GS2-Showcase Buff Reference

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.