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

GS2-StateMachineで定義されている、拡張スクリプトを呼び出すイベントトリガーのリファレンス

start

ステートマシンを開始実行前にGS2-Scriptを呼び出すイベントトリガー

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
}

startDone

ステートマシンを開始実行後にGS2-Scriptを呼び出すイベントトリガー

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

ステートマシンが正常終了実行前にGS2-Scriptを呼び出すイベントトリガー

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
}

passDone

ステートマシンが正常終了実行後にGS2-Scriptを呼び出すイベントトリガー

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

ステートマシンが異常終了実行前にGS2-Scriptを呼び出すイベントトリガー

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
}

errorDone

ステートマシンが異常終了実行後にGS2-Scriptを呼び出すイベントトリガー

Request

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

Result

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

実装例

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

result = {
}