GS2-Distributor API Reference

Provides a function to relay the property increase process and transfer it to GS2-Inbox when the upper limit of the target possession quantity is reached. This function eliminates the complicated branching process when the upper limit of the possession quantity is reached, thereby avoiding the risk of unintended data loss.

In addition, this function is also used for the transaction execution process, a mechanism to achieve consistent processing within GS2.

A verify action is an action that checks in advance, before starting transaction execution, whether the consume actions and acquire actions can be performed. For example, conditions such as “must possess a specific item”, “rank must be at or above a certain value”, or “a specific quest must already be cleared” can be checked before any consumption occurs.

A consume action is an action that represents processing that is disadvantageous to the player. This includes consuming items, consuming currency, consuming stamina, incrementing a usage limit counter, and similar operations.

An acquire action is an action that represents processing that is advantageous to the player. This includes acquiring items, acquiring currency, gaining experience, starting a quest, and similar operations.

A GS2 transaction is issued as a structure that combines multiple verify actions, multiple consume actions, and multiple acquire actions. A transaction is received as the response of the transaction-issuing API of each microservice, such as GS2-Showcase / GS2-Quest / GS2-Mission, and the game client executes the transaction it obtained through GS2-Distributor.

Note that the GS2 SDK has a built-in mechanism that automates transaction execution, so in most cases the game does not need to execute transactions consciously. Simply calling WaitAsync on the TransactionDomain included in the result of the issuing API executes the consume actions and acquire actions in the correct order and returns the result.