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

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

startQuest

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

Request

	型	説明
namespace	Namespace	ネームスペース
questGroupModel	QuestGroupModel	クエストグループモデル
questModel	QuestModel	クエストモデル
randomSeed	long	乱数シード
rewards	Reward[]	クエストで得られる報酬の上限
userId	string	ユーザーID
config	Config[]	トランザクションの変数に適用する設定値

Result

	型	必須	値の制限	説明
permit	bool	✓		クエスト開始を許可するか
overrideRandomSeed	long		0 ~ 9223372036854775805	乱数シード
overrideRewards	Reward[]		0 ~ 1000 items	クエストで得られる報酬の上限

実装例

namespace = args.namespace
questGroupModel = args.questGroupModel
questModel = args.questModel
randomSeed = args.randomSeed
rewards = args.rewards
userId = args.userId
config = args.config

result = {
  permit=permit,
  overrideRandomSeed=overrideRandomSeed,
  overrideRewards=overrideRewards
}

startQuestDone

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

Request

	型	説明
namespace	Namespace	ネームスペース
questGroupModel	QuestGroupModel	クエストグループモデル
questModel	QuestModel	クエストモデル
progress	Progress	クエスト進行状況
config	Config[]	トランザクションの変数に適用する設定値

Result

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

実装例

namespace = args.namespace
questGroupModel = args.questGroupModel
questModel = args.questModel
progress = args.progress
config = args.config

result = {
}

completeQuest

クエストクリア実行前にGS2-Scriptを呼び出すイベントトリガー

Request

	型	説明
namespace	Namespace	ネームスペース
questGroupModel	QuestGroupModel	クエストグループモデル
questModel	QuestModel	クエストモデル
rewards	Reward[]	クエストで得た報酬
progress	Progress	クエスト進行状況
config	Config[]	トランザクションの変数に適用する設定値

Result

	型	必須	デフォルト	値の制限	説明
permit	bool	✓			クエストクリアを許可するか
overrideRewards	Reward[]			0 ~ 1000 items	クエストで得られる報酬の上限

実装例

namespace = args.namespace
questGroupModel = args.questGroupModel
questModel = args.questModel
rewards = args.rewards
progress = args.progress
config = args.config

result = {
  permit=permit,
  overrideRewards=overrideRewards
}

completeQuestDone

クエストクリア実行後にGS2-Scriptを呼び出すイベントトリガー

Request

	型	説明
namespace	Namespace	ネームスペース
questGroupModel	QuestGroupModel	クエストグループモデル
questModel	QuestModel	クエストモデル
rewards	Reward[]	クエストで得た報酬
progress	Progress	クエスト進行状況
config	Config[]	トランザクションの変数に適用する設定値

Result

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

実装例

namespace = args.namespace
questGroupModel = args.questGroupModel
questModel = args.questModel
rewards = args.rewards
progress = args.progress
config = args.config

result = {
}

failedQuest

クエスト失敗実行前にGS2-Scriptを呼び出すイベントトリガー

Request

	型	説明
namespace	Namespace	ネームスペース
questGroupModel	QuestGroupModel	クエストグループモデル
questModel	QuestModel	クエストモデル
rewards	Reward[]	クエストで得た報酬
config	Config[]	トランザクションの変数に適用する設定値

Result

	型	必須	デフォルト	値の制限	説明
permit	bool	✓			クエスト失敗を許可するか
overrideRewards	Reward[]			0 ~ 1000 items	クエストで得られる報酬の上限

実装例

namespace = args.namespace
questGroupModel = args.questGroupModel
questModel = args.questModel
rewards = args.rewards
config = args.config

result = {
  permit=permit,
  overrideRewards=overrideRewards
}

failedQuestDone

クエスト失敗実行後にGS2-Scriptを呼び出すイベントトリガー

Request

	型	説明
namespace	Namespace	ネームスペース
questGroupModel	QuestGroupModel	クエストグループモデル
questModel	QuestModel	クエストモデル
rewards	Reward[]	クエストで得た報酬
config	Config[]	トランザクションの変数に適用する設定値

Result

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

実装例

namespace = args.namespace
questGroupModel = args.questGroupModel
questModel = args.questModel
rewards = args.rewards
config = args.config

result = {
}