GS2-StateMachine Script トリガーリファレンス

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

トリガー

start

ステートマシンを開始

同期実行スクリプト

スクリプト、ステートマシンを開始の順に同期実行されます。

Request

	型	説明
namespace	Namespace	ネームスペース
stateMachineMaster	StateMachineMaster	ステートマシンマスターデータ
status	Status	ステータス
userId	string	ユーザーID
parameters	string	ステートマシンに渡す引数

Result

	型	必須	デフォルト	値の制限	説明
permit	bool	✓			開始を許可するか

実装例

namespace = args.namespace
stateMachineMaster = args.stateMachineMaster
status = args.status
userId = args.userId
parameters = args.parameters

result = {
  permit=permit
}

非同期実行スクリプト

ステートマシンを開始の実行後にスクリプトが非同期実行されます。

Request

	型	説明
namespace	Namespace	ネームスペース
stateMachineMaster	StateMachineMaster	ステートマシンマスターデータ
status	Status	ステータス
userId	string	ユーザーID
parameters	string	ステートマシンに渡す引数

Result

	型	必須	デフォルト	値の制限	説明

実装例

namespace = args.namespace
stateMachineMaster = args.stateMachineMaster
status = args.status
userId = args.userId
parameters = args.parameters

result = {
}

pass

ステートマシンが正常終了

同期実行スクリプト

スクリプト、ステートマシンが正常終了の順に同期実行されます。

Request

	型	説明
namespace	Namespace	ネームスペース
stateMachineMaster	StateMachineMaster	ステートマシンマスターデータ
status	Status	ステータス
userId	string	ユーザーID

Result

	型	必須	デフォルト	値の制限	説明
permit	bool	✓			ステートマシンの正常終了を許可するか

実装例

namespace = args.namespace
stateMachineMaster = args.stateMachineMaster
status = args.status
userId = args.userId

result = {
  permit=permit
}

非同期実行スクリプト

ステートマシンが正常終了の実行後にスクリプトが非同期実行されます。

Request

	型	説明
namespace	Namespace	ネームスペース
stateMachineMaster	StateMachineMaster	ステートマシンマスターデータ
status	Status	ステータス
userId	string	ユーザーID

Result

	型	必須	デフォルト	値の制限	説明

実装例

namespace = args.namespace
stateMachineMaster = args.stateMachineMaster
status = args.status
userId = args.userId

result = {
}

error

ステートマシンが異常終了

同期実行スクリプト

スクリプト、ステートマシンが異常終了の順に同期実行されます。

Request

	型	説明
namespace	Namespace	ネームスペース
stateMachineMaster	StateMachineMaster	ステートマシンマスターデータ
status	Status	ステータス
userId	string	ユーザーID

Result

	型	必須	デフォルト	値の制限	説明
permit	bool	✓			ステートマシンの異常終了を許可するか

実装例

namespace = args.namespace
stateMachineMaster = args.stateMachineMaster
status = args.status
userId = args.userId

result = {
  permit=permit
}

非同期実行スクリプト

ステートマシンが異常終了の実行後にスクリプトが非同期実行されます。

Request

	型	説明
namespace	Namespace	ネームスペース
stateMachineMaster	StateMachineMaster	ステートマシンマスターデータ
status	Status	ステータス
userId	string	ユーザーID

Result

	型	必須	デフォルト	値の制限	説明

実装例

namespace = args.namespace
stateMachineMaster = args.stateMachineMaster
status = args.status
userId = args.userId

result = {
}