GS2-StateMachine API リファレンス

ステートマシン管理機能

サーバーサイドでステートマシンを管理し、ゲームからのイベントパッシングによって状態遷移させる仕組みを提供します。

ステートマシンの定義には独自の GSL(GS2 States Language) を使用します。
GSL の記法については、別途ドキュメントをご確認ください。

ステートマシンはバージョン管理され、ステートマシンの内容をアップデートしても起動時に使用していたステートマシン定義を使用して動作します。
これにより、ステートマシンの定義を変更しても、動作中のステートマシンに影響を与えることなく、新しいステートマシン定義を適用することができます。
互換性が失われるような変更をステートマシンに加える場合は、ネームスペース設定で指定バージョン以下のステートマシンで起動されたステートマシンを削除済みとする仕組みを利用してください。
ただし、この仕組みでバージョン管理されるのはステートマシンのみで、ステートマシンが参照する GS2-Script はバージョン管理されませんので、ご注意ください。

起動したステートマシンには有効期限を分単位で設定できます。
有効期限を設定したステートマシンは、有効期限が切れると自動的に削除されます。

定義は GSL フォーマットで直接記述するか、Unity では C# 定義から生成できます。


C# で定義する

C# 定義チュートリアル

Unity Editor で小さなゲームを作り、C# のルールを編集してゲーム画面から操作するチュートリアル

C# 定義リファレンス

C# で記述する状態、操作、処理の継続、報酬、乱数の仕様

C# 定義の生成設定

project.json、SDK参照、報酬対応表、生成物とGSL登録の仕様

ゲームから使う

投機的実行 Session API

生成した C# クラスから操作を呼び、状態を読み、サーバー検証を受ける API

Game Engine

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

SDK

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

GSL・設定・連携

GSL フォーマット

GSL で状態・処理・遷移を記述するための書式と仕様

Deploy/CDK

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

Script

拡張スクリプトを呼び出すイベントトリガーのリファレンス

Transaction Action

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