GS2-Distributor API リファレンス

トランザクション処理機能

プロパティの増加処理を中継し、対象の所持数量の上限に達していた場合に GS2-Inbox に転送する機能を提供します。
この機能を利用することで、所持数量の上限に到達したときの複雑な分岐処理を無くすことができ、意図しないデータ消失のリスクを回避できます。

その他に、GS2内で一貫性のある処理を実現するための仕組みであるトランザクションの実行処理にも使用します。

検証アクションは、トランザクションの実行を開始する前に、消費アクションや入手アクションを実行できる状態にあるかを事前にチェックするアクションです。
例えば「特定のアイテムを所持していること」「ランクが一定値以上であること」「特定のクエストをクリア済みであること」などの条件を、消費を発生させる前に確認できます。

消費アクションは、プレイヤーにとってデメリットとなる処理を表すアクションです。
アイテムの消費、通貨の消費、スタミナの消費、回数制限カウンターの増加などが該当します。

入手アクションは、プレイヤーにとってメリットとなる処理を表すアクションです。
アイテムの入手、通貨の入手、経験値の入手、クエストの開始処理などが該当します。

GS2 のトランザクションは、複数の検証アクション・複数の消費アクション・複数の入手アクションを組み合わせた構造で発行されます。
トランザクションは GS2-Showcase / GS2-Quest / GS2-Mission など、各マイクロサービスのトランザクション発行 API の応答として受け取り、ゲームクライアントは取得したトランザクションを GS2-Distributor 経由で実行します。

なお、GS2 SDK にはトランザクションの実行を自動化する仕組みが組み込まれており、多くの場合、ゲーム側でトランザクションを意識的に実行する必要はありません。
発行 API の結果に含まれる TransactionDomainWaitAsync を呼び出すだけで、消費アクション・入手アクションが正しい順番で実行され、結果を取得できます。


GS2-Distributor SDK for Game Engine API リファレンス

ゲームエンジン向け GS2-Distributor SDK の モデルの仕様 と API のリファレンス

GS2-Distributor SDK API リファレンス

各種プログラミング言語向け GS2-Distributor SDK の モデルの仕様 と API のリファレンス

GS2-Distributor Deploy/CDK リファレンス

GS2-Deployのスタックを作成する際に使用するテンプレートのフォーマットと、CDKによる各種言語のテンプレート出力の実装例

GS2-Distributor マスターデータリファレンス

マスターデータのフォーマットと インポートする各種モデルのリファレンス

GS2-Distributor トランザクションアクション

検証/消費/入手の各トランザクションアクションの仕様