GS2-Exchange API Reference

Game resource exchange feature

Implements permanent exchange processes, such as item sale prices and exchange rates between evolution materials of different rarities.

GS2-Exchange converts resources managed by one GS2 microservice into resources managed by the same or another microservice. The exchange rate defines the actions used to verify and consume the cost and the actions used to grant the reward, allowing the complete exchange to be processed consistently.

Three exchange modes are available.

  • Direct exchange grants the reward immediately.
  • Asynchronous exchange consumes the cost first and makes the reward available after a configured waiting period. The waiting period can also be shortened by paying an additional cost.
  • Incremental-rate exchange changes the required cost according to the number of purchases. It can be used for designs such as stamina recovery whose price increases with each purchase and resets on a configured cycle.

GS2-Exchange SDK for Game Engine API Reference

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

GS2-Exchange SDK API Reference

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

GS2-Exchange Script Trigger Reference

Reference for event triggers that call extended scripts

GS2-Exchange 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-Exchange Master Data Reference

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

GS2-Exchange Transaction Actions

Specification of verify/consume/acquire transaction actions

GS2-Exchange 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.